@modern-js/app-tools 1.5.0 → 1.6.0

package/CHANGELOG.md

@@ -1,5 +1,44 @@
 # @modern-js/app-tools
 
+## 1.6.0
+
+### Minor Changes
+
+- 3bf4f8b0: feat: support start api server only
+
+### Patch Changes
+
+- 04ae5262: chore: bump @modern-js/utils to v1.4.1 in dependencies
+- 60f7d8bf: feat: add tests dir to npmignore
+- 5dbbeb57: fix: export extended Command type
+- 305e0bb4: fix: commander.commandsMap typing not work
+- Updated dependencies [a4330c73]
+- Updated dependencies [b8599d09]
+- Updated dependencies [6cffe99d]
+- Updated dependencies [04ae5262]
+- Updated dependencies [60f7d8bf]
+- Updated dependencies [e4cec1ce]
+- Updated dependencies [3b7aa8bb]
+- Updated dependencies [5dbbeb57]
+- Updated dependencies [ebfcbb35]
+- Updated dependencies [3bf4f8b0]
+- Updated dependencies [305e0bb4]
+- Updated dependencies [ebfcbb35]
+- Updated dependencies [28ac120a]
+  - @modern-js/core@1.8.0
+  - @modern-js/node-bundle-require@1.3.1
+  - @modern-js/utils@1.5.0
+  - @modern-js/i18n-cli-language-detector@1.2.2
+  - @modern-js/plugin-fast-refresh@1.2.4
+  - @modern-js/plugin-i18n@1.2.4
+  - @modern-js/webpack@1.5.5
+  - @modern-js/new-action@1.3.6
+  - @modern-js/prod-server@1.1.1
+  - @modern-js/server@1.4.10
+  - @modern-js/plugin@1.3.3
+  - @modern-js/types@1.5.0
+  - @modern-js/plugin-analyze@1.4.0
+
 ## 1.5.0
 
 ### Minor Changes

package/dist/js/modern/commands/build.js

@@ -18,17 +18,24 @@ export const build = async (api, options) => {
   const appContext = api.useAppContext();
   const hookRunners = api.useHookRunners();
   const {
-    existSrc
+    apiOnly
   } = appContext;
 
-  if (!existSrc) {
+  if (apiOnly) {
     const {
-      distDirectory
+      appDirectory,
+      distDirectory,
+      serverConfigFile
     } = appContext;
     await emptyDir(distDirectory);
     await hookRunners.beforeBuild({
       webpackConfigs: []
     });
+    await buildServerConfig({
+      appDirectory,
+      distDirectory,
+      configFile: serverConfigFile
+    });
     await generateRoutes(appContext);
     await hookRunners.afterBuild();
     return;

package/dist/js/modern/commands/dev.js

@@ -19,7 +19,7 @@ export const dev = async (api, options) => {
     appDirectory,
     distDirectory,
     port,
-    existSrc,
+    apiOnly,
     entrypoints,
     serverConfigFile
   } = appContext;
@@ -42,7 +42,7 @@ export const dev = async (api, options) => {
   await hookRunners.beforeDev();
   let compiler = null;
 
-  if (existSrc) {
+  if (!apiOnly) {
     const {
       getWebpackConfig,
       WebpackConfigTarget
@@ -86,11 +86,11 @@ export const dev = async (api, options) => {
       throw err;
     }
 
-    if (existSrc) {
-      clearConsole();
-      logger.log(chalk.cyan(`Starting the development server...`));
-    } else {
-      await printInstructions(hookRunners, appContext, userConfig);
+    if (apiOnly) {
+      return printInstructions(hookRunners, appContext, userConfig);
     }
+
+    clearConsole();
+    return logger.log(chalk.cyan(`Starting the development server...`));
   });
 };

package/dist/js/modern/commands/start.js

@@ -1,4 +1,4 @@
-import { logger, chalk } from '@modern-js/utils';
+import { logger, chalk, isApiOnly } from '@modern-js/utils';
 import server from '@modern-js/prod-server';
 import { printInstructions } from "../utils/printInstructions";
 export const start = async api => {
@@ -11,11 +11,13 @@ export const start = async api => {
     serverConfigFile
   } = appContext;
   logger.log(chalk.cyan(`Starting the modern server...`));
+  const apiOnly = await isApiOnly(appContext.appDirectory);
   const app = await server({
     pwd: appDirectory,
     config: userConfig,
     plugins: appContext.plugins.filter(p => p.server).map(p => p.server),
-    serverConfigFile
+    serverConfigFile,
+    apiOnly
   });
   app.listen(port, async err => {
     if (err) {

package/dist/js/modern/index.js

@@ -30,7 +30,7 @@ export default (() => ({
       commands({
         program
       }) {
-        program.command('dev').usage('[options]').description(i18n.t(localeKeys.command.dev.describe)).option('-c --config <config>', i18n.t(localeKeys.command.dev.config)).option('-e --entry [entry...]', i18n.t(localeKeys.command.dev.entry)).action(async options => {
+        program.command('dev').usage('[options]').description(i18n.t(localeKeys.command.dev.describe)).option('-c --config <config>', i18n.t(localeKeys.command.dev.config)).option('-e --entry [entry...]', i18n.t(localeKeys.command.dev.entry)).option('--api-only', i18n.t(localeKeys.command.dev.apiOnly)).action(async options => {
           await dev(api, options);
         });
         program.command('build').usage('[options]').description(i18n.t(localeKeys.command.build.describe)).option('--analyze', i18n.t(localeKeys.command.build.analyze)).action(async options => {
@@ -42,7 +42,7 @@ export default (() => ({
 
           process.exit(0);
         });
-        program.command('start').usage('[options]').description(i18n.t(localeKeys.command.start.describe)).action(async () => {
+        program.command('start').usage('[options]').description(i18n.t(localeKeys.command.start.describe)).option('--api-only', i18n.t(localeKeys.command.dev.apiOnly)).action(async () => {
           await start(api);
         });
         program.command('deploy').usage('[options]').description(i18n.t(localeKeys.command.deploy.describe)).action(async options => {

package/dist/js/modern/locale/en.js

@@ -3,7 +3,8 @@ export const EN_LOCALE = {
     dev: {
       describe: 'start dev server',
       config: 'specify config file',
-      entry: 'compiler by entry'
+      entry: 'compiler by entry',
+      apiOnly: 'start api server only'
     },
     build: {
       describe: 'build application',

package/dist/js/modern/locale/zh.js

@@ -3,7 +3,8 @@ export const ZH_LOCALE = {
     dev: {
       describe: '本地开发命令',
       config: '制定配置文件路径',
-      entry: '按入口编译'
+      entry: '按入口编译',
+      apiOnly: '仅启动 API 接口服务'
     },
     build: {
       describe: '构建应用命令',

package/dist/js/modern/utils/config.js

@@ -19,10 +19,11 @@ export const buildServerConfig = async ({
   const getOutputFile = filepath => path.resolve(distDirectory, `${filepath.replace(new RegExp(CONFIG_FILE_EXTENSIONS.join('|')), '')}.js`);
 
   if (configFilePath) {
-    const configHelperFilePath = path.join(distDirectory, './config-helper.js');
+    const configHelperFilePath = path.normalize(path.join(distDirectory, './config-helper.js'));
     const helperCode = `
       export const defineConfig = (config) => config;
     `;
+    await fs.ensureDir(distDirectory);
     await fs.writeFile(configHelperFilePath, helperCode);
     await bundle(configFilePath, _objectSpread(_objectSpread({}, options), {}, {
       getOutputFile,

package/dist/js/modern/utils/printInstructions.js

@@ -2,10 +2,10 @@ import { prettyInstructions, logger, isDev, chalk } from '@modern-js/utils';
 export const printInstructions = async (hookRunners, appContext, config) => {
   let message = prettyInstructions(appContext, config);
   const {
-    existSrc
+    apiOnly
   } = appContext;
 
-  if (isDev() && existSrc) {
+  if (isDev() && !apiOnly) {
     message += `\n${chalk.cyanBright([`Note that the development build is not optimized.`, `To create a production build, execute build command.`].join('\n'))}`;
   } // call beforePrintInstructions hook.
 

package/dist/js/node/commands/build.js

@@ -32,17 +32,24 @@ const build = async (api, options) => {
   const appContext = api.useAppContext();
   const hookRunners = api.useHookRunners();
   const {
-    existSrc
+    apiOnly
   } = appContext;
 
-  if (!existSrc) {
+  if (apiOnly) {
     const {
-      distDirectory
+      appDirectory,
+      distDirectory,
+      serverConfigFile
     } = appContext;
     await (0, _utils.emptyDir)(distDirectory);
     await hookRunners.beforeBuild({
       webpackConfigs: []
     });
+    await (0, _config.buildServerConfig)({
+      appDirectory,
+      distDirectory,
+      configFile: serverConfigFile
+    });
     await (0, _routes.generateRoutes)(appContext);
     await hookRunners.afterBuild();
     return;

package/dist/js/node/commands/dev.js

@@ -37,7 +37,7 @@ const dev = async (api, options) => {
     appDirectory,
     distDirectory,
     port,
-    existSrc,
+    apiOnly,
     entrypoints,
     serverConfigFile
   } = appContext;
@@ -62,7 +62,7 @@ const dev = async (api, options) => {
   await hookRunners.beforeDev();
   let compiler = null;
 
-  if (existSrc) {
+  if (!apiOnly) {
     const {
       getWebpackConfig,
       WebpackConfigTarget
@@ -106,13 +106,12 @@ const dev = async (api, options) => {
       throw err;
     }
 
-    if (existSrc) {
-      (0, _utils.clearConsole)();
-
-      _utils.logger.log(_utils.chalk.cyan(`Starting the development server...`));
-    } else {
-      await (0, _printInstructions.printInstructions)(hookRunners, appContext, userConfig);
+    if (apiOnly) {
+      return (0, _printInstructions.printInstructions)(hookRunners, appContext, userConfig);
     }
+
+    (0, _utils.clearConsole)();
+    return _utils.logger.log(_utils.chalk.cyan(`Starting the development server...`));
   });
 };
 

package/dist/js/node/commands/start.js

@@ -25,11 +25,13 @@ const start = async api => {
 
   _utils.logger.log(_utils.chalk.cyan(`Starting the modern server...`));
 
+  const apiOnly = await (0, _utils.isApiOnly)(appContext.appDirectory);
   const app = await (0, _prodServer.default)({
     pwd: appDirectory,
     config: userConfig,
     plugins: appContext.plugins.filter(p => p.server).map(p => p.server),
-    serverConfigFile
+    serverConfigFile,
+    apiOnly
   });
   app.listen(port, async err => {
     if (err) {

package/dist/js/node/index.js

@@ -61,7 +61,7 @@ var _default = () => ({
       commands({
         program
       }) {
-        program.command('dev').usage('[options]').description(_locale.i18n.t(_locale.localeKeys.command.dev.describe)).option('-c --config <config>', _locale.i18n.t(_locale.localeKeys.command.dev.config)).option('-e --entry [entry...]', _locale.i18n.t(_locale.localeKeys.command.dev.entry)).action(async options => {
+        program.command('dev').usage('[options]').description(_locale.i18n.t(_locale.localeKeys.command.dev.describe)).option('-c --config <config>', _locale.i18n.t(_locale.localeKeys.command.dev.config)).option('-e --entry [entry...]', _locale.i18n.t(_locale.localeKeys.command.dev.entry)).option('--api-only', _locale.i18n.t(_locale.localeKeys.command.dev.apiOnly)).action(async options => {
           await (0, _dev.dev)(api, options);
         });
         program.command('build').usage('[options]').description(_locale.i18n.t(_locale.localeKeys.command.build.describe)).option('--analyze', _locale.i18n.t(_locale.localeKeys.command.build.analyze)).action(async options => {
@@ -73,7 +73,7 @@ var _default = () => ({
 
           process.exit(0);
         });
-        program.command('start').usage('[options]').description(_locale.i18n.t(_locale.localeKeys.command.start.describe)).action(async () => {
+        program.command('start').usage('[options]').description(_locale.i18n.t(_locale.localeKeys.command.start.describe)).option('--api-only', _locale.i18n.t(_locale.localeKeys.command.dev.apiOnly)).action(async () => {
           await (0, _start.start)(api);
         });
         program.command('deploy').usage('[options]').description(_locale.i18n.t(_locale.localeKeys.command.deploy.describe)).action(async options => {

package/dist/js/node/locale/en.js

@@ -9,7 +9,8 @@ const EN_LOCALE = {
     dev: {
       describe: 'start dev server',
       config: 'specify config file',
-      entry: 'compiler by entry'
+      entry: 'compiler by entry',
+      apiOnly: 'start api server only'
     },
     build: {
       describe: 'build application',

package/dist/js/node/locale/zh.js

@@ -9,7 +9,8 @@ const ZH_LOCALE = {
     dev: {
       describe: '本地开发命令',
       config: '制定配置文件路径',
-      entry: '按入口编译'
+      entry: '按入口编译',
+      apiOnly: '仅启动 API 接口服务'
     },
     build: {
       describe: '构建应用命令',

package/dist/js/node/utils/config.js

@@ -36,10 +36,11 @@ const buildServerConfig = async ({
   const getOutputFile = filepath => path.resolve(distDirectory, `${filepath.replace(new RegExp(_utils.CONFIG_FILE_EXTENSIONS.join('|')), '')}.js`);
 
   if (configFilePath) {
-    const configHelperFilePath = path.join(distDirectory, './config-helper.js');
+    const configHelperFilePath = path.normalize(path.join(distDirectory, './config-helper.js'));
     const helperCode = `
       export const defineConfig = (config) => config;
     `;
+    await _utils.fs.ensureDir(distDirectory);
     await _utils.fs.writeFile(configHelperFilePath, helperCode);
     await (0, _nodeBundleRequire.bundle)(configFilePath, _objectSpread(_objectSpread({}, options), {}, {
       getOutputFile,

package/dist/js/node/utils/printInstructions.js

@@ -10,10 +10,10 @@ var _utils = require("@modern-js/utils");
 const printInstructions = async (hookRunners, appContext, config) => {
   let message = (0, _utils.prettyInstructions)(appContext, config);
   const {
-    existSrc
+    apiOnly
   } = appContext;
 
-  if ((0, _utils.isDev)() && existSrc) {
+  if ((0, _utils.isDev)() && !apiOnly) {
     message += `\n${_utils.chalk.cyanBright([`Note that the development build is not optimized.`, `To create a production build, execute build command.`].join('\n'))}`;
   } // call beforePrintInstructions hook.
 

package/dist/types/locale/en.d.ts

@@ -4,6 +4,7 @@ export declare const EN_LOCALE: {
       describe: string;
       config: string;
       entry: string;
+      apiOnly: string;
     };
     build: {
       describe: string;

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

@@ -6,6 +6,7 @@ declare const localeKeys: {
       describe: string;
       config: string;
       entry: string;
+      apiOnly: string;
     };
     build: {
       describe: string;
@@ -31,6 +32,7 @@ declare const localeKeys: {
       describe: string;
       config: string;
       entry: string;
+      apiOnly: string;
     };
     build: {
       describe: string;

package/dist/types/locale/zh.d.ts

@@ -4,6 +4,7 @@ export declare const ZH_LOCALE: {
       describe: string;
       config: string;
       entry: string;
+      apiOnly: string;
     };
     build: {
       describe: string;

package/dist/types/utils/types.d.ts

@@ -1,6 +1,10 @@
 export declare type DevOptions = {
   entry?: string[] | boolean;
+  apiOnly?: boolean;
 };
 export declare type BuildOptions = {
   analyze?: boolean;
+};
+export declare type StartOptions = {
+  apiOnly?: boolean;
 };

package/package.json

@@ -11,7 +11,7 @@
     "modern",
     "modern.js"
   ],
-  "version": "1.5.0",
+  "version": "1.6.0",
   "jsnext:source": "./src/index.ts",
   "types": "./dist/types/index.d.ts",
   "main": "./dist/js/node/index.js",
@@ -57,24 +57,24 @@
   },
   "dependencies": {
     "@babel/runtime": "^7",
-    "@modern-js/core": "^1.7.0",
-    "@modern-js/i18n-cli-language-detector": "^1.2.1",
-    "@modern-js/new-action": "^1.3.5",
-    "@modern-js/node-bundle-require": "^1.3.0",
-    "@modern-js/plugin": "^1.3.2",
-    "@modern-js/plugin-analyze": "^1.3.6",
-    "@modern-js/plugin-fast-refresh": "^1.2.3",
-    "@modern-js/plugin-i18n": "^1.2.3",
-    "@modern-js/prod-server": "^1.1.0",
-    "@modern-js/server": "^1.4.9",
-    "@modern-js/types": "^1.4.0",
-    "@modern-js/utils": "^1.4.0",
-    "@modern-js/webpack": "^1.5.4",
+    "@modern-js/core": "^1.8.0",
+    "@modern-js/i18n-cli-language-detector": "^1.2.2",
+    "@modern-js/new-action": "^1.3.6",
+    "@modern-js/node-bundle-require": "^1.3.1",
+    "@modern-js/plugin": "^1.3.3",
+    "@modern-js/plugin-analyze": "^1.4.0",
+    "@modern-js/plugin-fast-refresh": "^1.2.4",
+    "@modern-js/plugin-i18n": "^1.2.4",
+    "@modern-js/prod-server": "^1.1.1",
+    "@modern-js/server": "^1.4.10",
+    "@modern-js/types": "^1.5.0",
+    "@modern-js/utils": "^1.5.0",
+    "@modern-js/webpack": "^1.5.6",
     "inquirer": "^8.2.0",
     "webpack": "^5.71.0"
   },
   "devDependencies": {
-    "@modern-js/server-core": "^1.3.0",
+    "@modern-js/server-core": "^1.3.1",
     "@scripts/build": "0.0.0",
     "@scripts/jest-config": "0.0.0",
     "@types/inquirer": "^8.2.0",

package/tests/.eslintrc.js

@@ -1,8 +0,0 @@
-module.exports = {
-  root: true,
-  extends: ['@modern-js'],
-  parserOptions: {
-    tsconfigRootDir: __dirname,
-    project: ['./tsconfig.json'],
-  },
-};

package/tests/__snapshots__/utils.test.ts.snap

@@ -1,5 +0,0 @@
-// Jest Snapshot v1, https://goo.gl/fbAQLP
-
-exports[`test app-tools utils safeReplacer should handle circular object 1`] = `"{\\"name\\":\\"a\\",\\"b\\":{\\"name\\":\\"b\\",\\"a\\":\\"[Circular root]\\"}}"`;
-
-exports[`test app-tools utils safeReplacer should handle circular object 2`] = `"{\\"name\\":\\"c\\",\\"d\\":{\\"name\\":\\"d\\",\\"e\\":{\\"name\\":\\"e\\",\\"c\\":\\"[Circular root]\\"}}}"`;

package/tests/commands/build.test.ts

@@ -1,42 +0,0 @@
-import { manager } from '@modern-js/core';
-import { build } from '../../src/commands/build';
-
-const mockGenerateRoutes = jest.fn();
-
-jest.mock('../../src/utils/routes', () => ({
-  __esModule: true,
-  generateRoutes: () => mockGenerateRoutes(),
-}));
-
-describe('command build', () => {
-  afterAll(() => {
-    jest.resetAllMocks();
-  });
-
-  test('existSrc is false', 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({
-      async setup(api) {
-        await build(api);
-        expect(mockBeforeBuild).toBeCalled();
-        expect(mockGenerateRoutes).toBeCalled();
-        expect(mockAfterBuild).toBeCalled();
-      },
-    });
-    await cloned.init();
-  });
-});

package/tests/commands/dev.test.ts

@@ -1,7 +0,0 @@
-import { dev } from '../../src/commands/dev';
-
-describe('command', () => {
-  test('dev', () => {
-    expect(dev).toBeDefined();
-  });
-});

package/tests/index.test.ts

@@ -1,7 +0,0 @@
-import plugin from '../src';
-
-describe('app-tools', () => {
-  it('default', () => {
-    expect(plugin).toBeDefined();
-  });
-});

package/tests/routes.test.ts

@@ -1,27 +0,0 @@
-import { fs } from '@modern-js/utils';
-import { generateRoutes } from '../src/utils/routes';
-
-jest.mock('@modern-js/utils', () => {
-  const originalModule = jest.requireActual('@modern-js/utils');
-  return {
-    __esModule: true,
-    ...originalModule,
-    fs: {
-      outputFile: jest.fn((filename: string, output: string) => ({
-        filename,
-        output,
-      })),
-    },
-  };
-});
-
-describe('routes', () => {
-  test('generateRoutes', async () => {
-    const mockAppContext = {
-      serverRoutes: [],
-      distDirectory: './dist',
-    };
-    await generateRoutes(mockAppContext as any);
-    expect(fs.outputFile).toHaveBeenCalledTimes(1);
-  });
-});

package/tests/tsconfig.json

@@ -1,13 +0,0 @@
-{
-  "extends": "@modern-js/tsconfig/base",
-  "compilerOptions": {
-    "declaration": true,
-    "jsx": "preserve",
-    "baseUrl": "./",
-    "outDir": "./out",
-    "emitDeclarationOnly": true,
-    "isolatedModules": true,
-    "paths": {},
-    "types": ["node", "jest"]
-  }
-}

package/tests/utils.test.ts

@@ -1,112 +0,0 @@
-import inquirer from 'inquirer';
-import { Server } from '@modern-js/server';
-import {
-  closeServer,
-  createServer,
-  getServer,
-} from '../src/utils/createServer';
-import { getSpecifiedEntries } from '../src/utils/getSpecifiedEntries';
-import { safeReplacer } from '../src/utils/config';
-
-describe('test app-tools utils', () => {
-  it('should return all entryNames correctly', async () => {
-    const checked = await getSpecifiedEntries(false, [
-      { entryName: 'a' },
-      { entryName: 'b' },
-    ] as any);
-
-    expect(checked).toEqual(['a', 'b']);
-  });
-
-  it('should return spec entry', async () => {
-    const checked = await getSpecifiedEntries(['a'], [
-      { entryName: 'a' },
-      { entryName: 'b' },
-    ] as any);
-
-    expect(checked).toEqual(['a']);
-  });
-
-  it('should return select entry', async () => {
-    inquirer.prompt = jest.fn().mockResolvedValue({ selected: ['b'] }) as any;
-    const checked = await getSpecifiedEntries(true, [
-      { entryName: 'a' },
-      { entryName: 'b' },
-    ] as any);
-
-    expect(checked).toEqual(['b']);
-  });
-
-  it('should get error if entry not allow', resolve => {
-    getSpecifiedEntries(['c'], [
-      { entryName: 'a' },
-      { entryName: 'b' },
-    ] as any).catch(e => {
-      expect((e as Error).message).toMatch('can not found entry c');
-      resolve();
-    });
-  });
-
-  it('should create and close server correctly', async () => {
-    const app = await createServer({
-      dev: false,
-      pwd: '.',
-      config: {
-        output: {
-          path: 'dist',
-        },
-      },
-    } as any);
-
-    expect(app instanceof Server).toBe(true);
-    expect(getServer()).toBe(app);
-
-    await closeServer();
-    expect(getServer()).toBeNull();
-  });
-
-  it('safeReplacer should handle circular object', () => {
-    const a: {
-      [key: string]: unknown;
-    } = {
-      name: 'a',
-    };
-
-    const b: {
-      [key: string]: unknown;
-    } = {
-      name: 'b',
-    };
-
-    a.b = b;
-    b.a = a;
-
-    const res1 = JSON.stringify(a, safeReplacer());
-    expect(res1).toMatchSnapshot();
-
-    const c: {
-      [key: string]: unknown;
-    } = {
-      name: 'c',
-    };
-
-    const d: {
-      [key: string]: unknown;
-    } = {
-      name: 'd',
-    };
-
-    const e: {
-      [key: string]: unknown;
-    } = {
-      name: 'e',
-    };
-
-    c.d = d;
-    d.e = e;
-    e.c = c;
-
-    const res2 = JSON.stringify(c, safeReplacer());
-    expect(res2).toMatchSnapshot();
-  });
-});