@modern-js/app-tools 2.63.0 → 2.63.1-alpha.0

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

@@ -1,5 +1,4 @@
 import path from "node:path";
-import { ResolvedConfigContext } from "@modern-js/core";
 import { applyPlugins } from "@modern-js/prod-server";
 import { createDevServer } from "@modern-js/server";
 import { DEFAULT_DEV_HOST, SERVER_DIR, getMeta, logger } from "@modern-js/utils";
@@ -14,9 +13,9 @@ const dev = async (api, options, devServerOptions) => {
   if (options.analyze) {
     process.env.BUNDLE_ANALYZE = "true";
   }
-  let normalizedConfig = api.useResolvedConfigContext();
-  const appContext = api.useAppContext();
-  const hookRunners = api.useHookRunners();
+  const normalizedConfig = api.getNormalizedConfig();
+  const appContext = api.getAppContext();
+  const hooks = api.getHooks();
   if (appContext.moduleType && appContext.moduleType === "module") {
     var _normalizedConfig_source1;
     const { registerEsm } = await import("../esm/register-esm.mjs");
@@ -27,11 +26,12 @@ const dev = async (api, options, devServerOptions) => {
     });
   }
   await registerCompiler(appContext.appDirectory, appContext.distDirectory, normalizedConfig === null || normalizedConfig === void 0 ? void 0 : (_normalizedConfig_source = normalizedConfig.source) === null || _normalizedConfig_source === void 0 ? void 0 : _normalizedConfig_source.alias);
-  normalizedConfig = {
-    ...normalizedConfig,
-    cliOptions: options
-  };
-  ResolvedConfigContext.set(normalizedConfig);
+  api.modifyResolvedConfig((config) => {
+    return {
+      ...config,
+      cliOptions: options
+    };
+  });
   const { appDirectory, distDirectory, port, apiOnly, serverConfigFile, metaName, serverRoutes } = appContext;
   await buildServerConfig({
     appDirectory,
@@ -41,7 +41,7 @@ const dev = async (api, options, devServerOptions) => {
   });
   const meta = getMeta(metaName);
   const serverConfigPath = path.resolve(appDirectory, SERVER_DIR, `${meta}.server`);
-  await hookRunners.beforeDev();
+  await hooks.onBeforeDev.call();
   if (!appContext.builder && !apiOnly) {
     throw new Error("Expect the Builder to have been initialized, But the appContext.builder received `undefined`");
   }
@@ -80,7 +80,7 @@ const dev = async (api, options, devServerOptions) => {
       port,
       host
     }, () => {
-      printInstructions(hookRunners, appContext, normalizedConfig);
+      printInstructions(hooks, appContext, normalizedConfig);
     });
   } else {
     const { server, afterListen } = await createDevServer({

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

@@ -2,8 +2,8 @@ import { castArray } from "@modern-js/uni-builder";
 import { newAction, upgradeAction } from "@modern-js/utils";
 import { i18n, localeKeys } from "../locale";
 const devCommand = async (program, api) => {
-  const runner = api.useHookRunners();
-  const devToolMetas = await runner.registerDev();
+  const hooks = api.getHooks();
+  const devToolMetas = await hooks.registerDev.call();
   const devProgram = program.command("dev").alias("start").usage("[options]").description(i18n.t(localeKeys.command.dev.describe)).option("-c --config <config>", i18n.t(localeKeys.command.shared.config)).option("-e --entry [entry...]", i18n.t(localeKeys.command.dev.entry)).option("--analyze", i18n.t(localeKeys.command.shared.analyze)).option("--api-only", i18n.t(localeKeys.command.dev.apiOnly)).option("--web-only", i18n.t(localeKeys.command.dev.webOnly)).action(async (options) => {
     const { dev } = await import("./dev.js");
     await dev(api, options);
@@ -14,7 +14,7 @@ const devCommand = async (program, api) => {
     }
     for (const subCmd of meta.subCommands) {
       devProgram.command(subCmd).action(async (options = {}) => {
-        const { appDirectory } = api.useAppContext();
+        const { appDirectory } = api.getAppContext();
         const { isTypescript } = await import("@modern-js/utils");
         await meta.action(options, {
           isTsProject: isTypescript(appDirectory)
@@ -24,8 +24,8 @@ const devCommand = async (program, api) => {
   }
 };
 const buildCommand = async (program, api) => {
-  const runner = api.useHookRunners();
-  const platformBuilders = await runner.registerBuildPlatform();
+  const hooks = api.getHooks();
+  const platformBuilders = await hooks.registerBuildPlatform.call();
   const buildProgram = program.command("build").usage("[options]").description(i18n.t(localeKeys.command.build.describe)).option("-c --config <config>", i18n.t(localeKeys.command.shared.config)).option("--analyze", i18n.t(localeKeys.command.shared.analyze)).action(async (options) => {
     const { build } = await import("./build.js");
     await build(api, options);
@@ -34,7 +34,7 @@ const buildCommand = async (program, api) => {
     const platforms = castArray(platformBuilder.platform);
     for (const platform of platforms) {
       buildProgram.command(platform).action(async () => {
-        const { appDirectory } = api.useAppContext();
+        const { appDirectory } = api.getAppContext();
         const { isTypescript } = await import("@modern-js/utils");
         await platformBuilder.build(platform, {
           isTsProject: isTypescript(appDirectory)

package/dist/esm-node/commands/inspect.js

@@ -1,5 +1,5 @@
 const inspect = async (api, options) => {
-  const appContext = api.useAppContext();
+  const appContext = api.getAppContext();
   if (!appContext.builder) {
     throw new Error("Expect the Builder to have been initialized, But the appContext.builder received `undefined`");
   }

package/dist/esm-node/commands/serve.js

@@ -5,9 +5,9 @@ import { loadServerPlugins } from "../utils/loadPlugins";
 import { printInstructions } from "../utils/printInstructions";
 const start = async (api) => {
   var _userConfig_source, _userConfig_output_distPath;
-  const appContext = api.useAppContext();
-  const userConfig = api.useResolvedConfigContext();
-  const hookRunners = api.useHookRunners();
+  const appContext = api.getAppContext();
+  const userConfig = api.getNormalizedConfig();
+  const hooks = api.getHooks();
   const { distDirectory, appDirectory, internalDirectory, port, metaName, serverRoutes, serverConfigFile } = appContext;
   logger.info(`Starting production server...`);
   const apiOnly = await isApiOnly(appContext.appDirectory, userConfig === null || userConfig === void 0 ? void 0 : (_userConfig_source = userConfig.source) === null || _userConfig_source === void 0 ? void 0 : _userConfig_source.entriesDir, appContext.apiDirectory);
@@ -44,7 +44,7 @@ const start = async (api) => {
     runMode
   });
   app.listen(port, async () => {
-    await printInstructions(hookRunners, appContext, userConfig);
+    await printInstructions(hooks, appContext, userConfig);
   });
 };
 export {

package/dist/esm-node/{new/compat → compat}/hooks.js

@@ -1,3 +1,4 @@
+import { getModifyHtmlPartials } from "../plugins/analyze/getHtmlTemplate";
 import { transformHookParams, transformHookResult, transformHookRunner } from "./utils";
 function getHookRunners(context) {
   const { hooks } = context;
@@ -56,7 +57,13 @@ function getHookRunners(context) {
       return hooks.modifyResolvedConfig.call(params);
     },
     htmlPartials: async (params) => {
-      return hooks.modifyHtmlPartials.call(params);
+      await hooks.modifyHtmlPartials.call({
+        entrypoint: params.entrypoint,
+        partials: getModifyHtmlPartials(params.partials)
+      });
+      return {
+        partials: params.partials
+      };
     },
     commands: async (params) => {
       return hooks.addCommand.call(params);
@@ -67,7 +74,7 @@ function getHookRunners(context) {
     prepare: async () => {
       return hooks.onPrepare.call();
     },
-    filedChange: async (params) => {
+    fileChange: async (params) => {
       return hooks.onFileChanged.call(params);
     },
     beforeCreateCompiler: async (params) => {
@@ -103,20 +110,20 @@ function getHookRunners(context) {
     /**
     * @deprecated
     */
-    registerDev: async (params) => {
-      return hooks.registerDev.call(params);
+    registerDev: async () => {
+      return hooks.registerDev.call();
     },
     /**
     * @deprecated
     */
-    registerBuildPlatform: async (params) => {
-      return hooks.registerBuildPlatform.call(params);
+    registerBuildPlatform: async () => {
+      return hooks.registerBuildPlatform.call();
     },
     /**
     * @deprecated
     */
-    addRuntimeExports: async (params) => {
-      return hooks.addRuntimeExports.call(params);
+    addRuntimeExports: async () => {
+      return hooks.addRuntimeExports.call();
     }
   };
 }

package/dist/esm-node/{new/compat → compat}/index.js

@@ -28,7 +28,10 @@ const compatPlugin = () => ({
   registryHooks: {
     appendEntryCode: createCollectAsyncHook()
   },
-  setup: (_api) => {
+  setup: (api) => {
+    api.updateAppContext({
+      toolsType: "app-tools"
+    });
   }
 });
 export {

package/dist/esm-node/{new/compat → compat}/utils.js

@@ -16,7 +16,7 @@ function transformHookRunner(hookRunnerName) {
       return "addCommand";
     case "watchFiles":
       return "addWatchFiles";
-    case "filedChange":
+    case "fileChange":
       return "onFileChanged";
     case "beforeCreateCompiler":
       return "onBeforeCreateCompiler";
@@ -50,6 +50,15 @@ function transformHookParams(hookRunnerName, params) {
       return {
         resolved: params
       };
+    case "htmlPartials":
+      return {
+        partials: {
+          top: params.partials.top.current,
+          head: params.partials.head.current,
+          body: params.partials.body.current
+        },
+        entrypoint: params.entrypoint
+      };
     default:
       return params;
   }

package/dist/esm-node/index.js

@@ -1,5 +1,143 @@
-import { appTools } from "./new/index";
-import { initAppContext } from "./new/index";
+import { getLocaleLanguage } from "@modern-js/plugin-i18n/language-detector";
+import { createAsyncHook, createCollectAsyncHook } from "@modern-js/plugin-v2";
+import { castArray } from "@modern-js/uni-builder";
+import { cleanRequireCache, deprecatedCommands, emptyDir, getArgv, getCommand } from "@modern-js/utils";
+import { buildCommand, deployCommand, devCommand, inspectCommand, newCommand, serverCommand, upgradeCommand } from "./commands";
+import { compatPlugin } from "./compat";
+import { DEFAULT_RUNTIME_CONFIG_FILE, DEFAULT_SERVER_CONFIG_FILE } from "./constants";
+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 { generateWatchFiles } from "./utils/generateWatchFiles";
+import { initAppContext } from "./utils/initAppContext";
+import { restart } from "./utils/restart";
+export * from "./defineConfig";
+const appTools = (options = {
+  // default webpack to be compatible with original projects
+  bundler: "webpack"
+}) => ({
+  name: "@modern-js/app-tools",
+  usePlugins: [
+    compatPlugin(),
+    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()
+  ],
+  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"
+  ],
+  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: createCollectAsyncHook(),
+    registerBuildPlatform: createCollectAsyncHook(),
+    addRuntimeExports: createAsyncHook()
+  },
+  setup: (api) => {
+    var _userConfig_output;
+    const context = api.getAppContext();
+    const userConfig = api.getConfig();
+    const locale = getLocaleLanguage();
+    i18n.changeLanguage({
+      locale
+    });
+    api.updateAppContext(initAppContext({
+      appDirectory: context.appDirectory,
+      options: {},
+      serverConfigFile: DEFAULT_SERVER_CONFIG_FILE,
+      runtimeConfigFile: DEFAULT_RUNTIME_CONFIG_FILE,
+      tempDir: (_userConfig_output = userConfig.output) === null || _userConfig_output === void 0 ? void 0 : _userConfig_output.tempDir
+    }));
+    api.addCommand(async ({ 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);
+    });
+    api.onPrepare(async () => {
+      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.getNormalizedConfig();
+        if (resolvedConfig.output.cleanDistPath) {
+          const appContext = api.getAppContext();
+          await emptyDir(appContext.distDirectory);
+        }
+      }
+    });
+    api.addWatchFiles(async () => {
+      const appContext = api.getAppContext();
+      const config = api.getNormalizedConfig();
+      const files = await generateWatchFiles(appContext, 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;
+    });
+    api.onFileChanged(async (e) => {
+      const { filename, eventType, isPrivate } = e;
+      if (!isPrivate && (eventType === "change" || eventType === "unlink")) {
+        const { closeServer } = await import("./utils/createServer.js");
+        await closeServer();
+        await restart(api.getHooks(), filename);
+      }
+    });
+    api.onBeforeRestart(() => {
+      cleanRequireCache([
+        require.resolve("./plugins/analyze")
+      ]);
+    });
+  }
+});
 import { defineConfig, defineLegacyConfig } from "./defineConfig";
 import { mergeConfig } from "@modern-js/core";
 import { dev } from "./commands/dev";

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

@@ -22,10 +22,10 @@ const ifAlreadyExists = (entrypoints, checked) => entrypoints.some((entrypoint)
   }
   return false;
 });
-const getBundleEntry = async (hookRunners, appContext, config) => {
+const getBundleEntry = async (hooks, appContext, config) => {
   const { appDirectory, packageName } = appContext;
   const { disableDefaultEntries, entries, entriesDir, mainEntryName } = config.source;
-  const defaults = disableDefaultEntries ? [] : await getFileSystemEntry(hookRunners, appContext, config);
+  const defaults = disableDefaultEntries ? [] : await getFileSystemEntry(hooks, appContext, config);
   if (entries) {
     Object.keys(entries).forEach((name) => {
       const value = entries[name];

package/dist/esm-node/plugins/analyze/getFileSystemEntry.js

@@ -6,8 +6,8 @@ import { isDefaultExportFunction } from "./isDefaultExportFunction";
 const hasIndex = (dir) => findExists(JS_EXTENSIONS.map((ext) => path.resolve(dir, `${INDEX_FILE_NAME}${ext}`)));
 const hasEntry = (dir) => findExists(JS_EXTENSIONS.map((ext) => path.resolve(dir, `${ENTRY_FILE_NAME}${ext}`)));
 const hasServerEntry = (dir) => findExists(JS_EXTENSIONS.map((ext) => path.resolve(dir, `${ENTRY_FILE_NAME}.server${ext}`)));
-const isBundleEntry = async (hookRunners, dir, enableCustomEntry) => {
-  const { entry } = await hookRunners.checkEntryPoint({
+const isBundleEntry = async (hooks, dir, enableCustomEntry) => {
+  const { entry } = await hooks.checkEntryPoint.call({
     path: dir,
     entry: false
   });
@@ -20,7 +20,7 @@ const isBundleEntry = async (hookRunners, dir, enableCustomEntry) => {
   }
   return hasIndex(dir);
 };
-const scanDir = async (hookRunners, dirs, enableCustomEntry) => {
+const scanDir = async (hooks, dirs, enableCustomEntry) => {
   const entries = await Promise.all(dirs.map(async (dir) => {
     const indexFile = hasIndex(dir);
     const customBootstrap = isDefaultExportFunction(indexFile) ? indexFile : false;
@@ -37,7 +37,7 @@ const scanDir = async (hookRunners, dirs, enableCustomEntry) => {
         customBootstrap
       };
     }
-    const entryFile = (await hookRunners.checkEntryPoint({
+    const entryFile = (await hooks.checkEntryPoint.call({
       path: dir,
       entry: false
     })).entry;
@@ -71,7 +71,7 @@ const scanDir = async (hookRunners, dirs, enableCustomEntry) => {
   }
   return entries;
 };
-const getFileSystemEntry = async (hookRunners, appContext, config) => {
+const getFileSystemEntry = async (hooks, appContext, config) => {
   const { appDirectory } = appContext;
   const { source: { entriesDir, disableEntryDirs, enableCustomEntry } } = config;
   let disabledDirs = [];
@@ -81,19 +81,19 @@ const getFileSystemEntry = async (hookRunners, appContext, config) => {
   const src = ensureAbsolutePath(appDirectory, entriesDir || "");
   if (fs.existsSync(src)) {
     if (fs.statSync(src).isDirectory()) {
-      if (await isBundleEntry(hookRunners, src, enableCustomEntry)) {
-        return scanDir(hookRunners, [
+      if (await isBundleEntry(hooks, src, enableCustomEntry)) {
+        return scanDir(hooks, [
           src
         ], enableCustomEntry);
       }
       const dirs = [];
       await Promise.all(fs.readdirSync(src).map(async (filename) => {
         const file = path.join(src, filename);
-        if (fs.statSync(file).isDirectory() && await isBundleEntry(hookRunners, file, enableCustomEntry) && !disabledDirs.includes(file)) {
+        if (fs.statSync(file).isDirectory() && await isBundleEntry(hooks, file, enableCustomEntry) && !disabledDirs.includes(file)) {
           dirs.push(file);
         }
       }));
-      return scanDir(hookRunners, dirs, enableCustomEntry);
+      return scanDir(hooks, dirs, enableCustomEntry);
     } else {
       throw Error(`source.entriesDir accept a directory.`);
     }

package/dist/esm-node/plugins/analyze/getHtmlTemplate.js

@@ -21,7 +21,36 @@ const findPartials = (dir, entryName, position) => {
   }
   return null;
 };
-const getHtmlTemplate = async (entrypoints, api, { appContext, config }) => {
+const getModifyHtmlPartials = (partials) => {
+  const append = (type, ...script) => {
+    script.forEach((item) => {
+      partials[type].push(item);
+    });
+  };
+  const prepend = (type, ...script) => {
+    script.forEach((item) => {
+      partials[type].unshift(item);
+    });
+  };
+  return {
+    top: {
+      append: (...script) => append("top", ...script),
+      prepend: (...script) => prepend("top", ...script),
+      current: partials.top
+    },
+    head: {
+      append: (...script) => append("head", ...script),
+      prepend: (...script) => prepend("head", ...script),
+      current: partials.head
+    },
+    body: {
+      append: (...script) => append("body", ...script),
+      prepend: (...script) => prepend("body", ...script),
+      current: partials.body
+    }
+  };
+};
+const getHtmlTemplate = async (entrypoints, hooks, { appContext, config }) => {
   const { appDirectory, internalDirectory } = appContext;
   const { source: { configDir } } = config;
   const htmlDir = path.resolve(appDirectory, configDir || "", HTML_PARTIALS_FOLDER);
@@ -34,24 +63,20 @@ const getHtmlTemplate = async (entrypoints, api, { appContext, config }) => {
     if (customIndexTemplate) {
       htmlTemplates[entryName] = customIndexTemplate.file;
     } else {
-      const hookRunners = api.useHookRunners();
-      const { partials } = await hookRunners.htmlPartials({
+      const getPartialInitValue = (position) => {
+        const partial = findPartials(htmlDir, name, position);
+        return partial ? [
+          partial.content
+        ] : [];
+      };
+      const partials = {
+        top: getPartialInitValue("top"),
+        head: getPartialInitValue("head"),
+        body: getPartialInitValue("body")
+      };
+      await hooks.modifyHtmlPartials.call({
         entrypoint,
-        partials: [
-          "top",
-          "head",
-          "body"
-        ].reduce((previous, position) => {
-          const found = findPartials(htmlDir, name, position);
-          previous[position] = found ? [
-            found.content
-          ] : [];
-          return previous;
-        }, {
-          top: [],
-          head: [],
-          body: []
-        })
+        partials: getModifyHtmlPartials(partials)
       });
       const templatePath = path.resolve(internalDirectory, entryName, "index.html");
       fs.outputFileSync(templatePath, templates.html(partials), "utf8");
@@ -63,12 +88,12 @@ const getHtmlTemplate = async (entrypoints, api, { appContext, config }) => {
       }
     }
   }
-  api.setAppContext({
-    ...api.useAppContext(),
-    partialsByEntrypoint
-  });
-  return htmlTemplates;
+  return {
+    partialsByEntrypoint,
+    htmlTemplates
+  };
 };
 export {
-  getHtmlTemplate
+  getHtmlTemplate,
+  getModifyHtmlPartials
 };