@modern-js/app-tools 2.58.2 → 2.59.0

package/dist/esm/esm/ts-node-loader.mjs

@@ -0,0 +1,21 @@
+import { pathToFileURL } from 'url';
+import { resolve as tsNodeResolve } from 'ts-node/esm';
+import { createMatchPath } from './utils.mjs';
+
+let matchPath;
+export async function initialize({ appDir, alias, tsconfigPath }) {
+  matchPath = createMatchPath({
+    alias,
+    appDir,
+    tsconfigPath,
+  });
+}
+
+export function resolve(specifier, context, defaultResolve) {
+  const match = matchPath(specifier);
+  return match
+    ? tsNodeResolve(pathToFileURL(match).href, context, defaultResolve)
+    : tsNodeResolve(specifier, context, defaultResolve);
+}
+
+export { transformSource, load } from 'ts-node/esm';

package/dist/esm/esm/utils.mjs

@@ -0,0 +1,43 @@
+import { createRequire } from 'module';
+import path from 'path';
+import { getAliasConfig } from '@modern-js/utils';
+import tsConfigPaths from '@modern-js/utils/tsconfig-paths';
+
+const require = createRequire(import.meta.url);
+export function createMatchPath({ alias, appDir, tsconfigPath }) {
+  const aliasConfig = getAliasConfig(alias, {
+    appDirectory: appDir,
+    tsconfigPath,
+  });
+
+  const { paths = {}, absoluteBaseUrl = './' } = aliasConfig;
+
+  const tsPaths = Object.keys(paths).reduce((o, key) => {
+    let tsPath = paths[key];
+    // Do some special handling for Modern.js's internal alias, we can drop it in the next version
+    if (
+      typeof tsPath === 'string' &&
+      key.startsWith('@') &&
+      tsPath.startsWith('@')
+    ) {
+      try {
+        tsPath = require.resolve(tsPath, {
+          paths: [appDir],
+        });
+      } catch {}
+    }
+
+    if (typeof tsPath === 'string' && path.isAbsolute(tsPath)) {
+      tsPath = path.relative(absoluteBaseUrl, tsPath);
+    }
+    if (typeof tsPath === 'string') {
+      tsPath = [tsPath];
+    }
+    return {
+      ...o,
+      [`${key}`]: tsPath,
+    };
+  }, {});
+
+  return tsConfigPaths.createMatchPath(absoluteBaseUrl, tsPaths);
+}

package/dist/esm/exports/server.js

@@ -0,0 +1,4 @@
+import { defineServerConfig } from "../utils/config";
+export {
+  defineServerConfig as defineConfig
+};

package/dist/esm/hooks.js

@@ -0,0 +1,34 @@
+import { createAsyncWaterfall, createAsyncWorkflow, createParallelWorkflow } from "@modern-js/plugin";
+var hooks = {
+  _internalRuntimePlugins: createAsyncWaterfall(),
+  modifyFileSystemRoutes: createAsyncWaterfall(),
+  modifyServerRoutes: createAsyncWaterfall(),
+  /** add entry point info to entrypoints array */
+  modifyEntrypoints: createAsyncWaterfall(),
+  /** add entry type */
+  checkEntryPoint: createAsyncWaterfall(),
+  generateEntryCode: createAsyncWorkflow(),
+  htmlPartials: createAsyncWaterfall(),
+  beforeGenerateRoutes: createAsyncWaterfall(),
+  addDefineTypes: createAsyncWaterfall(),
+  collectServerPlugins: createAsyncWaterfall(),
+  _internalServerPlugins: createAsyncWaterfall(),
+  beforeDev: createAsyncWorkflow(),
+  afterDev: createAsyncWorkflow(),
+  beforeCreateCompiler: createAsyncWorkflow(),
+  afterCreateCompiler: createAsyncWorkflow(),
+  beforePrintInstructions: createAsyncWaterfall(),
+  beforeBuild: createAsyncWorkflow(),
+  afterBuild: createAsyncWorkflow(),
+  beforeDeploy: createAsyncWorkflow(),
+  deploy: createAsyncWorkflow(),
+  afterDeploy: createAsyncWorkflow(),
+  beforeRestart: createAsyncWorkflow(),
+  registerDev: createParallelWorkflow(),
+  beforeDevTask: createParallelWorkflow(),
+  registerBuildPlatform: createParallelWorkflow(),
+  beforeBuildPlatform: createParallelWorkflow()
+};
+export {
+  hooks
+};

package/dist/esm/index.js

@@ -0,0 +1,246 @@
+import { _ as _async_to_generator } from "@swc/helpers/_/_async_to_generator";
+import { _ as _object_spread } from "@swc/helpers/_/_object_spread";
+import { _ as _object_spread_props } from "@swc/helpers/_/_object_spread_props";
+import { _ as _ts_generator } from "@swc/helpers/_/_ts_generator";
+import path from "path";
+import { getLocaleLanguage } from "@modern-js/plugin-i18n/language-detector";
+import { lintPlugin } from "@modern-js/plugin-lint";
+import { cleanRequireCache, emptyDir, getArgv, getCommand } from "@modern-js/utils";
+import { hooks } from "./hooks";
+import { i18n } from "./locale";
+import analyzePlugin from "./plugins/analyze";
+import deployPlugin from "./plugins/deploy";
+import initializePlugin from "./plugins/initialize";
+import serverBuildPlugin from "./plugins/serverBuild";
+import { buildCommand, deployCommand, devCommand, inspectCommand, newCommand, serverCommand, upgradeCommand } from "./commands";
+import { generateWatchFiles } from "./utils/generateWatchFiles";
+import { restart } from "./utils/restart";
+import { dev } from "./commands/dev";
+import { mergeConfig } from "@modern-js/core";
+export * from "./defineConfig";
+export * from "./types";
+var appTools = function() {
+  var options = arguments.length > 0 && arguments[0] !== void 0 ? arguments[0] : {
+    // default webpack to be compatible with original projects
+    bundler: "webpack"
+  };
+  return {
+    name: "@modern-js/app-tools",
+    post: [
+      "@modern-js/plugin-initialize",
+      "@modern-js/plugin-analyze",
+      "@modern-js/plugin-ssr",
+      "@modern-js/plugin-document",
+      "@modern-js/plugin-state",
+      "@modern-js/plugin-router",
+      "@modern-js/plugin-router-v5",
+      "@modern-js/plugin-polyfill"
+    ],
+    registerHook: hooks,
+    usePlugins: [
+      initializePlugin({
+        bundler: (options === null || options === void 0 ? void 0 : options.bundler) && [
+          "rspack",
+          "experimental-rspack"
+        ].includes(options.bundler) ? "rspack" : "webpack"
+      }),
+      analyzePlugin({
+        bundler: (options === null || options === void 0 ? void 0 : options.bundler) && [
+          "rspack",
+          "experimental-rspack"
+        ].includes(options.bundler) ? "rspack" : "webpack"
+      }),
+      serverBuildPlugin(),
+      lintPlugin(),
+      deployPlugin()
+    ],
+    setup: function(api) {
+      var appContext = api.useAppContext();
+      api.setAppContext(_object_spread_props(_object_spread({}, appContext), {
+        toolsType: "app-tools"
+      }));
+      var locale = getLocaleLanguage();
+      i18n.changeLanguage({
+        locale
+      });
+      return {
+        beforeConfig: function beforeConfig() {
+          return _async_to_generator(function() {
+            var _userConfig_output, userConfig, appContext2;
+            return _ts_generator(this, function(_state) {
+              userConfig = api.useConfigContext();
+              appContext2 = api.useAppContext();
+              if ((_userConfig_output = userConfig.output) === null || _userConfig_output === void 0 ? void 0 : _userConfig_output.tempDir) {
+                api.setAppContext(_object_spread_props(_object_spread({}, appContext2), {
+                  internalDirectory: path.resolve(appContext2.appDirectory, userConfig.output.tempDir)
+                }));
+              }
+              return [
+                2
+              ];
+            });
+          })();
+        },
+        commands: function commands(param) {
+          var program = param.program;
+          return _async_to_generator(function() {
+            return _ts_generator(this, function(_state) {
+              switch (_state.label) {
+                case 0:
+                  return [
+                    4,
+                    devCommand(program, api)
+                  ];
+                case 1:
+                  _state.sent();
+                  return [
+                    4,
+                    buildCommand(program, api)
+                  ];
+                case 2:
+                  _state.sent();
+                  serverCommand(program, api);
+                  deployCommand(program, api);
+                  newCommand(program, locale);
+                  inspectCommand(program, api);
+                  upgradeCommand(program);
+                  return [
+                    2
+                  ];
+              }
+            });
+          })();
+        },
+        prepare: function prepare() {
+          return _async_to_generator(function() {
+            var command, isSkipBuild, resolvedConfig, appContext2;
+            return _ts_generator(this, function(_state) {
+              switch (_state.label) {
+                case 0:
+                  command = getCommand();
+                  if (command === "deploy") {
+                    isSkipBuild = [
+                      "-s",
+                      "--skip-build"
+                    ].some(function(tag) {
+                      return getArgv().includes(tag);
+                    });
+                    if (isSkipBuild) {
+                      return [
+                        2
+                      ];
+                    }
+                  }
+                  if (!(command === "dev" || command === "start" || command === "build" || command === "deploy"))
+                    return [
+                      3,
+                      2
+                    ];
+                  resolvedConfig = api.useResolvedConfigContext();
+                  if (!resolvedConfig.output.cleanDistPath)
+                    return [
+                      3,
+                      2
+                    ];
+                  appContext2 = api.useAppContext();
+                  return [
+                    4,
+                    emptyDir(appContext2.distDirectory)
+                  ];
+                case 1:
+                  _state.sent();
+                  _state.label = 2;
+                case 2:
+                  return [
+                    2
+                  ];
+              }
+            });
+          })();
+        },
+        watchFiles: function watchFiles() {
+          return _async_to_generator(function() {
+            var appContext2, config;
+            return _ts_generator(this, function(_state) {
+              switch (_state.label) {
+                case 0:
+                  appContext2 = api.useAppContext();
+                  config = api.useResolvedConfigContext();
+                  return [
+                    4,
+                    generateWatchFiles(appContext2, config.source.configDir)
+                  ];
+                case 1:
+                  return [
+                    2,
+                    _state.sent()
+                  ];
+              }
+            });
+          })();
+        },
+        fileChange: (
+          // 这里会被 core/initWatcher 监听的文件变动触发，如果是 src 目录下的文件变动，则不做 restart
+          function fileChange(e) {
+            return _async_to_generator(function() {
+              var filename, eventType, isPrivate, closeServer;
+              return _ts_generator(this, function(_state) {
+                switch (_state.label) {
+                  case 0:
+                    filename = e.filename, eventType = e.eventType, isPrivate = e.isPrivate;
+                    if (!(!isPrivate && (eventType === "change" || eventType === "unlink")))
+                      return [
+                        3,
+                        4
+                      ];
+                    return [
+                      4,
+                      import("./utils/createServer.js")
+                    ];
+                  case 1:
+                    closeServer = _state.sent().closeServer;
+                    return [
+                      4,
+                      closeServer()
+                    ];
+                  case 2:
+                    _state.sent();
+                    return [
+                      4,
+                      restart(api.useHookRunners(), filename)
+                    ];
+                  case 3:
+                    _state.sent();
+                    _state.label = 4;
+                  case 4:
+                    return [
+                      2
+                    ];
+                }
+              });
+            })();
+          }
+        ),
+        beforeRestart: function beforeRestart() {
+          return _async_to_generator(function() {
+            return _ts_generator(this, function(_state) {
+              cleanRequireCache([
+                require.resolve("./plugins/analyze")
+              ]);
+              return [
+                2
+              ];
+            });
+          })();
+        }
+      };
+    }
+  };
+};
+var src_default = appTools;
+export {
+  appTools,
+  src_default as default,
+  dev,
+  mergeConfig
+};

package/dist/esm/locale/en.js

@@ -0,0 +1,43 @@
+var EN_LOCALE = {
+  command: {
+    shared: {
+      analyze: "analyze bundle size",
+      config: "specify the configuration file, which can be a relative or absolute path",
+      skipBuild: "skip the build phase",
+      noNeedInstall: "not run install command"
+    },
+    dev: {
+      describe: "starting the dev server",
+      entry: "compiler by entry",
+      apiOnly: "start api server only",
+      webOnly: "start web server only",
+      selectEntry: "Please select the entry that needs to be built",
+      requireEntry: "You must choose at least one entry"
+    },
+    build: {
+      describe: "build the app for production"
+    },
+    serve: {
+      describe: "preview the production build locally"
+    },
+    deploy: {
+      describe: "deploy the application"
+    },
+    new: {
+      describe: "enable optional features or add a new entry",
+      debug: "using debug mode to log something",
+      config: "set default generator config(json string)",
+      distTag: "use specified tag version for it's generator",
+      registry: "set npm registry url to run npm command",
+      lang: "set new command language(en or zh)"
+    },
+    inspect: {
+      env: "specify env mode",
+      output: "specify inspect content output path",
+      verbose: "show full function definitions in output"
+    }
+  }
+};
+export {
+  EN_LOCALE
+};

package/dist/esm/locale/index.js

@@ -0,0 +1,12 @@
+import { I18n } from "@modern-js/plugin-i18n";
+import { EN_LOCALE } from "./en";
+import { ZH_LOCALE } from "./zh";
+var i18n = new I18n();
+var localeKeys = i18n.init("en", {
+  zh: ZH_LOCALE,
+  en: EN_LOCALE
+});
+export {
+  i18n,
+  localeKeys
+};

package/dist/esm/locale/zh.js

@@ -0,0 +1,43 @@
+var ZH_LOCALE = {
+  command: {
+    shared: {
+      analyze: "分析构建产物体积，查看各个模块打包后的大小",
+      config: "指定配置文件路径，可以为相对路径或绝对路径",
+      skipBuild: "跳过构建阶段",
+      noNeedInstall: "无需安装依赖"
+    },
+    dev: {
+      describe: "启动开发服务器",
+      entry: "指定入口，编译特定的页面",
+      apiOnly: "仅启动 API 接口服务",
+      webOnly: "仅启动 Web 服务",
+      selectEntry: "请选择需要构建的入口",
+      requireEntry: "请至少选择一个入口"
+    },
+    build: {
+      describe: "构建生产环境产物"
+    },
+    serve: {
+      describe: "启动生产环境服务"
+    },
+    deploy: {
+      describe: "部署应用"
+    },
+    new: {
+      describe: "Web App 项目中执行生成器",
+      debug: "开启 Debug 模式，打印调试日志信息",
+      config: "生成器运行默认配置(JSON 字符串)",
+      distTag: "生成器使用特殊的 npm Tag 版本",
+      registry: "生成器运行过程中定制 npm Registry",
+      lang: "设置 new 命令执行语言(zh 或者 en)"
+    },
+    inspect: {
+      env: "查看指定环境下的配置",
+      output: "指定在 dist 目录下输出的路径",
+      verbose: "在结果中展示函数的完整内容"
+    }
+  }
+};
+export {
+  ZH_LOCALE
+};

package/dist/esm/plugins/analyze/constants.js

@@ -0,0 +1,14 @@
+var INDEX_FILE_NAME = "index";
+var ENTRY_FILE_NAME = "entry";
+var HTML_PARTIALS_FOLDER = "html";
+var HTML_PARTIALS_EXTENSIONS = [
+  ".htm",
+  ".html",
+  ".ejs"
+];
+export {
+  ENTRY_FILE_NAME,
+  HTML_PARTIALS_EXTENSIONS,
+  HTML_PARTIALS_FOLDER,
+  INDEX_FILE_NAME
+};

package/dist/esm/plugins/analyze/getBundleEntry.js

@@ -0,0 +1,102 @@
+import { _ as _async_to_generator } from "@swc/helpers/_/_async_to_generator";
+import { _ as _ts_generator } from "@swc/helpers/_/_ts_generator";
+import path from "path";
+import { fs, JS_EXTENSIONS, MAIN_ENTRY_NAME, ensureAbsolutePath, findExists } from "@modern-js/utils";
+import { getFileSystemEntry } from "./getFileSystemEntry";
+import { isSubDirOrEqual } from "./utils";
+var ensureExtensions = function(file) {
+  if (!path.extname(file)) {
+    return findExists(JS_EXTENSIONS.map(function(ext) {
+      return "".concat(file).concat(ext);
+    })) || file;
+  }
+  return file;
+};
+var isDirectory = function(file) {
+  return !path.extname(file);
+};
+var ifAlreadyExists = function(entrypoints, checked) {
+  return entrypoints.some(function(entrypoint) {
+    if (ensureExtensions(entrypoint.entry) === ensureExtensions(checked.entry)) {
+      checked.entryName = entrypoint.entryName;
+      return true;
+    }
+    if (isSubDirOrEqual(entrypoint.entry, checked.entry) || isSubDirOrEqual(checked.entry, entrypoint.entry)) {
+      throw new Error("Entry configuration conflicts\n Your configuration: ".concat(checked.entry, ".\n Default entrypoint: ").concat(entrypoint.entry, "\n Please reset source.entries or set source.disableDefaultEntries to disable the default entry rules."));
+    }
+    return false;
+  });
+};
+var getBundleEntry = function() {
+  var _ref = _async_to_generator(function(hookRunners, appContext, config) {
+    var appDirectory, packageName, _config_source, disableDefaultEntries, entries, entriesDir, mainEntryName, defaults, _tmp, entriesDirAbs, found;
+    return _ts_generator(this, function(_state) {
+      switch (_state.label) {
+        case 0:
+          appDirectory = appContext.appDirectory, packageName = appContext.packageName;
+          _config_source = config.source, disableDefaultEntries = _config_source.disableDefaultEntries, entries = _config_source.entries, entriesDir = _config_source.entriesDir, mainEntryName = _config_source.mainEntryName;
+          if (!disableDefaultEntries)
+            return [
+              3,
+              1
+            ];
+          _tmp = [];
+          return [
+            3,
+            3
+          ];
+        case 1:
+          return [
+            4,
+            getFileSystemEntry(hookRunners, appContext, config)
+          ];
+        case 2:
+          _tmp = _state.sent();
+          _state.label = 3;
+        case 3:
+          defaults = _tmp;
+          if (entries) {
+            Object.keys(entries).forEach(function(name) {
+              var value = entries[name];
+              var entryName = typeof value === "string" ? value : value.entry;
+              var isAutoMount = typeof value === "string" ? true : !value.disableMount;
+              var entrypoint = {
+                entryName: name,
+                isMainEntry: false,
+                entry: ensureAbsolutePath(appDirectory, entryName),
+                absoluteEntryDir: isDirectory(ensureAbsolutePath(appDirectory, entryName)) ? ensureAbsolutePath(appDirectory, entryName) : path.dirname(ensureAbsolutePath(appDirectory, entryName)),
+                isAutoMount,
+                customBootstrap: typeof value === "string" ? false : value.customBootstrap && ensureAbsolutePath(appDirectory, value.customBootstrap),
+                fileSystemRoutes: fs.statSync(ensureAbsolutePath(appDirectory, entryName)).isDirectory() ? {} : void 0,
+                isCustomSourceEntry: true
+              };
+              if (!ifAlreadyExists(defaults, entrypoint)) {
+                defaults.push(entrypoint);
+              }
+            });
+          }
+          if (!disableDefaultEntries) {
+            entriesDirAbs = ensureAbsolutePath(appDirectory, entriesDir || "");
+            found = defaults.find(function(param) {
+              var entryName = param.entryName, entry = param.entry, _param_nestedRoutesEntry = param.nestedRoutesEntry, nestedRoutesEntry = _param_nestedRoutesEntry === void 0 ? "" : _param_nestedRoutesEntry;
+              return entryName === packageName || path.dirname(entry) === entriesDirAbs || path.dirname(nestedRoutesEntry) === entriesDirAbs;
+            });
+            if (found) {
+              found.entryName = mainEntryName || MAIN_ENTRY_NAME;
+              found.isMainEntry = true;
+            }
+          }
+          return [
+            2,
+            defaults
+          ];
+      }
+    });
+  });
+  return function getBundleEntry2(hookRunners, appContext, config) {
+    return _ref.apply(this, arguments);
+  };
+}();
+export {
+  getBundleEntry
+};