@modern-js/core 1.1.5-beta.1 → 1.3.1

package/package.json

@@ -11,7 +11,7 @@
     "modern",
     "modern.js"
   ],
-  "version": "1.1.5-beta.1",
+  "version": "1.3.1",
   "jsnext:source": "./src/index.ts",
   "types": "./dist/types/index.d.ts",
   "main": "./dist/js/node/index.js",
@@ -20,12 +20,16 @@
   "exports": {
     ".": {
       "node": {
+        "jsnext:source": "./src/index.ts",
         "import": "./dist/js/modern/index.js",
         "require": "./dist/js/node/index.js"
       },
       "default": "./dist/js/treeshaking/index.js"
     },
-    "./bin": "./bin/modern-js.js"
+    "./bin": {
+      "jsnext:source": "./src/cli.ts",
+      "default": "./bin/modern-js.js"
+    }
   },
   "typesVersions": {
     "*": {
@@ -35,20 +39,12 @@
     }
   },
   "bin": "./bin/modern-js.js",
-  "scripts": {
-    "prepare": "pnpm build",
-    "prepublishOnly": "pnpm build -- --platform",
-    "new": "modern new",
-    "build": "modern build",
-    "dev": "modern build --watch",
-    "test": "modern test --passWithNoTests"
-  },
   "dependencies": {
     "@babel/code-frame": "^7.14.5",
     "@babel/runtime": "^7",
-    "@modern-js/load-config": "^1.1.1",
-    "@modern-js/plugin": "^1.1.2",
-    "@modern-js/utils": "^1.1.4",
+    "@modern-js/load-config": "^1.2.0",
+    "@modern-js/plugin": "^1.2.0",
+    "@modern-js/utils": "^1.2.1",
     "address": "^1.1.2",
     "ajv": "^8.6.2",
     "ajv-keywords": "^5.0.0",
@@ -64,8 +60,9 @@
     "v8-compile-cache": "^2.3.0"
   },
   "devDependencies": {
+    "btsm": "2.2.2",
     "@types/babel__code-frame": "^7.0.3",
-    "@modern-js/types": "^1.1.3",
+    "@modern-js/types": "^1.2.0",
     "@types/jest": "^26",
     "@types/lodash.clonedeep": "^4.5.6",
     "@types/lodash.mergewith": "^4.6.6",
@@ -74,8 +71,9 @@
     "@types/react-dom": "^17",
     "@types/signale": "^1.4.2",
     "typescript": "^4",
-    "@modern-js/plugin-testing": "^1.1.1",
-    "@modern-js/module-tools": "^1.1.2"
+    "jest": "^27",
+    "@scripts/build": "0.0.0",
+    "@scripts/jest-config": "0.0.0"
   },
   "sideEffects": false,
   "modernConfig": {
@@ -85,6 +83,14 @@
   },
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
-    "access": "public"
-  }
-}
+    "access": "public",
+    "types": "./dist/types/index.d.ts"
+  },
+  "scripts": {
+    "new": "modern new",
+    "build": "modern build",
+    "dev": "modern build --watch",
+    "test": "jest"
+  },
+  "readme": "\n<p align=\"center\">\n  <a href=\"https://modernjs.dev\" target=\"blank\"><img src=\"https://lf3-static.bytednsdoc.com/obj/eden-cn/ylaelkeh7nuhfnuhf/modernjs-cover.png\" width=\"300\" alt=\"Modern.js Logo\" /></a>\n</p>\n<p align=\"center\">\n现代 Web 工程体系\n  <br/>\n  <a href=\"https://modernjs.dev\" target=\"blank\">\n    modernjs.dev\n  </a>\n</p>\n<p align=\"center\">\n  The meta-framework suite designed from scratch for frontend-focused modern web development\n</p>\n\n# Introduction\n\n> The doc site ([modernjs.dev](https://modernjs.dev)) and articles are only available in Chinese for now, we are planning to add English versions soon.\n\n- [Modern.js: Hello, World!](https://zhuanlan.zhihu.com/p/426707646)\n\n## Getting Started\n\n- [Quick Start](https://modernjs.dev/docs/start)\n- [Guides](https://modernjs.dev/docs/guides)\n- [API References](https://modernjs.dev/docs/apis)\n\n## Contributing\n\n- [Contributing Guide](https://github.com/modern-js-dev/modern.js/blob/main/CONTRIBUTING.md)\n"
+}

package/src/cli.ts

@@ -0,0 +1,36 @@
+// 这个文件跟 bin/modern-js.js 基本一样
+// 在开发阶段，因为 package.json 的 exports['./bin']['jsnext:source'] 配置
+// 了这个文件，所以需要保留, 后续如果找到更好的方式之后会移除这个文件
+
+import path from 'path';
+import { cli } from '.';
+
+const { version } = require('../package.json');
+
+// XXX: 通过这个方式去掉了 package.json 里面对于 @modern-js/module-tools 的 devDependencies 依赖
+// 然后可以正常的执行 modern build
+const kModuleToolsCliPath = path.resolve(
+  __dirname,
+  '../../../solutions/module-tools/src/index.ts',
+);
+
+process.env.MODERN_JS_VERSION = version;
+if (!process.env.NODE_ENV) {
+  process.env.NODE_ENV =
+    // eslint-disable-next-line no-nested-ternary
+    ['build', 'start', 'deploy'].includes(process.argv[2])
+      ? 'production'
+      : process.argv[2] === 'test'
+      ? 'test'
+      : 'development';
+}
+
+cli.run(process.argv.slice(2), {
+  plugins: {
+    '@modern-js/module-tools': {
+      cli: kModuleToolsCliPath,
+      // 是否需要强制加载这个组件，跳过 loadPlugins 里面 filter 的检测逻辑
+      forced: true,
+    } as any,
+  },
+});

package/src/config/index.ts

@@ -24,7 +24,7 @@ const debug = createDebugger('resolve-config');
 export { defaults as defaultsConfig };
 export { mergeConfig };
 
-export interface SourceConfig {
+interface SourceConfig {
   entries?: Record<
     string,
     | string
@@ -49,7 +49,7 @@ export interface SourceConfig {
   include?: Array<string | RegExp>;
 }
 
-export interface OutputConfig {
+interface OutputConfig {
   assetPrefix?: string;
   htmlPath?: string;
   jsPath?: string;
@@ -92,7 +92,7 @@ export interface OutputConfig {
   enableTsLoader?: boolean;
 }
 
-export interface ServerConfig {
+interface ServerConfig {
   routes?: Record<
     string,
     | string
@@ -111,12 +111,12 @@ export interface ServerConfig {
   enableMicroFrontendDebug?: boolean;
 }
 
-export interface DevConfig {
+interface DevConfig {
   assetPrefix?: string | boolean;
   https?: boolean;
 }
 
-export interface DeployConfig {
+interface DeployConfig {
   microFrontend?: boolean & Record<string, unknown>;
   domain?: string | Array<string>;
   domainByEntries?: Record<string, string | Array<string>>;
@@ -126,7 +126,7 @@ type ConfigFunction =
   | Record<string, unknown>
   // eslint-disable-next-line @typescript-eslint/no-invalid-void-type
   | ((config: Record<string, unknown>) => Record<string, unknown> | void);
-export interface ToolsConfig {
+interface ToolsConfig {
   webpack?: ConfigFunction;
   babel?: ConfigFunction;
   autoprefixer?: ConfigFunction;
@@ -139,13 +139,13 @@ export interface ToolsConfig {
   esbuild?: Record<string, unknown>;
 }
 
-export type RuntimeConfig = Record<string, any>;
+type RuntimeConfig = Record<string, any>;
 
-export interface RuntimeByEntriesConfig {
+interface RuntimeByEntriesConfig {
   [name: string]: RuntimeConfig;
 }
 
-export interface UserConfig {
+interface UserConfig {
   source?: SourceConfig;
   output?: OutputConfig;
   server?: ServerConfig;
@@ -157,12 +157,12 @@ export interface UserConfig {
   runtimeByEntries?: RuntimeByEntriesConfig;
 }
 
-export type ConfigParam =
+type ConfigParam =
   | UserConfig
   | Promise<UserConfig>
   | ((env: any) => UserConfig | Promise<UserConfig>);
 
-export interface LoadedConfig {
+interface LoadedConfig {
   config: UserConfig;
   filePath: string | false;
   dependencies: string[];
@@ -175,8 +175,13 @@ export const defineConfig = (config: ConfigParam): ConfigParam => config;
 export const loadUserConfig = async (
   appDirectory: string,
   filePath?: string,
+  packageJsonConfig?: string,
 ): Promise<LoadedConfig> => {
-  const loaded = await loadConfig<ConfigParam>(appDirectory, filePath);
+  const loaded = await loadConfig<ConfigParam>(
+    appDirectory,
+    filePath,
+    packageJsonConfig,
+  );
 
   const config = !loaded
     ? {}
@@ -186,7 +191,7 @@ export const loadUserConfig = async (
 
   return {
     config: mergeWith({}, config || {}, loaded?.pkgConfig || {}),
-    jsConfig: config || {},
+    jsConfig: (config || {}) as any,
     pkgConfig: (loaded?.pkgConfig || {}) as UserConfig,
     filePath: loaded?.path,
     dependencies: loaded?.dependencies || [],
@@ -226,7 +231,7 @@ export const resolveConfig = async (
   loaded: LoadedConfig,
   configs: UserConfig[],
   schemas: PluginValidateSchema[],
-  isRestart: boolean,
+  restartWithExistingPort: number,
   argv: string[],
 ): Promise<NormalizedConfig> => {
   const { config: userConfig, jsConfig, pkgConfig } = loaded;
@@ -282,12 +287,18 @@ export const resolveConfig = async (
       throw new Error(`Validate configuration error.`);
     }
   }
-  const resolved = mergeConfig([defaults, ...configs, userConfig]);
+  const resolved = mergeConfig([defaults as any, ...configs, userConfig]);
 
   resolved._raw = loaded.config;
 
-  if (isDev() && argv[0] === 'dev' && !isRestart) {
-    resolved.server.port = await getPort(resolved.server.port!);
+  if (isDev() && argv[0] === 'dev') {
+    if (restartWithExistingPort > 0) {
+      // dev server is restarted, should use existing port number
+      resolved.server.port = restartWithExistingPort;
+    } else {
+      // get port for new dev server
+      resolved.server.port = await getPort(resolved.server.port!);
+    }
   }
 
   debug('resolved %o', resolved);
@@ -295,3 +306,17 @@ export const resolveConfig = async (
   return resolved;
 };
 /* eslint-enable max-statements, max-params */
+
+export type {
+  SourceConfig,
+  OutputConfig,
+  ServerConfig,
+  DevConfig,
+  DeployConfig,
+  ToolsConfig,
+  RuntimeConfig,
+  RuntimeByEntriesConfig,
+  UserConfig,
+  ConfigParam,
+  LoadedConfig,
+};

package/src/index.ts

@@ -20,13 +20,7 @@ import { enable } from '@modern-js/plugin/node';
 
 import type { Hooks } from '@modern-js/types';
 import { program, Command } from './utils/commander';
-import {
-  resolveConfig,
-  defineConfig,
-  loadUserConfig,
-  UserConfig,
-  ToolsConfig,
-} from './config';
+import { resolveConfig, loadUserConfig } from './config';
 import { loadPlugins } from './loadPlugins';
 import {
   AppContext,
@@ -43,8 +37,7 @@ import { NormalizedConfig } from './config/mergeConfig';
 import { loadEnv } from './loadEnv';
 
 export type { Hooks };
-export { defaultsConfig, mergeConfig } from './config';
-
+export * from './config';
 export * from '@modern-js/plugin';
 export * from '@modern-js/plugin/node';
 
@@ -117,7 +110,6 @@ export const usePlugins = (plugins: string[]) =>
   );
 
 export {
-  defineConfig,
   AppContext,
   ResolvedConfigContext,
   useAppContext,
@@ -126,15 +118,17 @@ export {
   ConfigContext,
 };
 
-export type { NormalizedConfig, IAppContext, UserConfig, ToolsConfig };
+export type { NormalizedConfig, IAppContext };
 
-const initAppDir = async (): Promise<string> => {
-  const pkg = await pkgUp({ cwd: process.cwd() });
+const initAppDir = async (cwd?: string): Promise<string> => {
+  if (!cwd) {
+    // eslint-disable-next-line no-param-reassign
+    cwd = process.cwd();
+  }
+  const pkg = await pkgUp({ cwd });
 
   if (!pkg) {
-    throw new Error(
-      `no package.json found in current work dir: ${process.cwd()}`,
-    );
+    throw new Error(`no package.json found in current work dir: ${cwd}`);
   }
 
   return path.dirname(pkg);
@@ -142,8 +136,9 @@ const initAppDir = async (): Promise<string> => {
 
 export interface CoreOptions {
   configFile?: string;
+  packageJsonConfig?: string;
   plugins?: typeof INTERNAL_PLUGINS;
-  beforeUsePlugins: (
+  beforeUsePlugins?: (
     plugins: any,
     config: any,
   ) => { cli: any; cliPath: any; server: any; serverPath: any }[];
@@ -152,6 +147,7 @@ export interface CoreOptions {
 const createCli = () => {
   let hooksRunner: HooksRunner;
   let isRestart = false;
+  let restartWithExistingPort = 0;
 
   const init = async (argv: string[] = [], options?: CoreOptions) => {
     enable();
@@ -162,7 +158,11 @@ const createCli = () => {
 
     loadEnv(appDirectory);
 
-    const loaded = await loadUserConfig(appDirectory, options?.configFile);
+    const loaded = await loadUserConfig(
+      appDirectory,
+      options?.configFile,
+      options?.packageJsonConfig,
+    );
 
     let plugins = loadPlugins(
       appDirectory,
@@ -208,7 +208,7 @@ const createCli = () => {
       loaded,
       extraConfigs as any,
       extraSchemas as any,
-      isRestart,
+      restartWithExistingPort,
       argv,
     );
 
@@ -249,6 +249,7 @@ const createCli = () => {
 
   async function restart() {
     isRestart = true;
+    restartWithExistingPort = isRestart ? AppContext.use().value?.port ?? 0 : 0;
 
     logger.info('Restart...\n');
 
@@ -274,4 +275,4 @@ const createCli = () => {
 
 export const cli = createCli();
 
-export { loadUserConfig, initAppDir, initAppContext };
+export { initAppDir, initAppContext };

package/src/loadPlugins.ts

@@ -49,6 +49,28 @@ const resolvePlugin = (appDirectory: string, plugin: PluginConfigItem) => {
   return resolved;
 };
 
+export function getAppPlugins(
+  appDirectory: string,
+  pluginConfig: PluginConfig,
+  internalPlugins?: typeof INTERNAL_PLUGINS,
+) {
+  const allPlugins = internalPlugins || INTERNAL_PLUGINS;
+  const appPlugins = [
+    ...Object.keys(allPlugins)
+      .filter(name => {
+        const config: any = allPlugins[name];
+        if (config.forced === true) {
+          // 参考 packages/cli/core/src/cli.ts 文件
+          return true;
+        }
+        return isDepExists(appDirectory, name);
+      })
+      .map(name => allPlugins[name]),
+    ...pluginConfig,
+  ];
+  return appPlugins;
+}
+
 /**
  * Load internal plugins which in @modern-js scope and user's custom plugins.
  * @param appDirectory - Application root directory.
@@ -60,12 +82,7 @@ export const loadPlugins = (
   pluginConfig: PluginConfig,
   internalPlugins?: typeof INTERNAL_PLUGINS,
 ) => {
-  const plugins = [
-    ...Object.keys(internalPlugins || INTERNAL_PLUGINS)
-      .filter(name => isDepExists(appDirectory, name))
-      .map(name => (internalPlugins || INTERNAL_PLUGINS)[name]),
-    ...pluginConfig,
-  ];
+  const plugins = getAppPlugins(appDirectory, pluginConfig, internalPlugins);
 
   return plugins.map(plugin => {
     const { cli, server } = resolvePlugin(appDirectory, plugin);

package/tests/btsm.test.ts

@@ -0,0 +1,20 @@
+import path from 'path';
+import { spawnSync } from 'child_process';
+
+const kPackageDir = path.resolve(__dirname, '..');
+
+describe('jsnext:source', () => {
+  test('process exit status is 0', () => {
+    const { status, stdout, stderr } = spawnSync(
+      process.execPath,
+      ['--conditions=jsnext:source', '-r', 'btsm', 'src/cli.ts'],
+      {
+        cwd: kPackageDir,
+        encoding: 'utf-8',
+      },
+    );
+    expect(stdout).toBe('');
+    expect(stderr.startsWith('Usage: modern <command> [options]')).toBe(true);
+    expect(status).toBe(1);
+  });
+});

package/tests/config.test.ts

@@ -0,0 +1,137 @@
+import path from 'path';
+// import os from 'os';
+import { isDev, getPort } from '@modern-js/utils';
+import { resolveConfig } from '../src/config';
+import {
+  cli,
+  loadUserConfig,
+  initAppContext,
+  initAppDir,
+  manager,
+  createPlugin,
+  registerHook,
+  useRunner,
+} from '../src';
+import { defaults } from '../src/config/defaults';
+
+jest.mock('@modern-js/utils', () => ({
+  __esModule: true,
+  ...jest.requireActual('@modern-js/utils'),
+  isDev: jest.fn(),
+  getPort: jest.fn(),
+}));
+
+// const kOSRootDir =
+//   os.platform() === 'win32' ? process.cwd().split(path.sep)[0] : '/';
+
+describe('config', () => {
+  /**
+   * Typescript Type annotations cannot be used for esbuild-jest
+   * test files that use jest.mock('@some/module')
+   * refer to this esbuild-jest issue:
+   * https://github.com/aelbore/esbuild-jest/issues/57
+   * TODO: find a better solution to solve this problem while allowing us
+   * to use esbuild, and have good TypeScript support
+   */
+  let loaded = {
+    config: {},
+    filePath: '',
+    dependencies: [],
+    pkgConfig: {},
+    jsConfig: {},
+  };
+  let schemas: any[] = [];
+  let restartWithExistingPort = 0;
+  let argv: string[] = ['dev'];
+  let configs: any[] = [];
+
+  const getResolvedConfig = async () =>
+    resolveConfig(loaded, configs, schemas, restartWithExistingPort, argv);
+
+  const resetParams = () => {
+    loaded = {
+      config: {},
+      filePath: '',
+      dependencies: [],
+      pkgConfig: {},
+      jsConfig: {},
+    };
+    schemas = [];
+    restartWithExistingPort = 0;
+    argv = ['dev'];
+    configs = [];
+  };
+  const resetMock = () => {
+    jest.resetAllMocks();
+    (isDev as jest.Mock).mockReturnValue(true);
+    (getPort as jest.Mock).mockReturnValue(
+      Promise.resolve(defaults.server.port),
+    );
+  };
+  beforeEach(() => {
+    resetParams();
+    resetMock();
+  });
+
+  it('default', () => {
+    expect(resolveConfig).toBeDefined();
+    expect(cli).toBeDefined();
+    expect(loadUserConfig).toBeDefined();
+    expect(initAppContext).toBeDefined();
+    expect(initAppDir).toBeDefined();
+    expect(manager).toBeDefined();
+    expect(createPlugin).toBeDefined();
+    expect(registerHook).toBeDefined();
+    expect(useRunner).toBeDefined();
+  });
+
+  it('initAppDir', async () => {
+    expect(await initAppDir(__dirname)).toBe(path.resolve(__dirname, '..'));
+    // expect(await initAppDir()).toBe(path.resolve(__dirname, '..'));
+
+    // FIXME: windows 下面会失败，先忽略这个测试
+    // try {
+    //   await initAppDir(kOSRootDir);
+    //   expect(true).toBe(false); // SHOULD NOT BE HERE
+    // } catch (err: any) {
+    //   expect(err.message).toMatch(/no package.json found in current work dir/);
+    // }
+  });
+
+  test('should use default port if not restarting in dev mode', async () => {
+    let resolved = await getResolvedConfig();
+    expect(resolved.server.port).toEqual(defaults.server.port);
+    expect(getPort).toHaveBeenCalledWith(defaults.server.port);
+
+    // getResolvedConfig should use the value givin by getPort
+    restartWithExistingPort = -1;
+    (getPort as jest.Mock).mockClear();
+    (getPort as jest.Mock).mockReturnValue(1111);
+    resolved = await getResolvedConfig();
+    expect(resolved.server.port).toEqual(1111);
+    expect(getPort).toHaveBeenCalledWith(defaults.server.port);
+
+    argv = ['start'];
+    (isDev as jest.Mock).mockReturnValue(false);
+    restartWithExistingPort = 0;
+    resolved = await getResolvedConfig();
+    expect(resolved.server.port).toEqual(defaults.server.port);
+
+    restartWithExistingPort = 1234;
+    resolved = await getResolvedConfig();
+    expect(resolved.server.port).toEqual(defaults.server.port);
+
+    restartWithExistingPort = -1;
+    resolved = await getResolvedConfig();
+    expect(resolved.server.port).toEqual(defaults.server.port);
+  });
+
+  test('should reuse existing port if restarting in dev mode', async () => {
+    restartWithExistingPort = 1234;
+    const resolved = await getResolvedConfig();
+    expect(resolved.server.port).toEqual(1234);
+  });
+});
+
+// type TEST = Parameters<typeof resolveConfig>;
+// type TypeC = TEST[1];

package/tests/context.test.ts

@@ -0,0 +1,28 @@
+import path from 'path';
+import { initAppContext } from '../src/context';
+
+describe('context', () => {
+  it('initAppContext', () => {
+    const appDirectory = path.resolve(
+      __dirname,
+      './fixtures/load-plugin/user-plugins',
+    );
+    const appContext = initAppContext(appDirectory, [], false);
+    expect(appContext).toEqual({
+      appDirectory,
+      configFile: false,
+      ip: expect.any(String),
+      port: 0,
+      packageName: expect.any(String),
+      srcDirectory: expect.any(String),
+      distDirectory: expect.any(String),
+      sharedDirectory: expect.any(String),
+      nodeModulesDirectory: expect.any(String),
+      internalDirectory: expect.any(String),
+      plugins: [],
+      htmlTemplates: {},
+      serverRoutes: [],
+      entrypoints: [],
+    });
+  });
+});

package/tests/fixtures/index-test/package.json

@@ -0,0 +1,3 @@
+{
+  "name": "index-test"
+}