@modern-js/core 1.3.0 → 1.4.1

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<{
@@ -22,6 +21,7 @@ export declare type HooksRunner = Progresses2Runners<{
   watchFiles: ParallelWorkflow<void>;
   fileChange: AsyncWorkflow<{
     filename: string;
+    eventType: 'add' | 'change' | 'unlink';
   }, void>;
   beforeExit: AsyncWorkflow<void, void>;
 }>;
@@ -38,8 +38,10 @@ export declare const manager: import("@modern-js/plugin").AsyncManager<Hooks, {
   watchFiles: ParallelWorkflow<void, unknown>;
   fileChange: AsyncWorkflow<{
     filename: string;
+    eventType: 'add' | 'change' | 'unlink';
   }, void>;
   beforeExit: AsyncWorkflow<void, void>;
+  beforeRestart: AsyncWorkflow<void, void>;
 }>;
 export declare const createPlugin: (initializer: import("@modern-js/plugin").AsyncInitializer<Partial<import("@modern-js/plugin").Progresses2Threads<{
   config: ParallelWorkflow<void, unknown>;
@@ -54,8 +56,10 @@ export declare const createPlugin: (initializer: import("@modern-js/plugin").Asy
   watchFiles: ParallelWorkflow<void, unknown>;
   fileChange: AsyncWorkflow<{
     filename: string;
+    eventType: 'add' | 'change' | 'unlink';
   }, void>;
   beforeExit: AsyncWorkflow<void, void>;
+  beforeRestart: AsyncWorkflow<void, void>;
 } & import("@modern-js/plugin").ClearDraftProgress<Hooks>>>>, options?: import("@modern-js/plugin").PluginOptions | undefined) => import("@modern-js/plugin").AsyncPlugin<Partial<import("@modern-js/plugin").Progresses2Threads<{
   config: ParallelWorkflow<void, unknown>;
   resolvedConfig: AsyncWaterfall<{
@@ -69,8 +73,10 @@ export declare const createPlugin: (initializer: import("@modern-js/plugin").Asy
   watchFiles: ParallelWorkflow<void, unknown>;
   fileChange: AsyncWorkflow<{
     filename: string;
+    eventType: 'add' | 'change' | 'unlink';
   }, void>;
   beforeExit: AsyncWorkflow<void, void>;
+  beforeRestart: AsyncWorkflow<void, void>;
 } & import("@modern-js/plugin").ClearDraftProgress<Hooks>>>>, registerHook: (newShape: Partial<Hooks>) => void, mountHook: () => Progresses2Runners<{
   config: ParallelWorkflow<void, unknown>;
   resolvedConfig: AsyncWaterfall<{
@@ -84,12 +90,14 @@ export declare const createPlugin: (initializer: import("@modern-js/plugin").Asy
   watchFiles: ParallelWorkflow<void, unknown>;
   fileChange: AsyncWorkflow<{
     filename: string;
+    eventType: 'add' | 'change' | 'unlink';
   }, void>;
   beforeExit: AsyncWorkflow<void, void>;
+  beforeRestart: 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 };
+export { AppContext, ResolvedConfigContext, useAppContext, useConfigContext, useResolvedConfigContext, ConfigContext };
+export type { NormalizedConfig, IAppContext };
 declare const initAppDir: (cwd?: string | undefined) => Promise<string>;
 export interface CoreOptions {
   configFile?: string;
@@ -101,6 +109,12 @@ export interface CoreOptions {
     server: any;
     serverPath: any;
   }[];
+  options?: {
+    metaName?: string;
+    srcDir?: string;
+    distDir?: string;
+    sharedDir?: string;
+  };
 }
 export declare const cli: {
   init: (argv?: string[], options?: CoreOptions | undefined) => Promise<{
@@ -111,4 +125,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/initWatcher.d.ts

@@ -1,3 +1,4 @@
+import chokidar from 'chokidar';
 import { LoadedConfig } from './config';
 import { HooksRunner } from '.';
-export declare const initWatcher: (loaded: LoadedConfig, appDirectory: string, configDir: string | undefined, hooksRunner: HooksRunner, argv: string[]) => Promise<void>;
+export declare const initWatcher: (loaded: LoadedConfig, appDirectory: string, configDir: string | undefined, hooksRunner: HooksRunner, argv: string[]) => Promise<chokidar.FSWatcher | undefined>;

package/dist/types/loadPlugins.d.ts

@@ -23,6 +23,8 @@ export declare const loadPlugins: (appDirectory: string, pluginConfig: PluginCon
 } | undefined) => {
   cli: any;
   cliPath: string | undefined;
-  server: any;
+  server: "" | {
+    pluginPath: string;
+  } | undefined;
   serverPath: string | undefined;
 }[];

package/package.json

@@ -11,7 +11,7 @@
     "modern",
     "modern.js"
   ],
-  "version": "1.3.0",
+  "version": "1.4.1",
   "jsnext:source": "./src/index.ts",
   "types": "./dist/types/index.d.ts",
   "main": "./dist/js/node/index.js",
@@ -42,9 +42,9 @@
   "dependencies": {
     "@babel/code-frame": "^7.14.5",
     "@babel/runtime": "^7",
-    "@modern-js/load-config": "^1.2.0",
-    "@modern-js/plugin": "^1.2.0",
-    "@modern-js/utils": "^1.2.0",
+    "@modern-js/load-config": "^1.2.1",
+    "@modern-js/plugin": "^1.2.1",
+    "@modern-js/utils": "^1.3.1",
     "address": "^1.1.2",
     "ajv": "^8.6.2",
     "ajv-keywords": "^5.0.0",
@@ -62,7 +62,7 @@
   "devDependencies": {
     "btsm": "2.2.2",
     "@types/babel__code-frame": "^7.0.3",
-    "@modern-js/types": "^1.2.0",
+    "@modern-js/types": "^1.3.1",
     "@types/jest": "^26",
     "@types/lodash.clonedeep": "^4.5.6",
     "@types/lodash.mergewith": "^4.6.6",
@@ -83,8 +83,7 @@
   },
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
-    "access": "public",
-    "types": "./dist/types/index.d.ts"
+    "access": "public"
   },
   "scripts": {
     "new": "modern new",

package/tests/config.test.ts

@@ -1,5 +1,6 @@
 import path from 'path';
 // import os from 'os';
+import { isDev, getPort } from '@modern-js/utils';
 import { resolveConfig } from '../src/config';
 import {
   cli,
@@ -11,11 +12,67 @@ import {
   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();
@@ -40,4 +97,41 @@ describe('config', () => {
     //   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

@@ -23,6 +23,48 @@ describe('context', () => {
       htmlTemplates: {},
       serverRoutes: [],
       entrypoints: [],
+      checkedEntries: [],
+      existSrc: true,
+      internalDirAlias: '@_modern_js_internal',
+      internalSrcAlias: '@_modern_js_src',
+      metaName: 'modern-js',
+    });
+  });
+
+  it('custom AppContext', () => {
+    const appDirectory = path.resolve(
+      __dirname,
+      './fixtures/load-plugin/user-plugins',
+    );
+
+    const customOptions = {
+      srcDir: 'source',
+      distDir: 'dist',
+      sharedDir: 'myShared',
+      metaName: 'jupiter',
+    };
+
+    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/.jupiter'),
+      plugins: [],
+      htmlTemplates: {},
+      serverRoutes: [],
+      entrypoints: [],
+      checkedEntries: [],
+      existSrc: true,
+      internalDirAlias: '@_jupiter_internal',
+      internalSrcAlias: '@_jupiter_src',
+      metaName: 'jupiter',
     });
   });
 });

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/initWatcher.test.ts

@@ -0,0 +1,63 @@
+import * as path from 'path';
+import { fs, wait } from '@modern-js/utils';
+import { initWatcher } from '../src/initWatcher';
+
+jest.useRealTimers();
+
+const mockAppDirectory = path.join(__dirname, './fixtures/index-test');
+const mockConfigDir = './config';
+const mockSrcDirectory = path.join(mockAppDirectory, './src');
+
+describe('initWatcher', () => {
+  afterAll(() => {
+    const file = path.join(mockSrcDirectory, './index.ts');
+    if (fs.existsSync(file)) {
+      fs.unlinkSync(file);
+    }
+  });
+
+  test('will trigger add event', async () => {
+    let triggeredType = '';
+    let triggeredFile = '';
+    const loaded = {
+      filePath: '',
+      dependencies: [],
+    };
+    const hooksRunner = {
+      watchFiles: async () => [mockSrcDirectory],
+      fileChange: jest.fn(({ filename, eventType }) => {
+        triggeredType = eventType;
+        triggeredFile = filename;
+      }),
+    };
+
+    if (await fs.pathExists(mockSrcDirectory)) {
+      await fs.remove(mockSrcDirectory);
+    }
+
+    const watcher = await initWatcher(
+      loaded as any,
+      mockAppDirectory,
+      mockConfigDir,
+      hooksRunner as any,
+      ['dev'],
+    );
+    await wait(100);
+
+    const file = path.join(mockSrcDirectory, './index.ts');
+    await fs.outputFile(file, '');
+    await wait(100);
+    // expect(hooksRunner.fileChange).toBeCalledTimes(1);
+    // expect(triggeredType).toBe('add');
+    expect(file.includes(triggeredFile)).toBeTruthy();
+
+    await wait(100);
+    await fs.remove(file);
+    await wait(200);
+    expect(hooksRunner.fileChange).toBeCalledTimes(2);
+    expect(triggeredType).toBe('unlink');
+    expect(file.includes(triggeredFile)).toBeTruthy();
+
+    watcher?.close();
+  });
+});

package/tests/loadPlugin.test.ts

@@ -37,7 +37,6 @@ describe('load plugins', () => {
       },
       {
         server: {
-          name: 'b',
           pluginPath: path.join(fixture, './test-plugin-b.js'),
         },
         serverPath: './test-plugin-b',

package/src/cli.ts

@@ -1,36 +0,0 @@
-// 这个文件跟 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/defaults.ts

@@ -1,101 +0,0 @@
-import { OutputConfig, ServerConfig, SourceConfig } from '.';
-
-const sourceDefaults: SourceConfig = {
-  entries: undefined,
-  disableDefaultEntries: false,
-  entriesDir: './src',
-  configDir: './config',
-  apiDir: './api',
-  envVars: [],
-  globalVars: undefined,
-  alias: undefined,
-  moduleScopes: undefined,
-  include: [],
-};
-
-const outputDefaults: OutputConfig = {
-  assetPrefix: '/',
-  htmlPath: 'html',
-  jsPath: 'static/js',
-  cssPath: 'static/css',
-  mediaPath: 'static/media',
-  path: 'dist',
-  title: '',
-  titleByEntries: undefined,
-  meta: {
-    charset: { charset: 'utf-8' },
-    viewport:
-      'width=device-width, initial-scale=1.0, shrink-to-fit=no, viewport-fit=cover, minimum-scale=1.0, maximum-scale=1.0, user-scalable=no',
-    'http-equiv': { 'http-equiv': 'x-ua-compatible', content: 'ie=edge' },
-    renderer: 'webkit',
-    layoutmode: 'standard',
-    imagemode: 'force',
-    'wap-font-scale': 'no',
-    'format-detection': 'telephone=no',
-  },
-  metaByEntries: undefined,
-  inject: 'head',
-  injectByEntries: undefined,
-  mountId: 'root',
-  favicon: '',
-  faviconByEntries: undefined,
-  copy: undefined,
-  scriptExt: undefined,
-  disableHtmlFolder: false,
-  disableCssModuleExtension: false,
-  disableCssExtract: false,
-  enableCssModuleTSDeclaration: false,
-  disableMinimize: false,
-  enableInlineStyles: false,
-  enableInlineScripts: false,
-  disableSourceMap: false,
-  disableInlineRuntimeChunk: false,
-  disableAssetsCache: false,
-  enableLatestDecorators: false,
-  polyfill: 'entry',
-  dataUriLimit: 10000,
-  templateParameters: {},
-  templateParametersByEntries: undefined,
-  cssModuleLocalIdentName: '[name]__[local]--[hash:base64:5]',
-  enableModernMode: false,
-  federation: undefined,
-  disableNodePolyfill: false,
-  enableTsLoader: false,
-};
-
-const serverDefaults: ServerConfig = {
-  routes: undefined,
-  publicRoutes: undefined,
-  ssr: undefined,
-  ssrByEntries: undefined,
-  baseUrl: '/',
-  port: 8080,
-};
-
-const devDefaults = { assetPrefix: false, https: false };
-
-const deployDefaults = {
-  domain: '',
-  domainByEntries: undefined,
-};
-
-const toolsDefaults = {
-  webpack: undefined,
-  babel: undefined,
-  postcss: undefined,
-  autoprefixer: undefined,
-  lodash: undefined,
-  devServer: undefined,
-  tsLoader: undefined,
-  terser: undefined,
-  minifyCss: undefined,
-};
-
-export const defaults = {
-  source: sourceDefaults,
-  output: outputDefaults,
-  server: serverDefaults,
-  dev: devDefaults,
-  deploy: deployDefaults,
-  tools: toolsDefaults,
-};