@modern-js/module-tools 1.4.0 → 1.4.3

package/package.json

@@ -11,7 +11,7 @@
     "modern",
     "modern.js"
   ],
-  "version": "1.4.0",
+  "version": "1.4.3",
   "bin": {
     "modern": "./bin/modern.js"
   },
@@ -46,26 +46,25 @@
     }
   },
   "dependencies": {
+    "@modern-js/core": "^1.6.0",
     "@babel/generator": "^7.15.0",
     "@babel/parser": "^7.15.2",
     "@babel/runtime": "^7",
     "@babel/traverse": "^7.15.0",
-    "@babel/types": "^7.15.0",
-    "@modern-js/babel-compiler": "^1.2.1",
+    "@babel/types": "^7.17.0",
+    "@modern-js/babel-compiler": "^1.2.2",
     "@modern-js/babel-preset-module": "^1.3.1",
-    "@modern-js/core": "^1.4.2",
     "@modern-js/css-config": "^1.2.2",
     "@modern-js/i18n-cli-language-detector": "^1.2.1",
-    "@modern-js/module-tools-hooks": "^1.2.1",
-    "@modern-js/new-action": "^1.3.1",
-    "@modern-js/plugin-analyze": "^1.3.2",
-    "@modern-js/plugin-changeset": "^1.2.1",
-    "@modern-js/plugin-fast-refresh": "^1.2.1",
+    "@modern-js/module-tools-hooks": "^1.2.3",
+    "@modern-js/new-action": "^1.3.3",
+    "@modern-js/plugin-analyze": "^1.3.4",
+    "@modern-js/plugin-changeset": "^1.2.3",
+    "@modern-js/plugin-fast-refresh": "^1.2.2",
     "@modern-js/plugin-i18n": "^1.2.1",
     "@modern-js/style-compiler": "^1.2.2",
-    "@modern-js/utils": "^1.3.1",
+    "@modern-js/utils": "^1.3.6",
     "chalk": "^4.1.2",
-    "chokidar": "^3.5.2",
     "dotenv": "^10.0.0",
     "execa": "^5.1.1",
     "fast-glob": "^3.2.5",
@@ -77,7 +76,6 @@
     "normalize-path": "^3.0.0",
     "p-map": "^4",
     "process.argv": "^0.6.0",
-    "signale": "^1.4.0",
     "tsconfig-paths": "^3.10.1"
   },
   "devDependencies": {
@@ -92,11 +90,12 @@
     "@types/lodash.merge": "^4.6.6",
     "@types/node": "^14",
     "@types/normalize-path": "^3.0.0",
-    "@types/signale": "^1.4.2",
     "commander": "^8.1.0",
     "typescript": "^4",
     "@scripts/build": "0.0.0",
     "jest": "^27",
+    "@types/react": "^17",
+    "@types/react-dom": "^17",
     "@scripts/jest-config": "0.0.0"
   },
   "sideEffects": false,

package/tests/dev-cli.test.ts

@@ -1,3 +1,4 @@
+import { manager } from '@modern-js/core';
 import { program } from 'commander';
 import { devCli } from '../src/cli/dev';
 
@@ -11,15 +12,48 @@ describe('dev cli subCmd', () => {
       dev: mockCommandDev,
     }));
   });
-  it('should be storybook with "dev storybook"', () => {
-    devCli(program);
-    program.parse(['', '', 'dev', 'storybook']);
-    expect(mockCommandDev.mock.calls[0][1]).toBe('storybook');
+  it('should be storybook with "dev storybook"', async () => {
+    const mockAPI = {
+      useAppContext: jest.fn((): any => ({
+        existSrc: false,
+        distDirectory: '',
+      })),
+      useResolvedConfigContext: jest.fn(),
+      useHookRunners: (): any => ({}),
+    };
+    const cloned = manager.clone(mockAPI);
+    cloned.usePlugin({
+      setup(api) {
+        devCli(program, api);
+        program.parse(['', '', 'dev', 'storybook']);
+        expect(mockCommandDev.mock.calls[0][2]).toBe('storybook');
+      },
+    });
+    await cloned.init();
   });
 
-  it('should be undefined with "dev"', () => {
-    devCli(program);
-    program.parse(['', '', 'dev']);
-    expect(mockCommandDev.mock.calls[0][1]).toBe(undefined);
+  it('should be undefined with "dev"', async () => {
+    const mockBeforeBuild = jest.fn();
+    const mockAfterBuild = jest.fn();
+    const mockAPI = {
+      useAppContext: jest.fn((): any => ({
+        existSrc: false,
+        distDirectory: '',
+      })),
+      useResolvedConfigContext: jest.fn(),
+      useHookRunners: (): any => ({
+        afterBuild: mockAfterBuild,
+        beforeBuild: mockBeforeBuild,
+      }),
+    };
+    const cloned = manager.clone(mockAPI);
+    cloned.usePlugin({
+      setup(api) {
+        devCli(program, api);
+        program.parse(['', '', 'dev']);
+        expect(mockCommandDev.mock.calls[0][2]).toBe(undefined);
+      },
+    });
+    await cloned.init();
   });
 });

package/tests/dev-command.test.ts

@@ -1,3 +1,4 @@
+import { manager } from '@modern-js/core';
 import { dev } from '../src/commands/dev';
 
 const mockRunSubCmd = jest.fn();
@@ -6,11 +7,6 @@ jest.mock('../src/features/dev', () => ({
   runSubCmd: mockRunSubCmd,
   devStorybook: jest.fn(),
 }));
-jest.mock('@modern-js/core', () => ({
-  __esModule: true,
-  useAppContext: jest.fn(() => ({ appDirectory: '' })),
-  useResolvedConfigContext: jest.fn(),
-}));
 
 jest.mock('dotenv', () => ({
   __esModule: true,
@@ -32,13 +28,43 @@ describe('dev command with subCmd', () => {
     jest.clearAllMocks();
   });
   it('should call runSubCmd with storybook param', async () => {
-    await dev({ tsconfig: 'tsconfig.json' }, 'storybook');
-    expect(mockRunSubCmd.mock.calls.length).toBe(1);
-    expect(mockRunSubCmd.mock.calls[0][0]).toBe('storybook');
+    const mockAPI = {
+      useAppContext: jest.fn((): any => ({
+        existSrc: false,
+        distDirectory: '',
+        appDirectory: '',
+      })),
+      useResolvedConfigContext: jest.fn(),
+    };
+
+    const cloned = manager.clone(mockAPI);
+    cloned.usePlugin({
+      async setup(api) {
+        await dev(api, { tsconfig: 'tsconfig.json' }, 'storybook');
+        expect(mockRunSubCmd.mock.calls.length).toBe(1);
+        expect(mockRunSubCmd.mock.calls[0][1]).toBe('storybook');
+      },
+    });
+    await cloned.init();
   });
 
   it('should not call runSubCmd with nothing param', async () => {
-    await dev({ tsconfig: 'tsconfig.json' });
-    expect(mockRunSubCmd.mock.calls.length).toBe(0);
+    const mockAPI = {
+      useAppContext: jest.fn((): any => ({
+        existSrc: false,
+        distDirectory: '',
+        appDirectory: '',
+      })),
+      useResolvedConfigContext: jest.fn(),
+    };
+
+    const cloned = manager.clone(mockAPI);
+    cloned.usePlugin({
+      async setup(api) {
+        await dev(api, { tsconfig: 'tsconfig.json' });
+        expect(mockRunSubCmd.mock.calls.length).toBe(0);
+      },
+    });
+    await cloned.init();
   });
 });

package/tests/dev-feature.test.ts

@@ -1,14 +1,16 @@
+import { manager } from '@modern-js/core';
 import { runSubCmd } from '../src/features/dev';
 
 const mockModuleToolsMenu = jest.fn();
 const mockDevMeta = jest.fn();
 const exit = jest.spyOn(process, 'exit').mockImplementation();
-jest.mock('@modern-js/core', () => ({
-  __esModule: true,
-  mountHook: jest.fn(() => ({
+const mockAPI = {
+  useAppContext: jest.fn((): any => ({})),
+  useResolvedConfigContext: jest.fn(),
+  useHookRunners: (): any => ({
     moduleToolsMenu: mockModuleToolsMenu,
-  })),
-}));
+  }),
+};
 
 describe('dev feature with subCmd', () => {
   beforeEach(() => {
@@ -18,29 +20,59 @@ describe('dev feature with subCmd', () => {
     mockModuleToolsMenu.mockReturnValue([
       { value: 'storybook', runTask: mockDevMeta },
     ]);
-    await runSubCmd('storybook', { isTsProject: true, appDirectory: '' });
-    expect(mockDevMeta.mock.calls.length).toBe(1);
+    const cloned = manager.clone(mockAPI);
+    cloned.usePlugin({
+      async setup(api) {
+        await runSubCmd(api, 'storybook', {
+          isTsProject: true,
+          appDirectory: '',
+        });
+        expect(mockDevMeta.mock.calls.length).toBe(1);
+      },
+    });
+    await cloned.init();
   });
 
   it('should run task with "storybook" params when storybook plugin not exist', async () => {
     mockModuleToolsMenu.mockReturnValue([]);
-    await runSubCmd('storybook', { isTsProject: true, appDirectory: '' });
-    expect(exit).toHaveBeenCalled();
+    const cloned = manager.clone(mockAPI);
+    cloned.usePlugin({
+      async setup(api) {
+        await runSubCmd(api, 'storybook', {
+          isTsProject: true,
+          appDirectory: '',
+        });
+        expect(exit).toHaveBeenCalled();
+      },
+    });
+    await cloned.init();
   });
 
   it('should run task with alias name "story" params when storybook plugin exist', async () => {
     mockModuleToolsMenu.mockReturnValue([
       { value: 'storybook', aliasValues: ['story'], runTask: mockDevMeta },
     ]);
-    await runSubCmd('story', { isTsProject: true, appDirectory: '' });
-    expect(mockDevMeta.mock.calls.length).toBe(1);
+    const cloned = manager.clone(mockAPI);
+    cloned.usePlugin({
+      async setup(api) {
+        await runSubCmd(api, 'story', { isTsProject: true, appDirectory: '' });
+        expect(mockDevMeta.mock.calls.length).toBe(1);
+      },
+    });
+    await cloned.init();
   });
 
   it('should run task with alias name "story1" params when storybook plugin exist', async () => {
     mockModuleToolsMenu.mockReturnValue([
       { value: 'storybook', aliasValues: ['story'], runTask: mockDevMeta },
     ]);
-    await runSubCmd('story1', { isTsProject: true, appDirectory: '' });
-    expect(mockDevMeta.mock.calls.length).toBe(0);
+    const cloned = manager.clone(mockAPI);
+    cloned.usePlugin({
+      async setup(api) {
+        await runSubCmd(api, 'story1', { isTsProject: true, appDirectory: '' });
+        expect(mockDevMeta.mock.calls.length).toBe(0);
+      },
+    });
+    await cloned.init();
   });
 });

package/tests/generator-dts-utils.test.ts

@@ -0,0 +1,10 @@
+import * as path from 'path';
+import { generatorTsConfig } from '../src/tasks/generator-dts/utils';
+
+describe('test generator dts utils', () => {
+  it('test generatorTsConfig', () => {
+    const appDir = path.join(__dirname, './fixtures/tsconfig');
+    const ret = generatorTsConfig({}, { appDirectory: appDir, distDir: '' });
+    expect(ret).toContain('tsconfig.temp.json');
+  });
+});

package/tests/generator-dts.test.ts

@@ -0,0 +1,48 @@
+jest.mock('@modern-js/core', () => ({
+  manager: {
+    run: async (fn: any) => {
+      await fn();
+    },
+  },
+  cli: {
+    init: () => ({}),
+  },
+}));
+jest.mock('process.argv', () => () => (o: any) => ({ ...o, tsCheck: false }));
+jest.mock('execa', () => () => {
+  // eslint-disable-next-line prefer-promise-reject-errors
+  const fn = Promise.reject('error');
+  (fn as any).stdout = {
+    on: () => 0,
+  };
+  (fn as any).stderr = {
+    on: () => 0,
+  };
+  return fn;
+});
+jest.mock('../src/tasks/generator-dts/utils');
+jest.mock('@modern-js/utils', () => {
+  const originalModule = jest.requireActual('@modern-js/utils');
+  return {
+    __esModule: true, // Use it when dealing with esModules
+    ...originalModule,
+    fs: {
+      ...originalModule.fs,
+      removeSync: jest.fn(),
+    },
+  };
+});
+process.argv = [];
+
+describe('generator dts test', () => {
+  it('test tsCheck is true', () => {
+    console.info = jest.fn(str => {
+      expect(str).toBe(
+        "There are some type warnings, which can be checked by configuring 'output.disableTsChecker = false'",
+      );
+    });
+    require('../src/tasks/generator-dts');
+  });
+});
+
+export {};

package/dist/js/modern/tasks/generator-dts.js

@@ -1,226 +0,0 @@
-function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
-
-function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { _defineProperty(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
-
-function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
-
-import * as path from 'path';
-import * as os from 'os';
-import { Import, fs } from '@modern-js/utils';
-const tsPathsTransform = Import.lazy('../utils/tspaths-transform', require);
-const babel = Import.lazy('../utils/babel', require);
-const constants = Import.lazy('./constants', require);
-const core = Import.lazy('@modern-js/core', require);
-const execa = Import.lazy('execa', require);
-const JSON5 = Import.lazy('json5', require);
-const argv = Import.lazy('process.argv', require);
-const deepMerge = Import.lazy('lodash.merge', require);
-const glob = Import.lazy('glob', require);
-let removeTsconfigPath = '';
-
-const generatorTsConfig = (projectTsconfig, {
-  appDirectory,
-  distDir,
-  sourceDir: _sourceDir = 'src'
-}) => {
-  var _projectTsconfig$comp, _projectTsconfig$comp2, _projectTsconfig$incl, _projectTsconfig$excl;
-
-  const tempPath = path.resolve(appDirectory, './node_modules');
-  const resolvePath = path.relative(tempPath, appDirectory); // const rootDir = projectTsconfig.compilerOptions?.rootDir
-  //   ? path.join(resolvePath, projectTsconfig.compilerOptions?.rootDir)
-  //   : resolvePath;
-  // 目前限制 rootDir 的路径为 sourceDir
-
-  const rootDir = path.join(resolvePath, _sourceDir);
-  const baseUrl = (_projectTsconfig$comp = projectTsconfig.compilerOptions) !== null && _projectTsconfig$comp !== void 0 && _projectTsconfig$comp.baseUrl ? path.join(appDirectory, (_projectTsconfig$comp2 = projectTsconfig.compilerOptions) === null || _projectTsconfig$comp2 === void 0 ? void 0 : _projectTsconfig$comp2.baseUrl) : appDirectory; // if include = ['src'], final include should be ['../src']
-
-  const include = (_projectTsconfig$incl = projectTsconfig.include) === null || _projectTsconfig$incl === void 0 ? void 0 : _projectTsconfig$incl.map(includePath => path.join(resolvePath, includePath));
-  const exclude = (_projectTsconfig$excl = projectTsconfig.exclude) === null || _projectTsconfig$excl === void 0 ? void 0 : _projectTsconfig$excl.map(excludePath => path.join(resolvePath, excludePath));
-  const resetConfig = {
-    compilerOptions: {
-      rootDir,
-      baseUrl,
-      // Ensure that .d.ts files are created by tsc, but not .js files
-      declaration: true,
-      emitDeclarationOnly: true,
-      outDir: distDir
-    },
-    include,
-    exclude
-  };
-  const recommendOption = {
-    // Ensure that Babel can safely transpile files in the TypeScript project
-    compilerOptions: {
-      isolatedModules: true
-    }
-  };
-  const tempTsconfigPath = path.join(tempPath, constants.tempTsconfigName);
-  fs.ensureFileSync(tempTsconfigPath);
-  fs.writeJSONSync(tempTsconfigPath, deepMerge(recommendOption, projectTsconfig, // 此处是必须要覆盖用户默认配置
-  resetConfig));
-  return tempTsconfigPath;
-};
-
-const getProjectTsconfig = tsconfigPath => {
-  if (!tsconfigPath || !fs.existsSync(tsconfigPath)) {
-    return {};
-  }
-
-  return JSON5.parse(fs.readFileSync(tsconfigPath, 'utf-8'));
-};
-
-const resolveLog = (childProgress, {
-  tsCheck: _tsCheck = false,
-  watch: _watch = false
-} = {}) => {
-  var _childProgress$stdout, _childProgress$stdout2, _childProgress$stderr;
-
-  /**
-   * tsc 所有的log信息都是从stdout data 事件中获取
-   * 正常模式下，如果有报错信息，交给 resolveLog 后面的逻辑来处理
-   * watch 模式下，则使用这里的信息
-   */
-  (_childProgress$stdout = childProgress.stdout) === null || _childProgress$stdout === void 0 ? void 0 : _childProgress$stdout.on('data', data => {
-    if (!_tsCheck) {
-      return;
-    }
-
-    if (_watch) {
-      console.info(data.toString());
-    }
-  }); // 正常以下内容都不会触发，因为tsc 不会产生以下类型的log信息，不过防止意外情况
-
-  (_childProgress$stdout2 = childProgress.stdout) === null || _childProgress$stdout2 === void 0 ? void 0 : _childProgress$stdout2.on('error', error => {
-    console.error(error.message);
-  });
-  (_childProgress$stderr = childProgress.stderr) === null || _childProgress$stderr === void 0 ? void 0 : _childProgress$stderr.on('data', chunk => {
-    console.error(chunk.toString());
-  });
-};
-
-const generatorDts = async (_, config) => {
-  const {
-    tsconfigPath,
-    distDir,
-    sourceDirName = 'src',
-    projectData: {
-      appDirectory
-    },
-    tsCheck = false,
-    watch = false
-  } = config;
-  const userTsconfig = getProjectTsconfig(tsconfigPath);
-  const willDeleteTsconfigPath = generatorTsConfig(userTsconfig, {
-    appDirectory,
-    distDir,
-    sourceDir: sourceDirName
-  });
-  removeTsconfigPath = willDeleteTsconfigPath;
-  const tscBinFile = path.join(appDirectory, './node_modules/.bin/tsc');
-  const watchParams = watch ? ['-w'] : [];
-  const childProgress = execa(tscBinFile, ['-p', willDeleteTsconfigPath, ...watchParams], {
-    stdio: 'pipe',
-    cwd: appDirectory
-  });
-  resolveLog(childProgress, {
-    tsCheck,
-    watch
-  });
-
-  try {
-    await childProgress;
-    console.info('[Tsc Compiler]: Successfully');
-  } catch (e) {
-    if (!tsCheck) {
-      console.warn(`There are some type issues, which can be checked by configuring 'source.enableTsChecker = true' ${os.EOL} in modern.config.js`);
-    } else {
-      const isRecord = input => typeof input === 'object'; // 通过使用 execa，可以将tsc 的 data 类型的报错信息变为异常错误信息
-
-
-      if (isRecord(e)) {
-        console.error(e.stdout);
-      }
-    }
-  }
-
-  fs.removeSync(willDeleteTsconfigPath);
-};
-
-const resolveAlias = (modernConfig, config, watchFilenames = []) => {
-  const {
-    output
-  } = modernConfig;
-  const defaultPaths = {
-    '@': ['./src']
-  };
-  const dtsDistPath = `${config.distDir}/**/*.d.ts`;
-  const dtsFilenames = watchFilenames.length > 0 ? watchFilenames : glob.sync(dtsDistPath, {
-    absolute: true
-  });
-  const alias = babel.getFinalAlias(modernConfig, {
-    appDirectory: config.projectData.appDirectory,
-    tsconfigPath: config.tsconfigPath || path.join(config.projectData.appDirectory, './tsconfig.json'),
-    sourceAbsDir: config.distDir
-  });
-  const mergedPaths = alias.isTsPath ? alias.paths || {} : _objectSpread(_objectSpread({}, defaultPaths), alias.paths || {});
-  const result = tsPathsTransform.transformDtsAlias({
-    filenames: dtsFilenames,
-    baseUrl: path.join(config.projectData.appDirectory, output.path || 'dist'),
-    paths: mergedPaths
-  });
-
-  for (const r of result) {
-    fs.writeFileSync(r.path, r.content);
-  }
-};
-
-const taskMain = async ({
-  modernConfig
-}) => {
-  const processArgv = argv(process.argv.slice(2));
-  const config = processArgv({
-    appDirectory: process.cwd(),
-    srcDir: 'src',
-    distDir: 'dist/types',
-    tsconfigPath: './tsconfig.json',
-    sourceDirName: 'src'
-  });
-  const option = {
-    srcDir: config.srcDir,
-    distDir: config.distDir,
-    projectData: {
-      appDirectory: config.appDirectory
-    },
-    tsconfigPath: config.tsconfigPath,
-    watch: config.watch,
-    tsCheck: config.tsCheck,
-    sourceDirName: config.sourceDirName
-  };
-  await generatorDts(modernConfig, option); // TODO: watch 模式下无法转换
-
-  resolveAlias(modernConfig, option);
-};
-
-(async () => {
-  let options;
-
-  if (process.env.CORE_INIT_OPTION_FILE) {
-    ({
-      options
-    } = require(process.env.CORE_INIT_OPTION_FILE));
-  }
-
-  const {
-    resolved
-  } = await core.cli.init([], options);
-  await core.manager.run(async () => {
-    try {
-      await taskMain({
-        modernConfig: resolved
-      });
-    } catch (e) {
-      console.error(e.message);
-      fs.removeSync(removeTsconfigPath);
-    }
-  });
-})();