@modern-js/app-tools 2.62.1 → 2.62.2-alpha.0

package/dist/esm-node/old.js

@@ -0,0 +1,140 @@
+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 { 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-old",
+  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 old_default = appTools;
+export {
+  appTools,
+  old_default as default,
+  dev,
+  mergeConfig
+};

package/dist/esm-node/utils/restart.js

@@ -1,4 +1,4 @@
-import { cli } from "@modern-js/core";
+import { cli } from "@modern-js/plugin-v2/cli";
 import { chalk, clearConsole, getFullArgv, logger, program } from "@modern-js/utils";
 async function restart(hooksRunner, filename) {
   clearConsole();

package/dist/types/index.d.ts

@@ -1,20 +1,9 @@
-import type { CliPlugin } from '@modern-js/core';
-import type { AppTools } from './types';
+import { appTools } from './new/index';
+export { appTools, initAppContext, type AppToolsPlugin } from './new/index';
 export { dev } from './commands/dev';
 export type { DevOptions } from './utils/types';
 export { mergeConfig } from '@modern-js/core';
-export * from './defineConfig';
+export { defineConfig, defineLegacyConfig } from './defineConfig';
 export * from './types';
 export type { RuntimeUserConfig } from './types/config';
-export type AppToolsOptions = {
-    /**
-     * Specify which bundler to use for the build.
-     * @default `webpack`
-     * */
-    bundler?: 'rspack' | 'webpack' | 'experimental-rspack';
-};
-/**
- * The core package of the framework, providing CLI commands, build capabilities, configuration parsing and more.
- */
-export declare const appTools: (options?: AppToolsOptions) => CliPlugin<AppTools<'shared'>>;
 export default appTools;

package/dist/types/new/compat/hooks.d.ts

@@ -0,0 +1,8 @@
+import type { InternalContext } from '@modern-js/plugin-v2/types';
+import type { AppToolsNormalizedConfig, AppToolsUserConfig } from '../../types';
+import type { AppToolsExtendAPIName } from '../types';
+/**
+ * old plugin useHookRunners function result
+ */
+export declare function getHookRunners(context: InternalContext<AppToolsUserConfig<'shared'>, AppToolsNormalizedConfig, AppToolsExtendAPIName<'shared'>>): Record<string, any>;
+export declare function handleSetupResult(setupResult: Record<string, (...args: any) => any>, api: Record<string, any>): void;

package/dist/types/new/compat/index.d.ts

@@ -0,0 +1,4 @@
+import type { InternalContext, Plugin } from '@modern-js/plugin-v2/types';
+import type { AppToolsNormalizedConfig, AppToolsUserConfig } from '../../types/config';
+import type { AppTools, AppToolsExtendAPIName } from '../types';
+export declare const compatPlugin: () => Plugin<AppTools<'shared'>, InternalContext<AppToolsUserConfig<'shared'>, AppToolsNormalizedConfig, AppToolsExtendAPIName<'shared'>>>;

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

@@ -0,0 +1,6 @@
+/**
+ * Maps old plugin hook function names to new plugin API names
+ */
+export declare function transformHookRunner(hookRunnerName: string): string;
+export declare function transformHookParams(hookRunnerName: string, params: any): any;
+export declare function transformHookResult(hookRunnerName: string, result: any): any;

package/dist/types/new/constants.d.ts

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

package/dist/types/new/context.d.ts

@@ -0,0 +1,33 @@
+export declare const initAppContext: ({ appDirectory, runtimeConfigFile, options, serverConfigFile, tempDir, }: {
+    appDirectory: string;
+    runtimeConfigFile: string | false;
+    options?: {
+        metaName?: string | undefined;
+        srcDir?: string | undefined;
+        apiDir?: string | undefined;
+        distDir?: string | undefined;
+        sharedDir?: string | undefined;
+    } | undefined;
+    serverConfigFile: string;
+    tempDir?: string | undefined;
+}) => {
+    metaName: string;
+    runtimeConfigFile: string | false;
+    serverConfigFile: string;
+    ip: any;
+    port: number;
+    moduleType: any;
+    apiDirectory: string;
+    lambdaDirectory: string;
+    sharedDirectory: string;
+    distDirectory: string;
+    serverPlugins: never[];
+    internalDirectory: string;
+    htmlTemplates: {};
+    serverRoutes: never[];
+    entrypoints: never[];
+    checkedEntries: never[];
+    apiOnly: boolean;
+    internalDirAlias: string;
+    internalSrcAlias: string;
+};

package/dist/types/new/getConfigFile.d.ts

@@ -0,0 +1 @@
+export declare const getConfigFile: (configFile?: string) => string | false;

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

@@ -0,0 +1,9 @@
+import type { InternalContext, Plugin } from '@modern-js/plugin-v2/types';
+import { type AppToolsOptions } from '../old';
+import type { AppToolsNormalizedConfig, AppToolsUserConfig } from '../types';
+import { initAppContext } from './context';
+import type { AppTools, AppToolsExtendAPIName } from './types';
+export * from '../defineConfig';
+export { initAppContext };
+export type AppToolsPlugin = Plugin<AppTools<'shared'>, InternalContext<AppToolsUserConfig<'shared'>, AppToolsNormalizedConfig, AppToolsExtendAPIName<'shared'>>>;
+export declare const appTools: (options?: AppToolsOptions) => AppToolsPlugin;

package/dist/types/new/loadPlugins.d.ts

@@ -0,0 +1,9 @@
+import type { Plugin } from '@modern-js/plugin-v2/types';
+import type { InternalPlugins } from '@modern-js/types';
+/**
+ * Load internal plugins which in @modern-js scope and user's custom plugins.
+ * @param appDirectory - Application root directory.
+ * @param internalPlugins - Internal plugins.
+ * @returns Plugin Objects has been required.
+ */
+export declare const loadInternalPlugins: (appDirectory: string, internalPlugins?: InternalPlugins, autoLoad?: InternalPlugins, autoLoadPlugins?: boolean) => Promise<Plugin[]>;

package/dist/types/new/run.d.ts

@@ -0,0 +1,13 @@
+import type { InternalPlugins } from '@modern-js/types';
+export interface RunOptions {
+    cwd?: string;
+    configFile?: string;
+    packageJsonConfig?: string;
+    internalPlugins?: {
+        cli?: InternalPlugins;
+        autoLoad?: InternalPlugins;
+    };
+    initialLog?: string;
+    version: string;
+}
+export declare function run({ cwd, initialLog, version, internalPlugins, packageJsonConfig, configFile, }: RunOptions): Promise<void>;

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

@@ -0,0 +1,90 @@
+import type { DevToolData, RegisterBuildPlatformResult } from '@modern-js/core';
+import type { AppContext } from '@modern-js/plugin-v2/types';
+import type { CLIPluginAPI, PluginHookTap, TransformFunction } from '@modern-js/plugin-v2/types';
+import type { Entrypoint, NestedRouteForCli, PageRoute, RouteLegacy, ServerPlugin, ServerRoute } from '@modern-js/types';
+import type { AppToolsNormalizedConfig, AppToolsUserConfig } from '../../types/config';
+import type { RuntimePlugin } from '../../types/hooks';
+import type { Bundler } from '../../types/utils';
+import type { getHookRunners } from '../compat/hooks';
+export type BeforeConfigFn = () => Promise<void> | void;
+export type AfterPrepareFn = () => Promise<void> | void;
+export type InternalRuntimePluginsFn = TransformFunction<{
+    entrypoint: Entrypoint;
+    plugins: RuntimePlugin[];
+}>;
+export type InternalServerPluginsFn = TransformFunction<{
+    plugins: ServerPlugin[];
+}>;
+export type CheckEntryPointFn = TransformFunction<{
+    path: string;
+    entry: false | string;
+}>;
+export type ModifyEntrypointsFn = TransformFunction<Entrypoint[]>;
+export type ModifyFileSystemRoutesFn = TransformFunction<{
+    entrypoint: Entrypoint;
+    routes: RouteLegacy[] | (NestedRouteForCli | PageRoute)[];
+}>;
+export type ModifyServerRoutesFn = TransformFunction<{
+    routes: ServerRoute[];
+}>;
+export type DeplpoyFn = () => Promise<void> | void;
+export type GenerateEntryCodeFn = (entrypoints: Entrypoint[]) => Promise<void> | void;
+export type BeforeGenerateRoutesFn = TransformFunction<{
+    entrypoint: Entrypoint;
+    code: string;
+}>;
+export type BeforePrintInstructionsFn = TransformFunction<{
+    instructions: string;
+}>;
+export type RegisterDevFn = () => Promise<DevToolData> | DevToolData;
+export type RegisterBuildPlatformFn = () => Promise<RegisterBuildPlatformResult> | RegisterBuildPlatformResult;
+export type AddRuntimeExportsFn = () => Promise<void> | void;
+interface AppToolsExtendAPI<B extends Bundler = 'webpack'> {
+    onBeforeConfig: PluginHookTap<BeforeConfigFn>;
+    onAfterPrepare: PluginHookTap<AfterPrepareFn>;
+    deploy: PluginHookTap<DeplpoyFn>;
+    _internalRuntimePlugins: PluginHookTap<InternalRuntimePluginsFn>;
+    _internalServerPlugins: PluginHookTap<InternalServerPluginsFn>;
+    checkEntryPoint: PluginHookTap<CheckEntryPointFn>;
+    modifyEntrypoints: PluginHookTap<ModifyEntrypointsFn>;
+    modifyFileSystemRoutes: PluginHookTap<ModifyFileSystemRoutesFn>;
+    modifyServerRoutes: PluginHookTap<ModifyServerRoutesFn>;
+    generateEntryCode: PluginHookTap<GenerateEntryCodeFn>;
+    onBeforeGenerateRoutes: PluginHookTap<BeforeGenerateRoutesFn>;
+    /**
+     * @deprecated
+     */
+    onBeforePrintInstructions: PluginHookTap<BeforePrintInstructionsFn>;
+    /**
+     * @deprecated
+     */
+    registerDev: PluginHookTap<RegisterDevFn>;
+    /**
+     * @deprecated
+     */
+    registerBuildPlatform: PluginHookTap<RegisterBuildPlatformFn>;
+    /**
+     * @deprecated
+     */
+    addRuntimeExports: PluginHookTap<AddRuntimeExportsFn>;
+    /**
+     * @deprecated use getAppContext instead
+     */
+    useAppContext: () => AppContext<AppToolsUserConfig<B>, AppToolsNormalizedConfig<AppToolsUserConfig<B>>>;
+    /**
+     * @deprecated use getConfig instead
+     */
+    useConfigContext: () => AppToolsUserConfig<B>;
+    /**
+     * @deprecated use getNormalizedConfig instead
+     */
+    useResolvedConfigContext: () => AppToolsNormalizedConfig<AppToolsUserConfig<B>>;
+    /**
+     * @deprecated use api.xx instead
+     */
+    useHookRunners: () => ReturnType<typeof getHookRunners>;
+}
+export interface AppTools<B extends Bundler = 'webpack'> extends CLIPluginAPI<AppToolsUserConfig<B>, AppToolsNormalizedConfig<AppToolsUserConfig<B>>>, AppToolsExtendAPI<B> {
+}
+export type AppToolsExtendAPIName<B extends Bundler = 'webpack'> = keyof AppToolsExtendAPI<B> & string;
+export {};

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

@@ -0,0 +1 @@
+export declare function getIsAutoLoadPlugins(appDirectory: string, configFile?: string, packageJsonConfig?: string): Promise<boolean>;

package/dist/types/old.d.ts

@@ -0,0 +1,13 @@
+import type { CliPlugin } from '@modern-js/core';
+import type { AppTools, AppToolsOptions } from './types';
+export { dev } from './commands/dev';
+export type { DevOptions } from './utils/types';
+export { mergeConfig } from '@modern-js/core';
+export * from './defineConfig';
+export * from './types';
+export type { RuntimeUserConfig } from './types/config';
+/**
+ * The core package of the framework, providing CLI commands, build capabilities, configuration parsing and more.
+ */
+export declare const appTools: (options?: AppToolsOptions) => CliPlugin<AppTools<'shared'>>;
+export default appTools;

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

@@ -24,3 +24,10 @@ export type AppNormalizedConfig<B extends Bundler = 'webpack'> = NormalizedConfi
 export type AppLegacyNormalizedConfig = NormalizedConfig<LegacyAppTools>;
 export type AppUserConfig<B extends Bundler = 'webpack'> = UserConfig<AppTools<B>>;
 export type AppLegacyUserConfig = UserConfig<LegacyAppTools>;
+export type AppToolsOptions = {
+    /**
+     * Specify which bundler to use for the build.
+     * @default `webpack`
+     * */
+    bundler?: 'rspack' | 'webpack' | 'experimental-rspack';
+};

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

@@ -1,3 +1,3 @@
-import { type ToRunners } from '@modern-js/core';
+import type { ToRunners } from '@modern-js/core';
 import type { AppToolsHooks } from '../types/hooks';
 export declare function restart(hooksRunner: ToRunners<AppToolsHooks>, filename: string): Promise<void>;

package/package.json

@@ -15,7 +15,7 @@
     "modern",
     "modern.js"
   ],
-  "version": "2.62.1",
+  "version": "2.62.2-alpha.0",
   "jsnext:source": "./src/index.ts",
   "types": "./dist/types/index.d.ts",
   "main": "./dist/cjs/index.js",
@@ -34,6 +34,11 @@
       "jsnext:source": "./src/index.ts",
       "default": "./dist/cjs/index.js"
     },
+    "./cli/run": {
+      "types": "./dist/types/new/run.d.ts",
+      "jsnext:source": "./src/new/run.ts",
+      "default": "./dist/cjs/new/run.js"
+    },
     "./types": {
       "types": "./lib/types.d.ts",
       "jsnext:source": "./lib/types.d.ts",
@@ -58,6 +63,9 @@
       ".": [
         "./dist/types/index.d.ts"
       ],
+      "cli/run": [
+        "./dist/types/new/run.d.ts"
+      ],
       "types": [
         "./lib/types.d.ts"
       ],
@@ -88,19 +96,20 @@
     "mlly": "^1.6.1",
     "pkg-types": "^1.1.0",
     "std-env": "^3.7.0",
+    "@modern-js/plugin-v2": "2.60.6",
     "@modern-js/core": "2.62.1",
-    "@modern-js/node-bundle-require": "2.62.1",
     "@modern-js/plugin": "2.62.1",
-    "@modern-js/plugin-data-loader": "2.62.1",
     "@modern-js/plugin-i18n": "2.62.1",
+    "@modern-js/plugin-data-loader": "2.62.1",
     "@modern-js/prod-server": "2.62.1",
-    "@modern-js/server": "2.62.1",
-    "@modern-js/server-core": "2.62.1",
     "@modern-js/rsbuild-plugin-esbuild": "2.62.1",
-    "@modern-js/types": "2.62.1",
-    "@modern-js/server-utils": "2.62.1",
+    "@modern-js/node-bundle-require": "2.62.1",
+    "@modern-js/server": "2.62.1",
     "@modern-js/uni-builder": "2.62.1",
-    "@modern-js/utils": "2.62.1"
+    "@modern-js/server-utils": "2.62.1",
+    "@modern-js/server-core": "2.62.1",
+    "@modern-js/utils": "2.62.1",
+    "@modern-js/types": "2.62.1"
   },
   "devDependencies": {
     "@rsbuild/plugin-webpack-swc": "~1.0.3",
@@ -112,8 +121,8 @@
     "tsconfig-paths": "^4.2.0",
     "typescript": "^5",
     "webpack": "^5.96.1",
-    "@scripts/jest-config": "2.62.1",
-    "@scripts/build": "2.62.1"
+    "@scripts/build": "2.62.1",
+    "@scripts/jest-config": "2.62.1"
   },
   "peerDependencies": {
     "ts-node": "^10.7.0",
@@ -130,8 +139,7 @@
   "sideEffects": false,
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
-    "access": "public",
-    "provenance": true
+    "access": "public"
   },
   "scripts": {
     "new": "modern-lib new",