refactor: core包迁移至ESM (#39)

packages/cli-dev/src/utils.ts

@@ -1,11 +1,11 @@
 import WebpackDevServer from 'webpack-dev-server';
+import {internalIpV4} from 'internal-ip';
 import {readProjectSettings, BuildEnv, strictCheckRequiredDependency} from '@reskript/settings';
 import {BuildContext, collectEntries, createRuntimeBuildEnv, EntryLocation} from '@reskript/config-webpack';
 import {logger, readPackageConfig} from '@reskript/core';
 import {DevCommandLineArgs} from './interface.js';
 
 export const resolveHost = async (hostType: DevCommandLineArgs['host']) => {
-    const {internalIpV4} = await import('internal-ip');
 
     if (!hostType) {
         return 'localhost';

packages/cli-lint/src/index.ts

@@ -1,5 +1,6 @@
 import eslintPrettyFormatter from 'eslint-formatter-pretty';
 import {Linter, ESLint} from 'eslint';
+import {execa} from 'execa';
 import {logger, gitStatus, findGitRoot} from '@reskript/core';
 import {LintCommandLineArgs, ResolveOptions} from './interface.js';
 import lintScripts from './script.js';
@@ -24,7 +25,6 @@ const filterUnwantedReports = (report: LintResult[], cmd: LintCommandLineArgs):
 };
 
 export const run = async (cmd: LintCommandLineArgs, files: string[]): Promise<void> => {
-    const {execa} = await import('execa');
     const gitRoot = await findGitRoot() || process.cwd();
     const status = await gitStatus(process.cwd());
     const options: ResolveOptions = {...cmd, gitRoot, gitStatus: status};

packages/cli-play/src/utils/host.ts

@@ -1,8 +1,7 @@
+import {internalIpV4} from 'internal-ip';
 import {PlayCommandLineArgs} from '../interface.js';
 
 export const resolveHost = async (hostType: PlayCommandLineArgs['host']) => {
-    const {internalIpV4} = await import('internal-ip');
-
     if (!hostType) {
         return 'localhost';
     }

packages/cli/src/DynamicImportCommand.ts

@@ -2,10 +2,11 @@ import path from 'path';
 import {existsSync} from 'fs';
 import childProcess from 'child_process';
 import {promisify} from 'util';
+import {packageDirectory} from 'pkg-dir';
 import enquirer from 'enquirer';
 // @ts-expect-error
 import {Command} from 'clipanion';
-import type {CommandDefinition} from '@reskript/core';
+import {CommandDefinition, findGitRoot, logger, readPackageConfig, resolveFrom} from '@reskript/core';
 
 const isErrorWithCode = (error: any): error is NodeJS.ErrnoException => {
     return 'message' in error && 'code' in error;
@@ -27,8 +28,6 @@ export default abstract class DynamicImportCommand<A> extends Command {
     protected readonly packageName: string = '';
 
     async execute() {
-        const {logger} = await import('@reskript/core');
-
         if (!this.packageName) {
             logger.error('No command package defined');
             process.exit(11);
@@ -52,7 +51,6 @@ export default abstract class DynamicImportCommand<A> extends Command {
     }
 
     private async importCommandPackage() {
-        const {logger, resolveFrom} = await import('@reskript/core');
         const resolve = resolveFrom(process.cwd());
 
         const dynamicImport = async () => {
@@ -111,9 +109,6 @@ export default abstract class DynamicImportCommand<A> extends Command {
     }
 
     private async canAutoInstall() {
-        const {readPackageConfig} = await import('@reskript/core');
-        const {packageDirectory} = await import('pkg-dir');
-
         const packageRoot = await packageDirectory();
 
         if (!packageRoot) {
@@ -128,8 +123,6 @@ export default abstract class DynamicImportCommand<A> extends Command {
     }
 
     private async detectPackageManager(): Promise<PackageManager | null> {
-        const {findGitRoot} = await import('@reskript/core');
-
         const gitRoot = await findGitRoot();
 
         if (!gitRoot) {
@@ -150,8 +143,6 @@ export default abstract class DynamicImportCommand<A> extends Command {
     }
 
     private async installCommandPackage(): Promise<InstallReuslt> {
-        const {logger} = await import('@reskript/core');
-
         const question = {
             type: 'confirm',
             name: 'ok',

packages/config-jest/src/interface.ts

@@ -1,3 +1,4 @@
+// @ts-expect-error
 import type {ProjectAware} from '@reskript/core';
 // @ts-expect-error
 import type {FeatureMatrix} from '@reskript/settings';

packages/config-lint/src/rules/eslint.ts

@@ -1,4 +1,4 @@
-import {resolveSync} from '@reskript/core';
+import {resolveSync} from '@reskript/core/willBreakingInternalUseOnly';
 import {getParseOnlyBabelConfig} from '@reskript/config-babel/willBreakingInternalUseOnly';
 
 // 为了支持 IDE 和代码编辑工具使用 eslint 的配置，在 build 阶段会生成一份 .eslintrc 文件。参阅 scripts/post-build.js

packages/config-lint/src/rules/stylelint.ts

@@ -1,4 +1,4 @@
-import {resolveSync} from '@reskript/core';
+import {resolveSync} from '@reskript/core/willBreakingInternalUseOnly';
 import lessSyntax from 'postcss-less';
 
 const config: Record<string, any> = {

packages/config-webpack/src/partials/production.ts

@@ -1,10 +1,10 @@
 import path from 'path';
 import {Configuration} from 'webpack';
+import {findUp} from 'find-up';
 import {filter} from 'ramda';
 import {ConfigurationFactory} from '../interface.js';
 
 const factory: ConfigurationFactory = async entry => {
-    const {findUp} = await import('find-up');
     const {cwd} = entry;
     const nodeModule = async (...segments: string[]): Promise<string> => {
         const name = path.join('node_modules', ...segments);

packages/core/package.json

@@ -2,11 +2,12 @@
   "name": "@reskript/core",
   "version": "3.0.4",
   "license": "MIT",
-  "type": "commonjs",
+  "type": "module",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "exports": {
-    ".": "./dist/index.js"
+    ".": "./dist/index.js",
+    "./willBreakingInternalUseOnly": "./dist/internal.cjs"
   },
   "engines": {
     "node": ">=14.18.0"
@@ -19,11 +20,13 @@
   },
   "scripts": {
     "clean": "rm -rf dist",
-    "build": "tsc -p tsconfig.build.json",
+    "build": "tsc -p tsconfig.build.json && node scripts/post-build.js && cp dist/internal.d.ts dist/internal.d.cts",
     "test": "vitest run",
     "lint": "eslint --max-warnings=0 src"
   },
   "devDependencies": {
+    "@babel/plugin-transform-typescript": "^7.16.7",
+    "@rollup/plugin-babel": "^5.3.0",
     "@types/caller": "^1.0.0",
     "@types/dedent": "^0.7.0",
     "@types/node": "^17.0.4",
@@ -32,6 +35,7 @@
     "@types/unixify": "^1.0.0",
     "c8": "^7.10.0",
     "eslint": "^8.6.0",
+    "rollup": "^2.62.0",
     "typescript": "4.6.0-dev.20220105",
     "vite": "^2.7.7",
     "vitest": "^0.0.115"

packages/core/scripts/post-build.js

@@ -0,0 +1,36 @@
+import path from 'path';
+import {fileURLToPath} from 'url';
+import {rollup} from 'rollup';
+import {babel} from '@rollup/plugin-babel';
+
+(async () => {
+    const project = path.join(fileURLToPath(import.meta.url), '..', '..');
+    const config = {
+        input: path.join(project, 'src', 'internal.ts'),
+        external: id => {
+            if (id.startsWith('.')) {
+                return false;
+            }
+
+            return path.relative(path.join(project, 'src'), id).startsWith('..');
+        },
+        plugins: [
+            {
+                transform(code, id) {
+                    if (id.endsWith('.ts')) {
+                        return code.replace(/\.js';/g, '.ts\';');
+                    }
+                },
+            },
+            babel({plugins: ['@babel/plugin-transform-typescript'], extensions: ['.ts'], babelHelpers: 'bundled'}),
+        ],
+    };
+    const bundle = await rollup(config);
+
+    const outuput = {
+        file: path.join(project, 'dist', 'internal.cjs'),
+        format: 'cjs',
+        exports: 'named',
+    };
+    await bundle.write(outuput);
+})();

packages/core/src/index.ts

@@ -18,7 +18,7 @@ import {deprecatedWarn} from './deprecate.js';
 import {pFilter, pMap, pReduce} from './async.js';
 import {resolveFrom, resolveSync, dirFromImportMeta, importUserModule, globby} from './resolve.js';
 import {GitStatusResult, gitStatus} from './git/index.js';
-import {compact} from './lang';
+import {compact} from './lang.js';
 
 export {
     CommandDefinition,

packages/core/src/internal.ts

@@ -0,0 +1 @@
+export {resolveSync} from './resolve.js';

packages/core/src/logger.ts

@@ -1,5 +1,6 @@
 // @ts-expect-error
 import * as kolorist from 'kolorist';
+// @ts-expect-error
 import dedentString from 'dedent';
 import {isInDebugMode} from './flag.js';
 

packages/core/src/project.ts

@@ -1,11 +1,12 @@
 import path from 'path';
 import {existsSync} from 'fs';
 import fs from 'fs/promises';
+import {packageDirectory} from 'pkg-dir';
+import {findUp} from 'find-up';
 import {globby} from './resolve.js';
 import {PackageInfo} from './interface.js';
 
 export const resolveCacheLocation = async (name: string): Promise<string> => {
-    const {packageDirectory} = await import('pkg-dir');
     const root = await packageDirectory();
 
     if (!root) {
@@ -22,7 +23,6 @@ export const readPackageConfig = async (cwd: string): Promise<PackageInfo> => {
 };
 
 export const findGitRoot = async (cwd?: string): Promise<string | undefined> => {
-    const {findUp} = await import('find-up');
     const gitDirectory = await findUp('.git', {cwd, type: 'directory'});
     return gitDirectory && path.dirname(gitDirectory);
 };
@@ -46,7 +46,6 @@ export const resolveMonorepoPackageDirectories = async (cwd: string): Promise<st
 };
 
 export const findMonorepoRoot = async (cwd: string): Promise<string> => {
-    const {findUp} = await import('find-up');
     const dir = await findUp('packages', {cwd, type: 'directory'});
 
     if (!dir) {

packages/core/src/resolve.ts

@@ -3,9 +3,9 @@ import fs from 'fs';
 import {fileURLToPath} from 'url';
 import {bundleRequire} from 'bundle-require';
 import resolveCore from 'resolve';
-// @ts-expect-error
-import type {Options as CoreGlobbyOptions} from 'globby';
+import {Options as CoreGlobbyOptions} from 'globby';
 import unixify from 'unixify';
+// @ts-expect-error
 import caller from 'caller';
 
 export const resolveFrom = (base: string) => (id: string) => {
@@ -54,6 +54,7 @@ interface GlobbyOptions extends CoreGlobbyOptions {
 }
 
 export const globby = async (patterns: string | string[], options?: GlobbyOptions) => {
+    // 为了生成CJS的时候不至于有它的`require`代码，只能塞到里面来
     const {globby: globbyCore} = await import('globby');
 
     if (options?.safe === true) {

site/docs/app/quick-start.md

@@ -71,8 +71,8 @@ module.exports = {
         "./*.ts"
     ],
     "compilerOptions": {
-        "module": "CommonJS",
-        "target": "es2018",
+        "module": "esnext",
+        "target": "esnext",
         "outDir": "dist",
         "noEmit": true,
         "jsx": "react-jsx",