@modern-js/core 1.2.0 → 1.3.2

package/dist/types/index.d.ts

@@ -2,11 +2,10 @@ import { INTERNAL_PLUGINS } from '@modern-js/utils';
 import { ParallelWorkflow, AsyncWorkflow, Progresses2Runners, AsyncWaterfall } from '@modern-js/plugin';
 import type { Hooks } from '@modern-js/types';
 import { Command } from './utils/commander';
-import { defineConfig, loadUserConfig, UserConfig, ToolsConfig } from './config';
 import { AppContext, ConfigContext, IAppContext, initAppContext, ResolvedConfigContext, useAppContext, useConfigContext, useResolvedConfigContext } from './context';
 import { NormalizedConfig } from './config/mergeConfig';
 export type { Hooks };
-export { defaultsConfig, mergeConfig } from './config';
+export * from './config';
 export * from '@modern-js/plugin';
 export * from '@modern-js/plugin/node';
 export declare type HooksRunner = Progresses2Runners<{
@@ -88,18 +87,25 @@ export declare const createPlugin: (initializer: import("@modern-js/plugin").Asy
   beforeExit: AsyncWorkflow<void, void>;
 } & import("@modern-js/plugin").ClearDraftProgress<Hooks>>;
 export declare const usePlugins: (plugins: string[]) => void;
-export { defineConfig, AppContext, ResolvedConfigContext, useAppContext, useConfigContext, useResolvedConfigContext, ConfigContext };
-export type { NormalizedConfig, IAppContext, UserConfig, ToolsConfig };
-declare const initAppDir: () => Promise<string>;
+export { AppContext, ResolvedConfigContext, useAppContext, useConfigContext, useResolvedConfigContext, ConfigContext };
+export type { NormalizedConfig, IAppContext };
+declare const initAppDir: (cwd?: string | undefined) => Promise<string>;
 export interface CoreOptions {
   configFile?: string;
+  packageJsonConfig?: string;
   plugins?: typeof INTERNAL_PLUGINS;
-  beforeUsePlugins: (plugins: any, config: any) => {
+  beforeUsePlugins?: (plugins: any, config: any) => {
     cli: any;
     cliPath: any;
     server: any;
     serverPath: any;
   }[];
+  options?: {
+    srcDir?: string;
+    distDir?: string;
+    sharedDir?: string;
+    internalDir?: string;
+  };
 }
 export declare const cli: {
   init: (argv?: string[], options?: CoreOptions | undefined) => Promise<{
@@ -110,4 +116,4 @@ export declare const cli: {
   run: (argv: string[], options?: CoreOptions | undefined) => Promise<void>;
   restart: () => Promise<void>;
 };
-export { loadUserConfig, initAppDir, initAppContext };
+export { initAppDir, initAppContext };

package/dist/types/loadPlugins.d.ts

@@ -1,8 +1,13 @@
+import { INTERNAL_PLUGINS } from '@modern-js/utils';
 export interface PluginConfigItem {
   cli?: string;
   server?: string;
 }
 export declare type PluginConfig = Array<PluginConfigItem>;
+export declare function getAppPlugins(appDirectory: string, pluginConfig: PluginConfig, internalPlugins?: typeof INTERNAL_PLUGINS): {
+  cli?: string | undefined;
+  server?: string | undefined;
+}[];
 /**
  * Load internal plugins which in @modern-js scope and user's custom plugins.
  * @param appDirectory - Application root directory.

package/jest.config.js

@@ -0,0 +1,8 @@
+const sharedConfig = require('@scripts/jest-config');
+
+/** @type {import('@jest/types').Config.InitialOptions} */
+module.exports = {
+  // eslint-disable-next-line node/no-unsupported-features/es-syntax
+  ...sharedConfig,
+  rootDir: __dirname,
+};

package/modern.config.js

@@ -3,11 +3,4 @@ module.exports = {
   output: {
     disableSourceMap: true,
   },
-  testing: {
-    jest: {
-      collectCoverage: true,
-      collectCoverageFrom: ['src/**/*.ts'],
-      coveragePathIgnorePatterns: ['/node_modules/'],
-    },
-  },
 };

package/package.json

@@ -11,7 +11,7 @@
     "modern",
     "modern.js"
   ],
-  "version": "1.2.0",
+  "version": "1.3.2",
   "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": {
     "*": {
@@ -38,9 +42,9 @@
   "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.5",
+    "@modern-js/load-config": "^1.2.1",
+    "@modern-js/plugin": "^1.2.1",
+    "@modern-js/utils": "^1.2.2",
     "address": "^1.1.2",
     "ajv": "^8.6.2",
     "ajv-keywords": "^5.0.0",
@@ -56,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.4",
+    "@modern-js/types": "^1.2.1",
     "@types/jest": "^26",
     "@types/lodash.clonedeep": "^4.5.6",
     "@types/lodash.mergewith": "^4.6.6",
@@ -66,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": {
@@ -77,13 +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": "modern test --passWithNoTests"
+    "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/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,63 @@
+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: [],
+    });
+  });
+
+  it('custom AppContext', () => {
+    const appDirectory = path.resolve(
+      __dirname,
+      './fixtures/load-plugin/user-plugins',
+    );
+
+    const customOptions = {
+      srcDir: 'source',
+      distDir: 'dist',
+      sharedDir: 'myShared',
+      internalDir: 'myInternal',
+    };
+
+    const appContext = initAppContext(appDirectory, [], false, customOptions);
+    expect(appContext).toEqual({
+      appDirectory,
+      configFile: false,
+      ip: expect.any(String),
+      port: 0,
+      packageName: 'user-plugins',
+      srcDirectory: path.resolve(appDirectory, './source'),
+      distDirectory: 'dist',
+      sharedDirectory: path.resolve(appDirectory, './myShared'),
+      nodeModulesDirectory: expect.any(String),
+      internalDirectory: path.resolve(
+        appDirectory,
+        './node_modules/myInternal',
+      ),
+      plugins: [],
+      htmlTemplates: {},
+      serverRoutes: [],
+      entrypoints: [],
+    });
+  });
+});

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

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

package/tests/index.test.ts

@@ -0,0 +1,74 @@
+import path from 'path';
+import { cli } from '../src';
+import { resolveConfig, loadUserConfig } from '../src/config';
+import { loadEnv } from '../src/loadEnv';
+
+jest.mock('../src/config', () => ({
+  __esModule: true,
+  ...jest.requireActual('../src/config'),
+  loadUserConfig: jest.fn(),
+  resolveConfig: jest.fn(),
+}));
+
+jest.mock('../src/loadEnv', () => ({
+  __esModule: true,
+  ...jest.requireActual('../src/loadEnv'),
+  loadEnv: jest.fn(),
+}));
+
+describe('@modern-js/core test', () => {
+  let mockResolveConfig: any = {};
+  let mockLoadedConfig: any = {};
+  const cwdSpy = jest.spyOn(process, 'cwd');
+  const cwd = path.join(__dirname, './fixtures/index-test');
+
+  const resetMock = () => {
+    jest.resetAllMocks();
+    cwdSpy.mockReturnValue(cwd);
+    (resolveConfig as jest.Mock).mockReturnValue(
+      Promise.resolve(mockResolveConfig),
+    );
+    (loadUserConfig as jest.Mock).mockImplementation(() =>
+      Promise.resolve(mockLoadedConfig),
+    );
+  };
+
+  const resetValues = () => {
+    mockLoadedConfig = {
+      config: {},
+      filePath: false,
+      dependencies: [],
+      pkgConfig: {},
+      jsConfig: {},
+    };
+    mockResolveConfig = {
+      server: {
+        port: 8080,
+      },
+      output: {
+        path: './my/test/path',
+      },
+    };
+  };
+
+  beforeEach(() => {
+    resetValues();
+    resetMock();
+  });
+
+  it('test cli create', () => {
+    expect(cli).toBeTruthy();
+  });
+
+  it('test cli init dev', async () => {
+    cwdSpy.mockReturnValue(path.join(cwd, 'nested-folder'));
+    const options = {
+      beforeUsePlugins: jest.fn(),
+    };
+    options.beforeUsePlugins.mockImplementation((plugins, _) => plugins);
+    await cli.init(['dev'], options);
+    expect(loadEnv).toHaveBeenCalledWith(cwd);
+    expect(options.beforeUsePlugins).toHaveBeenCalledWith([], {});
+    // TODO: add more test cases
+  });
+});

package/tests/loadEnv.test.ts

@@ -1,6 +1,6 @@
 import fs from 'fs';
 import path from 'path';
-import { loadEnv } from '@/loadEnv';
+import { loadEnv } from '../src/loadEnv';
 
 const fixture = path.resolve(__dirname, './fixtures/load-env');
 

package/tests/loadPlugin.test.ts

@@ -1,7 +1,21 @@
 import path from 'path';
-import { loadPlugins } from '@/loadPlugins';
+import { loadPlugins, getAppPlugins } from '../src/loadPlugins';
 
 describe('load plugins', () => {
+  test('getAppPlugins', () => {
+    const appDirectory = path.resolve(
+      __dirname,
+      './fixtures/load-plugin/user-plugins',
+    );
+    const plugins = getAppPlugins(appDirectory, ['foo' as any], {
+      x: {
+        cli: 'x',
+        forced: true,
+      } as any,
+    });
+    expect(plugins).toEqual([{ cli: 'x', forced: true }, 'foo']);
+  });
+
   test('should load user plugin successfully', () => {
     const fixture = path.resolve(
       __dirname,
@@ -31,6 +45,27 @@ describe('load plugins', () => {
     ]);
   });
 
+  test('should load user string plugin successfully', () => {
+    const fixture = path.resolve(
+      __dirname,
+      './fixtures/load-plugin/user-plugins',
+    );
+
+    const plugins = loadPlugins(fixture, [
+      path.join(fixture, './test-plugin-a.js') as any,
+    ]);
+
+    expect(plugins).toEqual([
+      {
+        cli: {
+          name: 'a',
+          pluginPath: path.join(fixture, './test-plugin-a.js'),
+        },
+        cliPath: path.join(fixture, './test-plugin-a.js'),
+      },
+    ]);
+  });
+
   test(`should throw error when plugin not found `, () => {
     const fixture = path.resolve(__dirname, './fixtures/load-plugin/not-found');
 

package/tests/mergeConfig.test.ts

@@ -1,4 +1,4 @@
-import { mergeConfig } from '@/config/mergeConfig';
+import { mergeConfig } from '../src/config/mergeConfig';
 
 describe('load plugins', () => {
   test('should replace property deeply', () => {

package/tests/repeatKeyWarning.test.ts

@@ -1,5 +1,5 @@
-import { repeatKeyWarning } from '@/utils/repeatKeyWarning';
-import { UserConfig } from '@/config';
+import { repeatKeyWarning } from '../src/utils/repeatKeyWarning';
+import { UserConfig } from '../src/config';
 
 jest.spyOn(process, 'exit').mockImplementation();
 

package/tests/schema.test.ts

@@ -1,4 +1,4 @@
-import { patchSchema, traverseSchema } from '@/config/schema';
+import { patchSchema, traverseSchema } from '../src/config/schema';
 
 describe('patch schemas', () => {
   test('should add schema succcessfully', () => {

package/tests/tsconfig.json

@@ -6,8 +6,6 @@
     "baseUrl": "./",
     "isolatedModules": true,
     "esModuleInterop": true,
-    "paths": {
-      "@/*": ["../src/*"]
-    }
+    "paths": {}
   }
 }

package/tests/utils.test.ts

@@ -0,0 +1,8 @@
+import { program, Command } from '../src/utils/commander';
+
+describe('utils', () => {
+  it('default', () => {
+    expect(program).toBeDefined();
+    expect(Command).toBeDefined();
+  });
+});

package/tsconfig.json

@@ -6,9 +6,7 @@
     "baseUrl": "./",
     "isolatedModules": true,
     "esModuleInterop": true,
-    "paths": {
-      "@/*": ["./src/*"]
-    }
+    "paths": {}
   },
   "include": ["src"]
 }