@modern-js/app-tools 2.62.0 → 2.62.1-alpha.1

package/dist/esm-node/index.js

@@ -1,139 +1,11 @@
-import path from "path";
-import { getLocaleLanguage } from "@modern-js/plugin-i18n/language-detector";
-import { castArray } from "@modern-js/uni-builder";
-import { cleanRequireCache, deprecatedCommands, 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 { appTools } from "./new/index";
+export * from "./new/index";
 import { dev } from "./commands/dev";
 import { mergeConfig } from "@modern-js/core";
 export * from "./defineConfig";
 export * from "./types";
-const appTools = (options = {
-  // default webpack to be compatible with original projects
-  bundler: "webpack"
-}) => ({
-  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(),
-    deployPlugin()
-  ],
-  setup: (api) => {
-    const appContext = api.useAppContext();
-    api.setAppContext({
-      ...appContext,
-      toolsType: "app-tools"
-    });
-    const locale = getLocaleLanguage();
-    i18n.changeLanguage({
-      locale
-    });
-    return {
-      async beforeConfig() {
-        var _userConfig_output;
-        const userConfig = api.useConfigContext();
-        const appContext2 = api.useAppContext();
-        if ((_userConfig_output = userConfig.output) === null || _userConfig_output === void 0 ? void 0 : _userConfig_output.tempDir) {
-          api.setAppContext({
-            ...appContext2,
-            internalDirectory: path.resolve(appContext2.appDirectory, userConfig.output.tempDir)
-          });
-        }
-      },
-      async commands({ program }) {
-        await devCommand(program, api);
-        await buildCommand(program, api);
-        serverCommand(program, api);
-        deployCommand(program, api);
-        newCommand(program, locale);
-        inspectCommand(program, api);
-        upgradeCommand(program);
-        deprecatedCommands(program);
-      },
-      async prepare() {
-        const command = getCommand();
-        if (command === "deploy") {
-          const isSkipBuild = [
-            "-s",
-            "--skip-build"
-          ].some((tag) => {
-            return getArgv().includes(tag);
-          });
-          if (isSkipBuild) {
-            return;
-          }
-        }
-        if (command === "dev" || command === "start" || command === "build" || command === "deploy") {
-          const resolvedConfig = api.useResolvedConfigContext();
-          if (resolvedConfig.output.cleanDistPath) {
-            const appContext2 = api.useAppContext();
-            await emptyDir(appContext2.distDirectory);
-          }
-        }
-      },
-      async watchFiles() {
-        const appContext2 = api.useAppContext();
-        const config = api.useResolvedConfigContext();
-        const files = await generateWatchFiles(appContext2, config.source.configDir);
-        const watchFiles = castArray(config.dev.watchFiles);
-        watchFiles.forEach(({ type, paths }) => {
-          if (type === "reload-server") {
-            files.push(...Array.isArray(paths) ? paths : [
-              paths
-            ]);
-          }
-        });
-        return files;
-      },
-      // 这里会被 core/initWatcher 监听的文件变动触发，如果是 src 目录下的文件变动，则不做 restart
-      async fileChange(e) {
-        const { filename, eventType, isPrivate } = e;
-        if (!isPrivate && (eventType === "change" || eventType === "unlink")) {
-          const { closeServer } = await import("./utils/createServer.js");
-          await closeServer();
-          await restart(api.useHookRunners(), filename);
-        }
-      },
-      async beforeRestart() {
-        cleanRequireCache([
-          require.resolve("./plugins/analyze")
-        ]);
-      }
-    };
-  }
-});
 var src_default = appTools;
 export {
-  appTools,
   src_default as default,
   dev,
   mergeConfig

package/dist/esm-node/new/compat/hooks.js

@@ -0,0 +1,135 @@
+import { transformHookParams, transformHookResult, transformHookRunner } from "./utils";
+function getHookRunners(context) {
+  const { hooks } = context;
+  return {
+    /**
+    * app tools hooks
+    */
+    beforeConfig: async () => {
+      return hooks.onBeforeConfig.call();
+    },
+    afterPrepare: async () => {
+      return hooks.onAfterPrepare.call();
+    },
+    deploy: async () => {
+      return hooks.deploy.call();
+    },
+    _internalRuntimePlugins: async (params) => {
+      return hooks._internalRuntimePlugins.call(params);
+    },
+    _internalServerPlugins: async (params) => {
+      return hooks._internalServerPlugins.call(params);
+    },
+    checkEntryPoint: async (params) => {
+      return hooks.checkEntryPoint.call(params);
+    },
+    modifyEntrypoints: async (params) => {
+      return hooks.modifyEntrypoints.call(params);
+    },
+    modifyFileSystemRoutes: async (params) => {
+      return hooks.modifyFileSystemRoutes.call(params);
+    },
+    modifyServerRoutes: async (params) => {
+      return hooks.modifyServerRoutes.call(params);
+    },
+    generateEntryCode: async (params) => {
+      return hooks.generateEntryCode.call(params);
+    },
+    beforeGenerateRoutes: async (params) => {
+      return hooks.onBeforeGenerateRoutes.call(params);
+    },
+    beforePrintInstructions: async (params) => {
+      return hooks.onBeforePrintInstructions.call(params);
+    },
+    /**
+    * common hooks
+    */
+    config: async () => {
+      return hooks.config.call();
+    },
+    resolvedConfig: (params) => {
+      return hooks.modifyResolvedConfig.call(params);
+    },
+    htmlPartials: async (params) => {
+      return hooks.modifyHtmlPartials.call(params);
+    },
+    commands: async (params) => {
+      return hooks.addCommand.call(params);
+    },
+    watchFiles: async () => {
+      return hooks.addWatchFiles.call();
+    },
+    prepare: async () => {
+      return hooks.onPrepare.call();
+    },
+    filedChange: async (params) => {
+      return hooks.onFileChanged.call(params);
+    },
+    beforeCreateCompiler: async (params) => {
+      return hooks.onBeforeCreateCompiler.call(params);
+    },
+    afterCreateCompiler: async (params) => {
+      return hooks.onAfterCreateCompiler.call(params);
+    },
+    beforeBuild: async (params) => {
+      return hooks.onBeforeBuild.call(params);
+    },
+    afterBuild: async (params) => {
+      return hooks.onAfterBuild.call(params);
+    },
+    beforeDev: async () => {
+      return hooks.onBeforeDev.call();
+    },
+    afterDev: async (params) => {
+      return hooks.onAfterDev.call(params);
+    },
+    beforeDeploy: async () => {
+      return hooks.onBeforeDeploy.call();
+    },
+    afterDeploy: async () => {
+      return hooks.onAfterDeploy.call();
+    },
+    beforeExit: async () => {
+      return hooks.onBeforeExit.call();
+    },
+    beforeRestart: async () => {
+      return hooks.onBeforeRestart.call();
+    },
+    /**
+    * @deprecated
+    */
+    registerDev: async (params) => {
+      return hooks.registerDev.call(params);
+    },
+    /**
+    * @deprecated
+    */
+    registerBuildPlatform: async (params) => {
+      return hooks.registerBuildPlatform.call(params);
+    },
+    /**
+    * @deprecated
+    */
+    addRuntimeExports: async (params) => {
+      return hooks.addRuntimeExports.call(params);
+    }
+  };
+}
+function handleSetupResult(setupResult, api) {
+  if (!setupResult) {
+    return;
+  }
+  Object.keys(setupResult).forEach((key) => {
+    const fn = setupResult[key];
+    if (typeof fn === "function") {
+      const newAPI = transformHookRunner(key);
+      if (api[newAPI]) {
+        api[newAPI](async (params) => transformHookResult(key, await fn(transformHookParams(key, params))));
+      }
+    }
+  });
+}
+export {
+  getHookRunners,
+  handleSetupResult
+};

package/dist/esm-node/new/compat/index.js

@@ -0,0 +1,28 @@
+import { getHookRunners } from "./hooks";
+const compatPlugin = () => ({
+  name: "@modern-js/app-tools-compat",
+  registryApi: (context, updateAppContext) => {
+    return {
+      useAppContext: () => {
+        return context;
+      },
+      setAppContext: (context2) => {
+        return updateAppContext(context2);
+      },
+      useConfigContext: () => {
+        return context.config;
+      },
+      useResolvedConfigContext: () => {
+        return context.normalizedConfig;
+      },
+      useHookRunners: () => {
+        return getHookRunners(context);
+      }
+    };
+  },
+  setup: (_api) => {
+  }
+});
+export {
+  compatPlugin
+};

package/dist/esm-node/new/compat/utils.js

@@ -0,0 +1,69 @@
+function transformHookRunner(hookRunnerName) {
+  switch (hookRunnerName) {
+    case "beforeConfig":
+      return "onBeforeConfig";
+    case "prepare":
+      return "onPrepare";
+    case "afterPrepare":
+      return "onAfterPrepare";
+    case "beforeGenerateRoutes":
+      return "onBeforeGenerateRoutes";
+    case "beforePrintInstructions":
+      return "onBeforePrintInstructions";
+    case "resolvedConfig":
+      return "modifyResolvedConfig";
+    case "commands":
+      return "addCommand";
+    case "watchFiles":
+      return "addWatchFiles";
+    case "filedChange":
+      return "onFileChanged";
+    case "beforeCreateCompiler":
+      return "onBeforeCreateCompiler";
+    case "afterCreateCompiler":
+      return "onAfterCreateCompiler";
+    case "beforeBuild":
+      return "onBeforeBuild";
+    case "afterBuild":
+      return "onAfterBuild";
+    case "beforeDev":
+      return "onBeforeDev";
+    case "afterDev":
+      return "onAfterDev";
+    case "beforeDeploy":
+      return "onBeforeDeploy";
+    case "afterDeploy":
+      return "onAfterDeploy";
+    case "beforeExit":
+      return "onBeforeExit";
+    case "beforeRestart":
+      return "onBeforeRestart";
+    case "htmlPartials":
+      return "modifyHtmlPartials";
+    default:
+      return hookRunnerName;
+  }
+}
+function transformHookParams(hookRunnerName, params) {
+  switch (hookRunnerName) {
+    case "resolvedConfig":
+      return {
+        resolved: params
+      };
+    default:
+      return params;
+  }
+}
+function transformHookResult(hookRunnerName, result) {
+  switch (hookRunnerName) {
+    case "resolvedConfig":
+      return result.resolved;
+    default:
+      return result;
+  }
+}
+export {
+  transformHookParams,
+  transformHookResult,
+  transformHookRunner
+};

package/dist/esm-node/new/constants.js

@@ -0,0 +1,10 @@
+const PACKAGE_JSON_CONFIG_NAME = "modernConfig";
+const DEFAULT_CONFIG_FILE = "modern.config";
+const DEFAULT_SERVER_CONFIG_FILE = "modern.server-runtime.config";
+const DEFAULT_RUNTIME_CONFIG_FILE = "modern.runtime";
+export {
+  DEFAULT_CONFIG_FILE,
+  DEFAULT_RUNTIME_CONFIG_FILE,
+  DEFAULT_SERVER_CONFIG_FILE,
+  PACKAGE_JSON_CONFIG_NAME
+};

package/dist/esm-node/new/context.js

@@ -0,0 +1,29 @@
+import path from "path";
+import { address } from "@modern-js/utils";
+const initAppContext = ({ appDirectory, runtimeConfigFile, options, serverConfigFile }) => {
+  const { metaName = "modern-js", apiDir = "api", distDir = "", sharedDir = "shared" } = options || {};
+  return {
+    metaName,
+    runtimeConfigFile,
+    serverConfigFile,
+    ip: address.ip(),
+    port: 0,
+    moduleType: require(path.resolve(appDirectory, "./package.json")).type || "commonjs",
+    apiDirectory: path.resolve(appDirectory, apiDir),
+    lambdaDirectory: path.resolve(appDirectory, apiDir, "lambda"),
+    sharedDirectory: path.resolve(appDirectory, sharedDir),
+    distDirectory: distDir,
+    serverPlugins: [],
+    internalDirectory: path.resolve(appDirectory, `./node_modules/.${metaName}`),
+    htmlTemplates: {},
+    serverRoutes: [],
+    entrypoints: [],
+    checkedEntries: [],
+    apiOnly: false,
+    internalDirAlias: `@_${metaName.replace(/-/g, "_")}_internal`,
+    internalSrcAlias: `@_${metaName.replace(/-/g, "_")}_src`
+  };
+};
+export {
+  initAppContext
+};

package/dist/esm-node/new/getConfigFile.js

@@ -0,0 +1,7 @@
+import path from "path";
+import { CONFIG_FILE_EXTENSIONS, findExists } from "@modern-js/utils";
+import { DEFAULT_CONFIG_FILE } from "./constants";
+const getConfigFile = (configFile) => findExists(CONFIG_FILE_EXTENSIONS.map((extension) => path.resolve(process.cwd(), `${configFile || DEFAULT_CONFIG_FILE}${extension}`)));
+export {
+  getConfigFile
+};

package/dist/esm-node/new/index.js

@@ -0,0 +1,49 @@
+import { createAsyncHook } from "@modern-js/plugin-v2";
+import { appTools as oldAppTools } from "../old";
+import { compatPlugin } from "./compat";
+import { DEFAULT_RUNTIME_CONFIG_FILE, DEFAULT_SERVER_CONFIG_FILE } from "./constants";
+import { initAppContext } from "./context";
+export * from "../defineConfig";
+const appTools = (options = {
+  // default webpack to be compatible with original projects
+  bundler: "webpack"
+}) => ({
+  name: "@modern-js/app-tools",
+  usePlugins: [
+    compatPlugin(),
+    oldAppTools(options)
+  ],
+  post: [
+    "@modern-js/app-tools-old"
+  ],
+  registryHooks: {
+    onBeforeConfig: createAsyncHook(),
+    onAfterPrepare: createAsyncHook(),
+    deploy: createAsyncHook(),
+    _internalRuntimePlugins: createAsyncHook(),
+    _internalServerPlugins: createAsyncHook(),
+    checkEntryPoint: createAsyncHook(),
+    modifyEntrypoints: createAsyncHook(),
+    modifyFileSystemRoutes: createAsyncHook(),
+    modifyServerRoutes: createAsyncHook(),
+    generateEntryCode: createAsyncHook(),
+    onBeforeGenerateRoutes: createAsyncHook(),
+    onBeforePrintInstructions: createAsyncHook(),
+    registerDev: createAsyncHook(),
+    registerBuildPlatform: createAsyncHook(),
+    addRuntimeExports: createAsyncHook()
+  },
+  setup: (api) => {
+    const context = api.getAppContext();
+    api.updateAppContext(initAppContext({
+      appDirectory: context.appDirectory,
+      options: {},
+      serverConfigFile: DEFAULT_SERVER_CONFIG_FILE,
+      runtimeConfigFile: DEFAULT_RUNTIME_CONFIG_FILE
+    }));
+  }
+});
+export {
+  appTools,
+  initAppContext
+};

package/dist/esm-node/new/loadPlugins.js

@@ -0,0 +1,33 @@
+import { compatibleRequire, createDebugger, dynamicImport, getInternalPlugins, tryResolve } from "@modern-js/utils";
+const debug = createDebugger("load-plugins");
+const resolveCliPlugin = async (p, appDirectory) => {
+  const pkg = typeof p === "string" ? p : p[0];
+  const pluginOptions = typeof p === "string" ? void 0 : p[1];
+  const path = tryResolve(pkg, appDirectory);
+  let module;
+  try {
+    module = await compatibleRequire(path);
+  } catch (e) {
+    ({ default: module } = await dynamicImport(path));
+  }
+  if (typeof module === "function") {
+    const result = module(pluginOptions);
+    return result;
+  }
+  return module;
+};
+const loadInternalPlugins = async (appDirectory, internalPlugins, autoLoad, autoLoadPlugins, forceAutoLoadPlugins) => {
+  const plugins = [
+    ...forceAutoLoadPlugins || autoLoadPlugins ? getInternalPlugins(appDirectory, internalPlugins) : [],
+    ...autoLoad ? getInternalPlugins(appDirectory, autoLoad) : []
+  ];
+  const loadedPlugins = await Promise.all(plugins.map((plugin) => {
+    const loadedPlugin = resolveCliPlugin(plugin, appDirectory);
+    debug(`resolve plugin %s: %s`, plugin, loadedPlugin);
+    return loadedPlugin;
+  }));
+  return loadedPlugins;
+};
+export {
+  loadInternalPlugins
+};

package/dist/esm-node/new/run.js

@@ -0,0 +1,42 @@
+import { initAppDir } from "@modern-js/plugin-v2/cli";
+import { run as CLIPluginRun } from "@modern-js/plugin-v2/run";
+import { minimist } from "@modern-js/utils";
+import { handleSetupResult } from "./compat/hooks";
+import { PACKAGE_JSON_CONFIG_NAME } from "./constants";
+import { getConfigFile } from "./getConfigFile";
+import { loadInternalPlugins } from "./loadPlugins";
+import { getIsAutoLoadPlugins } from "./utils";
+async function run({ cwd, initialLog, version, internalPlugins, forceAutoLoadPlugins, packageJsonConfig, configFile }) {
+  const command = process.argv[2];
+  const cliParams = minimist(process.argv.slice(2));
+  const SUPPORT_CONFIG_PARAM_COMMANDS = [
+    "dev",
+    "build",
+    "deploy",
+    "start",
+    "serve",
+    "inspect",
+    "upgrade"
+  ];
+  let customConfigFile;
+  if (SUPPORT_CONFIG_PARAM_COMMANDS.includes(command)) {
+    customConfigFile = cliParams.config || cliParams.c;
+  }
+  if (command === "new") {
+    customConfigFile = cliParams["config-file"];
+  }
+  const appDirectory = await initAppDir(cwd);
+  const autoLoadPlugins = await getIsAutoLoadPlugins(appDirectory, customConfigFile || getConfigFile(configFile));
+  const plugins = await loadInternalPlugins(appDirectory, internalPlugins === null || internalPlugins === void 0 ? void 0 : internalPlugins.cli, internalPlugins === null || internalPlugins === void 0 ? void 0 : internalPlugins.autoLoad, autoLoadPlugins, forceAutoLoadPlugins);
+  await CLIPluginRun({
+    cwd,
+    initialLog: initialLog || `Modern.js Framework v${version}`,
+    configFile: customConfigFile || getConfigFile(configFile),
+    packageJsonConfig: packageJsonConfig || PACKAGE_JSON_CONFIG_NAME,
+    internalPlugins: plugins,
+    handleSetupResult
+  });
+}
+export {
+  run
+};

package/dist/esm-node/new/utils/index.js

@@ -0,0 +1,10 @@
+import { createLoadedConfig } from "@modern-js/plugin-v2/cli";
+async function getIsAutoLoadPlugins(appDirectory, configFile = "modern.config.ts", packageJsonConfig = "ModernConfig") {
+  var _loaded_config;
+  const loaded = await createLoadedConfig(appDirectory, configFile, packageJsonConfig);
+  const autoLoadPlugins = (_loaded_config = loaded.config) === null || _loaded_config === void 0 ? void 0 : _loaded_config.autoLoadPlugins;
+  return autoLoadPlugins || false;
+}
+export {
+  getIsAutoLoadPlugins
+};