@modern-js/app-tools 1.3.2 → 1.4.0

package/CHANGELOG.md

@@ -1,5 +1,34 @@
 # @modern-js/app-tools
 
+## 1.4.0
+
+### Minor Changes
+
+- ec4dbffb: feat: support as a pure api service
+
+### Patch Changes
+
+- bd819a8d: fix: file route changed not trigger hot reload
+- 62cd58c6: fix: create route.json failure
+- d099e5c5: fix error when modify modern.config.js
+- Updated dependencies [816fd721]
+- Updated dependencies [d9cc5ea9]
+- Updated dependencies [ddf0c3a6]
+- Updated dependencies [bfbea9a7]
+- Updated dependencies [bd819a8d]
+- Updated dependencies [ec4dbffb]
+- Updated dependencies [d099e5c5]
+- Updated dependencies [bada2879]
+- Updated dependencies [24f616ca]
+- Updated dependencies [bd819a8d]
+- Updated dependencies [272cab15]
+  - @modern-js/server@1.4.0
+  - @modern-js/types@1.3.0
+  - @modern-js/core@1.4.0
+  - @modern-js/plugin-analyze@1.3.0
+  - @modern-js/webpack@1.3.0
+  - @modern-js/utils@1.3.0
+
 ## 1.3.2
 
 ### Patch Changes

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

@@ -7,11 +7,30 @@ function _defineProperty(obj, key, value) { if (key in obj) { Object.definePrope
 import { webpack } from 'webpack';
 import { WebpackConfigTarget, getWebpackConfig } from '@modern-js/webpack';
 import { useAppContext, useResolvedConfigContext, mountHook, ResolvedConfigContext, manager } from '@modern-js/core';
-import { fs, formatWebpackMessages, measureFileSizesBeforeBuild, printFileSizesAfterBuild, printBuildError, logger, isUseSSRBundle } from '@modern-js/utils'; // These sizes are pretty large. We'll warn for bundles exceeding them.
+import { fs, formatWebpackMessages, measureFileSizesBeforeBuild, printFileSizesAfterBuild, printBuildError, logger, isUseSSRBundle } from '@modern-js/utils';
+import { generateRoutes } from "../utils/routes"; // These sizes are pretty large. We'll warn for bundles exceeding them.
 
 const WARN_AFTER_BUNDLE_GZIP_SIZE = 512 * 1024;
 const WARN_AFTER_CHUNK_GZIP_SIZE = 1024 * 1024;
+// eslint-disable-next-line max-statements
 export const build = async options => {
+  /* eslint-disable react-hooks/rules-of-hooks */
+  const resolvedConfig = useResolvedConfigContext();
+  const appContext = useAppContext();
+  const {
+    existSrc
+  } = appContext;
+  /* eslint-enable react-hooks/rules-of-hooks */
+
+  if (!existSrc) {
+    await mountHook().beforeBuild({
+      webpackConfigs: []
+    });
+    await generateRoutes(appContext);
+    await mountHook().afterBuild();
+    return;
+  }
+
   const webpackBuild = async (webpackConfig, type) => {
     const compiler = webpack(webpackConfig);
     return new Promise((resolve, reject) => {
@@ -62,12 +81,6 @@ export const build = async options => {
       });
     });
   };
-  /* eslint-disable react-hooks/rules-of-hooks */
-
-
-  const resolvedConfig = useResolvedConfigContext();
-  const appContext = useAppContext();
-  /* eslint-enable react-hooks/rules-of-hooks */
 
   manager.run(() => {
     ResolvedConfigContext.set(_objectSpread(_objectSpread({}, resolvedConfig), {}, {
@@ -112,9 +125,12 @@ export const build = async options => {
     try {
       await webpackBuild(config, buildType);
     } catch (error) {
-      printBuildError(error);
+      printBuildError(error); // eslint-disable-next-line no-process-exit
+
+      process.exit(1);
     }
   }
 
+  await generateRoutes(appContext);
   await mountHook().afterBuild();
 };

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

@@ -9,6 +9,8 @@ import { fs, logger, HMR_SOCK_PATH, clearConsole, chalk, isSSR } from '@modern-j
 import { useAppContext, useResolvedConfigContext, mountHook } from '@modern-js/core';
 import { createCompiler } from "../utils/createCompiler";
 import { createServer } from "../utils/createServer";
+import { generateRoutes } from "../utils/routes";
+import { printInstructions } from "../utils/printInstructions";
 export const dev = async () => {
   /* eslint-disable react-hooks/rules-of-hooks */
   const appContext = useAppContext();
@@ -18,16 +20,23 @@ export const dev = async () => {
   const {
     appDirectory,
     distDirectory,
-    port
+    port,
+    existSrc
   } = appContext;
   fs.emptyDirSync(distDirectory);
   await mountHook().beforeDev();
-  const webpackConfigs = [isSSR(userConfig) && getWebpackConfig(WebpackConfigTarget.NODE), getWebpackConfig(WebpackConfigTarget.CLIENT)].filter(Boolean);
-  const compiler = await createCompiler({
-    webpackConfigs,
-    userConfig,
-    appContext
-  });
+  let compiler = null;
+
+  if (existSrc) {
+    const webpackConfigs = [isSSR(userConfig) && getWebpackConfig(WebpackConfigTarget.NODE), getWebpackConfig(WebpackConfigTarget.CLIENT)].filter(Boolean);
+    compiler = await createCompiler({
+      webpackConfigs,
+      userConfig,
+      appContext
+    });
+  }
+
+  await generateRoutes(appContext);
   const app = await createServer({
     dev: _objectSpread(_objectSpread({}, {
       client: {
@@ -50,12 +59,16 @@ export const dev = async () => {
     config: userConfig,
     plugins: appContext.plugins.filter(p => p.server).map(p => p.server)
   });
-  app.listen(port, err => {
+  app.listen(port, async err => {
     if (err) {
       throw err;
     }
 
-    clearConsole();
-    logger.log(chalk.cyan(`Starting the development server...`));
+    if (existSrc) {
+      clearConsole();
+      logger.log(chalk.cyan(`Starting the development server...`));
+    } else {
+      await printInstructions(appContext, userConfig);
+    }
   });
 };

package/dist/js/modern/index.js

@@ -4,7 +4,9 @@ function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { va
 
 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 { createPlugin, defineConfig, usePlugins, cli } from '@modern-js/core';
+import * as path from 'path';
+import { createPlugin, defineConfig, usePlugins, cli, useAppContext } from '@modern-js/core';
+import { cleanRequireCache } from '@modern-js/utils';
 import { lifecycle } from "./lifecycle";
 import { i18n, localeKeys } from "./locale";
 import { getLocaleLanguage } from "./utils/language";
@@ -60,11 +62,31 @@ export default createPlugin(() => {
       });
     },
 
-    async fileChange() {
-      await cli.restart();
+    // 这里会被 core/initWatcher 监听的文件变动触发，如果是 src 目录下的文件变动，则不做 restart
+    async fileChange(e) {
+      const {
+        filename,
+        eventType
+      } = e; // eslint-disable-next-line react-hooks/rules-of-hooks
+
+      const appContext = useAppContext();
+      const {
+        appDirectory,
+        srcDirectory
+      } = appContext;
+      const absolutePath = path.resolve(appDirectory, filename);
+
+      if (!absolutePath.includes(srcDirectory) && (eventType === 'change' || eventType === 'unlink')) {
+        await cli.restart();
+      }
+    },
+
+    async beforeRestart() {
+      cleanRequireCache([require.resolve('@modern-js/plugin-analyze/cli'), require.resolve('@modern-js/plugin-fast-refresh/cli')]);
     }
 
   };
 }, {
+  name: '@modern-js/app-tools',
   post: ['@modern-js/plugin-analyze', '@modern-js/plugin-fast-refresh', '@modern-js/plugin-ssr', '@modern-js/plugin-state', '@modern-js/plugin-router', '@modern-js/plugin-polyfill']
 });

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

@@ -2,8 +2,11 @@ import { prettyInstructions, logger, isDev, chalk } from '@modern-js/utils';
 import { mountHook } from '@modern-js/core';
 export const printInstructions = async (appContext, config) => {
   let message = prettyInstructions(appContext, config);
+  const {
+    existSrc
+  } = appContext;
 
-  if (isDev()) {
+  if (isDev() && existSrc) {
     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/modern/utils/routes.js

@@ -0,0 +1,15 @@
+import path from 'path';
+import { fs, ROUTE_SPEC_FILE } from '@modern-js/utils';
+
+const generateRoutes = async appContext => {
+  const {
+    serverRoutes,
+    distDirectory
+  } = appContext;
+  const output = JSON.stringify({
+    routes: serverRoutes
+  }, null, 2);
+  await fs.outputFile(path.join(distDirectory, ROUTE_SPEC_FILE), output);
+};
+
+export { generateRoutes };

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

@@ -13,6 +13,8 @@ var _core = require("@modern-js/core");
 
 var _utils = require("@modern-js/utils");
 
+var _routes = require("../utils/routes");
+
 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; }
@@ -23,7 +25,25 @@ function _defineProperty(obj, key, value) { if (key in obj) { Object.definePrope
 const WARN_AFTER_BUNDLE_GZIP_SIZE = 512 * 1024;
 const WARN_AFTER_CHUNK_GZIP_SIZE = 1024 * 1024;
 
+// eslint-disable-next-line max-statements
 const build = async options => {
+  /* eslint-disable react-hooks/rules-of-hooks */
+  const resolvedConfig = (0, _core.useResolvedConfigContext)();
+  const appContext = (0, _core.useAppContext)();
+  const {
+    existSrc
+  } = appContext;
+  /* eslint-enable react-hooks/rules-of-hooks */
+
+  if (!existSrc) {
+    await (0, _core.mountHook)().beforeBuild({
+      webpackConfigs: []
+    });
+    await (0, _routes.generateRoutes)(appContext);
+    await (0, _core.mountHook)().afterBuild();
+    return;
+  }
+
   const webpackBuild = async (webpackConfig, type) => {
     const compiler = (0, _webpack.webpack)(webpackConfig);
     return new Promise((resolve, reject) => {
@@ -77,12 +97,6 @@ const build = async options => {
       });
     });
   };
-  /* eslint-disable react-hooks/rules-of-hooks */
-
-
-  const resolvedConfig = (0, _core.useResolvedConfigContext)();
-  const appContext = (0, _core.useAppContext)();
-  /* eslint-enable react-hooks/rules-of-hooks */
 
   _core.manager.run(() => {
     _core.ResolvedConfigContext.set(_objectSpread(_objectSpread({}, resolvedConfig), {}, {
@@ -130,10 +144,13 @@ const build = async options => {
     try {
       await webpackBuild(config, buildType);
     } catch (error) {
-      (0, _utils.printBuildError)(error);
+      (0, _utils.printBuildError)(error); // eslint-disable-next-line no-process-exit
+
+      process.exit(1);
     }
   }
 
+  await (0, _routes.generateRoutes)(appContext);
   await (0, _core.mountHook)().afterBuild();
 };
 

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

@@ -15,6 +15,10 @@ var _createCompiler = require("../utils/createCompiler");
 
 var _createServer = require("../utils/createServer");
 
+var _routes = require("../utils/routes");
+
+var _printInstructions = require("../utils/printInstructions");
+
 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; }
@@ -30,18 +34,25 @@ const dev = async () => {
   const {
     appDirectory,
     distDirectory,
-    port
+    port,
+    existSrc
   } = appContext;
 
   _utils.fs.emptyDirSync(distDirectory);
 
   await (0, _core.mountHook)().beforeDev();
-  const webpackConfigs = [(0, _utils.isSSR)(userConfig) && (0, _webpack.getWebpackConfig)(_webpack.WebpackConfigTarget.NODE), (0, _webpack.getWebpackConfig)(_webpack.WebpackConfigTarget.CLIENT)].filter(Boolean);
-  const compiler = await (0, _createCompiler.createCompiler)({
-    webpackConfigs,
-    userConfig,
-    appContext
-  });
+  let compiler = null;
+
+  if (existSrc) {
+    const webpackConfigs = [(0, _utils.isSSR)(userConfig) && (0, _webpack.getWebpackConfig)(_webpack.WebpackConfigTarget.NODE), (0, _webpack.getWebpackConfig)(_webpack.WebpackConfigTarget.CLIENT)].filter(Boolean);
+    compiler = await (0, _createCompiler.createCompiler)({
+      webpackConfigs,
+      userConfig,
+      appContext
+    });
+  }
+
+  await (0, _routes.generateRoutes)(appContext);
   const app = await (0, _createServer.createServer)({
     dev: _objectSpread(_objectSpread({}, {
       client: {
@@ -64,14 +75,18 @@ const dev = async () => {
     config: userConfig,
     plugins: appContext.plugins.filter(p => p.server).map(p => p.server)
   });
-  app.listen(port, err => {
+  app.listen(port, async err => {
     if (err) {
       throw err;
     }
 
-    (0, _utils.clearConsole)();
+    if (existSrc) {
+      (0, _utils.clearConsole)();
 
-    _utils.logger.log(_utils.chalk.cyan(`Starting the development server...`));
+      _utils.logger.log(_utils.chalk.cyan(`Starting the development server...`));
+    } else {
+      await (0, _printInstructions.printInstructions)(appContext, userConfig);
+    }
   });
 };
 

package/dist/js/node/index.js

@@ -11,8 +11,12 @@ Object.defineProperty(exports, "defineConfig", {
   }
 });
 
+var path = _interopRequireWildcard(require("path"));
+
 var _core = require("@modern-js/core");
 
+var _utils = require("@modern-js/utils");
+
 var _lifecycle = require("./lifecycle");
 
 var _locale = require("./locale");
@@ -85,12 +89,32 @@ var _default = (0, _core.createPlugin)(() => {
       });
     },
 
-    async fileChange() {
-      await _core.cli.restart();
+    // 这里会被 core/initWatcher 监听的文件变动触发，如果是 src 目录下的文件变动，则不做 restart
+    async fileChange(e) {
+      const {
+        filename,
+        eventType
+      } = e; // eslint-disable-next-line react-hooks/rules-of-hooks
+
+      const appContext = (0, _core.useAppContext)();
+      const {
+        appDirectory,
+        srcDirectory
+      } = appContext;
+      const absolutePath = path.resolve(appDirectory, filename);
+
+      if (!absolutePath.includes(srcDirectory) && (eventType === 'change' || eventType === 'unlink')) {
+        await _core.cli.restart();
+      }
+    },
+
+    async beforeRestart() {
+      (0, _utils.cleanRequireCache)([require.resolve('@modern-js/plugin-analyze/cli'), require.resolve('@modern-js/plugin-fast-refresh/cli')]);
     }
 
   };
 }, {
+  name: '@modern-js/app-tools',
   post: ['@modern-js/plugin-analyze', '@modern-js/plugin-fast-refresh', '@modern-js/plugin-ssr', '@modern-js/plugin-state', '@modern-js/plugin-router', '@modern-js/plugin-polyfill']
 });
 

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

@@ -11,8 +11,11 @@ var _core = require("@modern-js/core");
 
 const printInstructions = async (appContext, config) => {
   let message = (0, _utils.prettyInstructions)(appContext, config);
+  const {
+    existSrc
+  } = appContext;
 
-  if ((0, _utils.isDev)()) {
+  if ((0, _utils.isDev)() && existSrc) {
     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/js/node/utils/routes.js

@@ -0,0 +1,25 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.generateRoutes = void 0;
+
+var _path = _interopRequireDefault(require("path"));
+
+var _utils = require("@modern-js/utils");
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+const generateRoutes = async appContext => {
+  const {
+    serverRoutes,
+    distDirectory
+  } = appContext;
+  const output = JSON.stringify({
+    routes: serverRoutes
+  }, null, 2);
+  await _utils.fs.outputFile(_path.default.join(distDirectory, _utils.ROUTE_SPEC_FILE), output);
+};
+
+exports.generateRoutes = generateRoutes;

package/dist/types/index.d.ts

@@ -14,8 +14,10 @@ declare const _default: import("@modern-js/core").AsyncPlugin<Partial<import("@m
   watchFiles: import("@modern-js/core").ParallelWorkflow<void, unknown>;
   fileChange: import("@modern-js/core").AsyncWorkflow<{
     filename: string;
+    eventType: "add" | "unlink" | "change";
   }, void>;
   beforeExit: import("@modern-js/core").AsyncWorkflow<void, void>;
+  beforeRestart: import("@modern-js/core").AsyncWorkflow<void, void>;
 } & import("@modern-js/core").ClearDraftProgress<import("@modern-js/core").Hooks>>>>;
 
 export default _default;

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

@@ -0,0 +1,3 @@
+import { IAppContext } from '@modern-js/core';
+declare const generateRoutes: (appContext: IAppContext) => Promise<void>;
+export { generateRoutes };

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",
@@ -50,17 +50,17 @@
   },
   "dependencies": {
     "@babel/runtime": "^7",
-    "@modern-js/core": "^1.3.2",
-    "@modern-js/types": "^1.2.1",
+    "@modern-js/core": "^1.4.0",
+    "@modern-js/types": "^1.3.0",
     "@modern-js/i18n-cli-language-detector": "^1.2.1",
     "@modern-js/new-action": "^1.3.1",
     "@modern-js/plugin": "^1.2.1",
-    "@modern-js/plugin-analyze": "^1.2.1",
+    "@modern-js/plugin-analyze": "^1.3.0",
     "@modern-js/plugin-fast-refresh": "^1.2.1",
     "@modern-js/plugin-i18n": "^1.2.1",
-    "@modern-js/server": "^1.3.2",
-    "@modern-js/utils": "^1.2.2",
-    "@modern-js/webpack": "^1.2.1",
+    "@modern-js/server": "^1.4.0",
+    "@modern-js/utils": "^1.3.0",
+    "@modern-js/webpack": "^1.3.0",
     "webpack": "^5.54.0"
   },
   "devDependencies": {

package/tests/commands/build.test.ts

@@ -0,0 +1,37 @@
+import { build } from '../../src/commands/build';
+
+const mockBeforeBuild = jest.fn();
+const mockAfterBuild = jest.fn();
+const mockGenerateRoutes = jest.fn();
+
+jest.mock('@modern-js/core', () => ({
+  __esModule: true,
+  mountHook() {
+    return {
+      beforeBuild: mockBeforeBuild,
+      afterBuild: mockAfterBuild,
+    };
+  },
+  useAppContext: jest.fn(() => ({
+    existSrc: false,
+  })),
+  useResolvedConfigContext: jest.fn(),
+}));
+
+jest.mock('../../src/utils/routes', () => ({
+  __esModule: true,
+  generateRoutes: () => mockGenerateRoutes(),
+}));
+
+describe('command build', () => {
+  afterAll(() => {
+    jest.resetAllMocks();
+  });
+
+  test('existSrc is false', async () => {
+    await build();
+    expect(mockBeforeBuild).toBeCalled();
+    expect(mockGenerateRoutes).toBeCalled();
+    expect(mockAfterBuild).toBeCalled();
+  });
+});

package/tests/commands/dev.test.ts

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

package/tests/routes.test.ts

@@ -0,0 +1,27 @@
+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

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