@modern-js/core 1.3.2 → 1.4.0

package/CHANGELOG.md

@@ -1,5 +1,28 @@
 # @modern-js/core
 
+## 1.4.0
+
+### Minor Changes
+
+- bada2879: refactor plugin-garfish:
+  - change @modern-js/plugin-micro-frontend => @modern-js/plugin-garfish
+  - remove disableCustomerRouter logic
+  - adding unit test
+  - fix plugin-garfish type error
+
+### Patch Changes
+
+- d9cc5ea9: support resatrt options transfer
+- bd819a8d: fix: file route changed not trigger hot reload
+- d099e5c5: fix error when modify modern.config.js
+- 24f616ca: feat: support custom meta info
+- Updated dependencies [ec4dbffb]
+- Updated dependencies [d099e5c5]
+- Updated dependencies [bada2879]
+- Updated dependencies [24f616ca]
+- Updated dependencies [bd819a8d]
+  - @modern-js/utils@1.3.0
+
 ## 1.3.2
 
 ### Patch Changes

package/dist/js/modern/context.js

@@ -9,12 +9,13 @@ export const useConfigContext = () => ConfigContext.use().value;
 export const useResolvedConfigContext = () => ResolvedConfigContext.use().value;
 export const initAppContext = (appDirectory, plugins, configFile, options) => {
   const {
+    metaName = 'modern-js',
     srcDir = 'src',
     distDir = '',
-    sharedDir = 'shared',
-    internalDir = '.modern-js'
+    sharedDir = 'shared'
   } = options || {};
   return {
+    metaName,
     appDirectory,
     configFile,
     ip: address.ip(),
@@ -24,10 +25,13 @@ export const initAppContext = (appDirectory, plugins, configFile, options) => {
     distDirectory: distDir,
     sharedDirectory: path.resolve(appDirectory, sharedDir),
     nodeModulesDirectory: path.resolve(appDirectory, './node_modules'),
-    internalDirectory: path.resolve(appDirectory, `./node_modules/${internalDir}`),
+    internalDirectory: path.resolve(appDirectory, `./node_modules/.${metaName}`),
     plugins,
     htmlTemplates: {},
     serverRoutes: [],
-    entrypoints: []
+    entrypoints: [],
+    existSrc: true,
+    internalDirAlias: `@_${metaName.replace(/-/g, '_')}_internal`,
+    internalSrcAlias: `@_${metaName.replace(/-/g, '_')}_src`
   };
 };

package/dist/js/modern/index.js

@@ -28,7 +28,9 @@ const hooksMap = {
   watchFiles: createParallelWorkflow(),
   fileChange: createAsyncWorkflow(),
   // eslint-disable-next-line @typescript-eslint/no-invalid-void-type
-  beforeExit: createAsyncWorkflow()
+  beforeExit: createAsyncWorkflow(),
+  // eslint-disable-next-line @typescript-eslint/no-invalid-void-type
+  beforeRestart: createAsyncWorkflow()
 };
 export const manager = createAsyncManager(hooksMap);
 export const {
@@ -60,10 +62,12 @@ const createCli = () => {
   let hooksRunner;
   let isRestart = false;
   let restartWithExistingPort = 0;
+  let restartOptions;
 
   const init = async (argv = [], options) => {
     enable();
     manager.clear();
+    restartOptions = options;
     const appDirectory = await initAppDir();
     loadEnv(appDirectory);
     const loaded = await loadUserConfig(appDirectory, options === null || options === void 0 ? void 0 : options.configFile, options === null || options === void 0 ? void 0 : options.packageJsonConfig);
@@ -139,9 +143,11 @@ const createCli = () => {
     restartWithExistingPort = isRestart ? (_AppContext$use$value = (_AppContext$use$value2 = AppContext.use().value) === null || _AppContext$use$value2 === void 0 ? void 0 : _AppContext$use$value2.port) !== null && _AppContext$use$value !== void 0 ? _AppContext$use$value : 0 : 0;
     logger.info('Restart...\n');
     let hasGetError = false;
+    const runner = manager.useRunner();
+    await runner.beforeRestart();
 
     try {
-      await init(process.argv.slice(2));
+      await init(process.argv.slice(2), restartOptions);
     } catch (err) {
       console.error(err);
       hasGetError = true;

package/dist/js/modern/initWatcher.js

@@ -1,7 +1,7 @@
 import crypto from 'crypto';
 import fs from 'fs';
 import path from 'path';
-import { isDev, createDebugger } from '@modern-js/utils';
+import { isDev, createDebugger, isTest } from '@modern-js/utils';
 import chokidar from 'chokidar';
 const debug = createDebugger('watch-files');
 
@@ -10,7 +10,7 @@ const md5 = data => crypto.createHash('md5').update(data).digest('hex');
 const hashMap = new Map();
 export const initWatcher = async (loaded, appDirectory, configDir, hooksRunner, argv) => {
   // only add fs watcher on dev mode.
-  if (isDev() && argv[0] === 'dev') {
+  if ((isDev() || isTest()) && argv[0] === 'dev') {
     const extraFiles = await hooksRunner.watchFiles();
     const configPath = path.join(appDirectory, configDir);
     const watched = [`${configPath}/html`, ...extraFiles, loaded === null || loaded === void 0 ? void 0 : loaded.filePath, ...loaded.dependencies].filter(Boolean);
@@ -28,19 +28,35 @@ export const initWatcher = async (loaded, appDirectory, configDir, hooksRunner,
         debug(`file change: %s`, changed);
         hashMap.set(changed, currentHash);
         hooksRunner.fileChange({
-          filename: changed
+          filename: changed,
+          eventType: 'change'
         });
       }
     });
+    watcher.on('add', name => {
+      debug(`add file: %s`, name);
+      const currentHash = md5(fs.readFileSync(path.join(appDirectory, name), 'utf8'));
+      hashMap.set(name, currentHash);
+      hooksRunner.fileChange({
+        filename: name,
+        eventType: 'add'
+      });
+    });
     watcher.on('unlink', name => {
       debug(`remove file: %s`, name);
 
       if (hashMap.has(name)) {
         hashMap.delete(name);
       }
+
+      hooksRunner.fileChange({
+        filename: name,
+        eventType: 'unlink'
+      });
     });
     watcher.on('error', err => {
       throw err;
     });
+    return watcher;
   }
 };

package/dist/js/modern/loadPlugins.js

@@ -81,12 +81,13 @@ export const loadPlugins = (appDirectory, pluginConfig, internalPlugins) => {
 
     const cliPlugin = cli && _objectSpread(_objectSpread({}, compatRequire(cli)), {}, {
       pluginPath: cli
-    });
+    }); // server plugin should be required by server
 
-    const serverPlugin = server && _objectSpread(_objectSpread({}, compatRequire(server)), {}, {
-      pluginPath: server
-    });
 
+    const serverPlugin = server && {
+      // ...compatRequire(server),
+      pluginPath: server
+    };
     return {
       cli: cliPlugin,
       cliPath: typeof plugin === 'string' ? plugin : plugin.cli,

package/dist/js/node/context.js

@@ -34,12 +34,13 @@ exports.useResolvedConfigContext = useResolvedConfigContext;
 
 const initAppContext = (appDirectory, plugins, configFile, options) => {
   const {
+    metaName = 'modern-js',
     srcDir = 'src',
     distDir = '',
-    sharedDir = 'shared',
-    internalDir = '.modern-js'
+    sharedDir = 'shared'
   } = options || {};
   return {
+    metaName,
     appDirectory,
     configFile,
     ip: _address.default.ip(),
@@ -49,11 +50,14 @@ const initAppContext = (appDirectory, plugins, configFile, options) => {
     distDirectory: distDir,
     sharedDirectory: _path.default.resolve(appDirectory, sharedDir),
     nodeModulesDirectory: _path.default.resolve(appDirectory, './node_modules'),
-    internalDirectory: _path.default.resolve(appDirectory, `./node_modules/${internalDir}`),
+    internalDirectory: _path.default.resolve(appDirectory, `./node_modules/.${metaName}`),
     plugins,
     htmlTemplates: {},
     serverRoutes: [],
-    entrypoints: []
+    entrypoints: [],
+    existSrc: true,
+    internalDirAlias: `@_${metaName.replace(/-/g, '_')}_internal`,
+    internalSrcAlias: `@_${metaName.replace(/-/g, '_')}_src`
   };
 };
 

package/dist/js/node/index.js

@@ -141,7 +141,9 @@ const hooksMap = {
   watchFiles: (0, _plugin.createParallelWorkflow)(),
   fileChange: (0, _plugin.createAsyncWorkflow)(),
   // eslint-disable-next-line @typescript-eslint/no-invalid-void-type
-  beforeExit: (0, _plugin.createAsyncWorkflow)()
+  beforeExit: (0, _plugin.createAsyncWorkflow)(),
+  // eslint-disable-next-line @typescript-eslint/no-invalid-void-type
+  beforeRestart: (0, _plugin.createAsyncWorkflow)()
 };
 const manager = (0, _plugin.createAsyncManager)(hooksMap);
 exports.manager = manager;
@@ -181,10 +183,12 @@ const createCli = () => {
   let hooksRunner;
   let isRestart = false;
   let restartWithExistingPort = 0;
+  let restartOptions;
 
   const init = async (argv = [], options) => {
     (0, _node.enable)();
     manager.clear();
+    restartOptions = options;
     const appDirectory = await initAppDir();
     (0, _loadEnv.loadEnv)(appDirectory);
     const loaded = await (0, _config.loadUserConfig)(appDirectory, options === null || options === void 0 ? void 0 : options.configFile, options === null || options === void 0 ? void 0 : options.packageJsonConfig);
@@ -265,9 +269,11 @@ const createCli = () => {
     _utils.logger.info('Restart...\n');
 
     let hasGetError = false;
+    const runner = manager.useRunner();
+    await runner.beforeRestart();
 
     try {
-      await init(process.argv.slice(2));
+      await init(process.argv.slice(2), restartOptions);
     } catch (err) {
       console.error(err);
       hasGetError = true;

package/dist/js/node/initWatcher.js

@@ -25,7 +25,7 @@ const hashMap = new Map();
 
 const initWatcher = async (loaded, appDirectory, configDir, hooksRunner, argv) => {
   // only add fs watcher on dev mode.
-  if ((0, _utils.isDev)() && argv[0] === 'dev') {
+  if (((0, _utils.isDev)() || (0, _utils.isTest)()) && argv[0] === 'dev') {
     const extraFiles = await hooksRunner.watchFiles();
 
     const configPath = _path.default.join(appDirectory, configDir);
@@ -47,20 +47,36 @@ const initWatcher = async (loaded, appDirectory, configDir, hooksRunner, argv) =
         debug(`file change: %s`, changed);
         hashMap.set(changed, currentHash);
         hooksRunner.fileChange({
-          filename: changed
+          filename: changed,
+          eventType: 'change'
         });
       }
     });
+    watcher.on('add', name => {
+      debug(`add file: %s`, name);
+      const currentHash = md5(_fs.default.readFileSync(_path.default.join(appDirectory, name), 'utf8'));
+      hashMap.set(name, currentHash);
+      hooksRunner.fileChange({
+        filename: name,
+        eventType: 'add'
+      });
+    });
     watcher.on('unlink', name => {
       debug(`remove file: %s`, name);
 
       if (hashMap.has(name)) {
         hashMap.delete(name);
       }
+
+      hooksRunner.fileChange({
+        filename: name,
+        eventType: 'unlink'
+      });
     });
     watcher.on('error', err => {
       throw err;
     });
+    return watcher;
   }
 };
 

package/dist/js/node/loadPlugins.js

@@ -91,12 +91,13 @@ const loadPlugins = (appDirectory, pluginConfig, internalPlugins) => {
 
     const cliPlugin = cli && _objectSpread(_objectSpread({}, (0, _utils.compatRequire)(cli)), {}, {
       pluginPath: cli
-    });
+    }); // server plugin should be required by server
 
-    const serverPlugin = server && _objectSpread(_objectSpread({}, (0, _utils.compatRequire)(server)), {}, {
-      pluginPath: server
-    });
 
+    const serverPlugin = server && {
+      // ...compatRequire(server),
+      pluginPath: server
+    };
     return {
       cli: cliPlugin,
       cliPath: typeof plugin === 'string' ? plugin : plugin.cli,

package/dist/types/config/index.d.ts

@@ -80,8 +80,13 @@ interface DevConfig {
   assetPrefix?: string | boolean;
   https?: boolean;
 }
+interface MicroFrontend {
+  enableHtmlEntry?: boolean;
+  externalBasicLibrary?: boolean;
+  moduleApp?: boolean;
+}
 interface DeployConfig {
-  microFrontend?: boolean & Record<string, unknown>;
+  microFrontend?: boolean | MicroFrontend;
   domain?: string | Array<string>;
   domainByEntries?: Record<string, string | Array<string>>;
 }

package/dist/types/context.d.ts

@@ -12,8 +12,8 @@ export declare const initAppContext: (appDirectory: string, plugins: Array<{
   cli: any;
   server: any;
 }>, configFile: string | false, options?: {
+  metaName?: string | undefined;
   srcDir?: string | undefined;
   distDir?: string | undefined;
   sharedDir?: string | undefined;
-  internalDir?: string | undefined;
 } | undefined) => IAppContext;

package/dist/types/index.d.ts

@@ -21,6 +21,7 @@ export declare type HooksRunner = Progresses2Runners<{
   watchFiles: ParallelWorkflow<void>;
   fileChange: AsyncWorkflow<{
     filename: string;
+    eventType: 'add' | 'change' | 'unlink';
   }, void>;
   beforeExit: AsyncWorkflow<void, void>;
 }>;
@@ -37,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>;
@@ -53,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<{
@@ -68,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<{
@@ -83,8 +90,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>>;
 export declare const usePlugins: (plugins: string[]) => void;
 export { AppContext, ResolvedConfigContext, useAppContext, useConfigContext, useResolvedConfigContext, ConfigContext };

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.2",
+  "version": "1.4.0",
   "jsnext:source": "./src/index.ts",
   "types": "./dist/types/index.d.ts",
   "main": "./dist/js/node/index.js",
@@ -44,7 +44,7 @@
     "@babel/runtime": "^7",
     "@modern-js/load-config": "^1.2.1",
     "@modern-js/plugin": "^1.2.1",
-    "@modern-js/utils": "^1.2.2",
+    "@modern-js/utils": "^1.3.0",
     "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.1",
+    "@modern-js/types": "^1.3.0",
     "@types/jest": "^26",
     "@types/lodash.clonedeep": "^4.5.6",
     "@types/lodash.mergewith": "^4.6.6",

package/tests/context.test.ts

@@ -23,6 +23,10 @@ describe('context', () => {
       htmlTemplates: {},
       serverRoutes: [],
       entrypoints: [],
+      existSrc: true,
+      internalDirAlias: '@_modern_js_internal',
+      internalSrcAlias: '@_modern_js_src',
+      metaName: 'modern-js',
     });
   });
 
@@ -36,7 +40,7 @@ describe('context', () => {
       srcDir: 'source',
       distDir: 'dist',
       sharedDir: 'myShared',
-      internalDir: 'myInternal',
+      metaName: 'jupiter',
     };
 
     const appContext = initAppContext(appDirectory, [], false, customOptions);
@@ -50,14 +54,15 @@ describe('context', () => {
       distDirectory: 'dist',
       sharedDirectory: path.resolve(appDirectory, './myShared'),
       nodeModulesDirectory: expect.any(String),
-      internalDirectory: path.resolve(
-        appDirectory,
-        './node_modules/myInternal',
-      ),
+      internalDirectory: path.resolve(appDirectory, './node_modules/.jupiter'),
       plugins: [],
       htmlTemplates: {},
       serverRoutes: [],
       entrypoints: [],
+      existSrc: true,
+      internalDirAlias: '@_jupiter_internal',
+      internalSrcAlias: '@_jupiter_src',
+      metaName: 'jupiter',
     });
   });
 });

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',