@modern-js/app-tools 2.32.0 → 2.32.1-alpha.0

package/dist/js/treeshaking/utils/printInstructions.js

@@ -0,0 +1,152 @@
+function asyncGeneratorStep(gen, resolve, reject, _next, _throw, key, arg) {
+    try {
+        var info = gen[key](arg);
+        var value = info.value;
+    } catch (error) {
+        reject(error);
+        return;
+    }
+    if (info.done) {
+        resolve(value);
+    } else {
+        Promise.resolve(value).then(_next, _throw);
+    }
+}
+function _asyncToGenerator(fn) {
+    return function() {
+        var self = this, args = arguments;
+        return new Promise(function(resolve, reject) {
+            var gen = fn.apply(self, args);
+            function _next(value) {
+                asyncGeneratorStep(gen, resolve, reject, _next, _throw, "next", value);
+            }
+            function _throw(err) {
+                asyncGeneratorStep(gen, resolve, reject, _next, _throw, "throw", err);
+            }
+            _next(undefined);
+        });
+    };
+}
+var __generator = this && this.__generator || function(thisArg, body) {
+    var f, y, t, g, _ = {
+        label: 0,
+        sent: function() {
+            if (t[0] & 1) throw t[1];
+            return t[1];
+        },
+        trys: [],
+        ops: []
+    };
+    return(g = {
+        next: verb(0),
+        "throw": verb(1),
+        "return": verb(2)
+    }, typeof Symbol === "function" && (g[Symbol.iterator] = function() {
+        return this;
+    }), g);
+    function verb(n) {
+        return function(v) {
+            return step([
+                n,
+                v
+            ]);
+        };
+    }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while(_)try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [
+                op[0] & 2,
+                t.value
+            ];
+            switch(op[0]){
+                case 0:
+                case 1:
+                    t = op;
+                    break;
+                case 4:
+                    _.label++;
+                    return {
+                        value: op[1],
+                        done: false
+                    };
+                case 5:
+                    _.label++;
+                    y = op[1];
+                    op = [
+                        0
+                    ];
+                    continue;
+                case 7:
+                    op = _.ops.pop();
+                    _.trys.pop();
+                    continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) {
+                        _ = 0;
+                        continue;
+                    }
+                    if (op[0] === 3 && (!t || op[1] > t[0] && op[1] < t[3])) {
+                        _.label = op[1];
+                        break;
+                    }
+                    if (op[0] === 6 && _.label < t[1]) {
+                        _.label = t[1];
+                        t = op;
+                        break;
+                    }
+                    if (t && _.label < t[2]) {
+                        _.label = t[2];
+                        _.ops.push(op);
+                        break;
+                    }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop();
+                    continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) {
+            op = [
+                6,
+                e
+            ];
+            y = 0;
+        } finally{
+            f = t = 0;
+        }
+        if (op[0] & 5) throw op[1];
+        return {
+            value: op[0] ? op[1] : void 0,
+            done: true
+        };
+    }
+};
+import { prettyInstructions, logger } from "@modern-js/utils";
+var printInstructions = function() {
+    var _ref = _asyncToGenerator(function(hookRunners, appContext, config) {
+        var message, instructions;
+        return __generator(this, function(_state) {
+            switch(_state.label){
+                case 0:
+                    message = prettyInstructions(appContext, config);
+                    return [
+                        4,
+                        hookRunners.beforePrintInstructions({
+                            instructions: message
+                        })
+                    ];
+                case 1:
+                    instructions = _state.sent().instructions;
+                    logger.info(instructions);
+                    return [
+                        2
+                    ];
+            }
+        });
+    });
+    return function printInstructions(hookRunners, appContext, config) {
+        return _ref.apply(this, arguments);
+    };
+}();
+export { printInstructions };

package/dist/js/treeshaking/utils/restart.js

@@ -0,0 +1,187 @@
+function asyncGeneratorStep(gen, resolve, reject, _next, _throw, key, arg) {
+    try {
+        var info = gen[key](arg);
+        var value = info.value;
+    } catch (error) {
+        reject(error);
+        return;
+    }
+    if (info.done) {
+        resolve(value);
+    } else {
+        Promise.resolve(value).then(_next, _throw);
+    }
+}
+function _asyncToGenerator(fn) {
+    return function() {
+        var self = this, args = arguments;
+        return new Promise(function(resolve, reject) {
+            var gen = fn.apply(self, args);
+            function _next(value) {
+                asyncGeneratorStep(gen, resolve, reject, _next, _throw, "next", value);
+            }
+            function _throw(err) {
+                asyncGeneratorStep(gen, resolve, reject, _next, _throw, "throw", err);
+            }
+            _next(undefined);
+        });
+    };
+}
+var __generator = this && this.__generator || function(thisArg, body) {
+    var f, y, t, g, _ = {
+        label: 0,
+        sent: function() {
+            if (t[0] & 1) throw t[1];
+            return t[1];
+        },
+        trys: [],
+        ops: []
+    };
+    return g = {
+        next: verb(0),
+        "throw": verb(1),
+        "return": verb(2)
+    }, typeof Symbol === "function" && (g[Symbol.iterator] = function() {
+        return this;
+    }), g;
+    function verb(n) {
+        return function(v) {
+            return step([
+                n,
+                v
+            ]);
+        };
+    }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while(_)try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [
+                op[0] & 2,
+                t.value
+            ];
+            switch(op[0]){
+                case 0:
+                case 1:
+                    t = op;
+                    break;
+                case 4:
+                    _.label++;
+                    return {
+                        value: op[1],
+                        done: false
+                    };
+                case 5:
+                    _.label++;
+                    y = op[1];
+                    op = [
+                        0
+                    ];
+                    continue;
+                case 7:
+                    op = _.ops.pop();
+                    _.trys.pop();
+                    continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) {
+                        _ = 0;
+                        continue;
+                    }
+                    if (op[0] === 3 && (!t || op[1] > t[0] && op[1] < t[3])) {
+                        _.label = op[1];
+                        break;
+                    }
+                    if (op[0] === 6 && _.label < t[1]) {
+                        _.label = t[1];
+                        t = op;
+                        break;
+                    }
+                    if (t && _.label < t[2]) {
+                        _.label = t[2];
+                        _.ops.push(op);
+                        break;
+                    }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop();
+                    continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) {
+            op = [
+                6,
+                e
+            ];
+            y = 0;
+        } finally{
+            f = t = 0;
+        }
+        if (op[0] & 5) throw op[1];
+        return {
+            value: op[0] ? op[1] : void 0,
+            done: true
+        };
+    }
+};
+import { cli } from "@modern-js/core";
+import { chalk, clearConsole, logger, program } from "@modern-js/utils";
+function restart(hooksRunner, filename) {
+    return _restart.apply(this, arguments);
+}
+function _restart() {
+    _restart = _asyncToGenerator(function(hooksRunner, filename) {
+        var hasGetError, err;
+        return __generator(this, function(_state) {
+            switch(_state.label){
+                case 0:
+                    clearConsole();
+                    logger.info("Restart because ".concat(chalk.yellow(filename), " is changed...\n"));
+                    hasGetError = false;
+                    return [
+                        4,
+                        hooksRunner.beforeRestart()
+                    ];
+                case 1:
+                    _state.sent();
+                    _state.label = 2;
+                case 2:
+                    _state.trys.push([
+                        2,
+                        4,
+                        5,
+                        6
+                    ]);
+                    return [
+                        4,
+                        cli.init(cli.getPrevInitOptions())
+                    ];
+                case 3:
+                    _state.sent();
+                    return [
+                        3,
+                        6
+                    ];
+                case 4:
+                    err = _state.sent();
+                    console.error(err);
+                    hasGetError = true;
+                    return [
+                        3,
+                        6
+                    ];
+                case 5:
+                    if (!hasGetError) {
+                        program.parse(process.argv);
+                    }
+                    return [
+                        7
+                    ];
+                case 6:
+                    return [
+                        2
+                    ];
+            }
+        });
+    });
+    return _restart.apply(this, arguments);
+}
+export { restart };

package/dist/js/treeshaking/utils/routes.js

@@ -0,0 +1,153 @@
+function asyncGeneratorStep(gen, resolve, reject, _next, _throw, key, arg) {
+    try {
+        var info = gen[key](arg);
+        var value = info.value;
+    } catch (error) {
+        reject(error);
+        return;
+    }
+    if (info.done) {
+        resolve(value);
+    } else {
+        Promise.resolve(value).then(_next, _throw);
+    }
+}
+function _asyncToGenerator(fn) {
+    return function() {
+        var self = this, args = arguments;
+        return new Promise(function(resolve, reject) {
+            var gen = fn.apply(self, args);
+            function _next(value) {
+                asyncGeneratorStep(gen, resolve, reject, _next, _throw, "next", value);
+            }
+            function _throw(err) {
+                asyncGeneratorStep(gen, resolve, reject, _next, _throw, "throw", err);
+            }
+            _next(undefined);
+        });
+    };
+}
+var __generator = this && this.__generator || function(thisArg, body) {
+    var f, y, t, g, _ = {
+        label: 0,
+        sent: function() {
+            if (t[0] & 1) throw t[1];
+            return t[1];
+        },
+        trys: [],
+        ops: []
+    };
+    return(g = {
+        next: verb(0),
+        "throw": verb(1),
+        "return": verb(2)
+    }, typeof Symbol === "function" && (g[Symbol.iterator] = function() {
+        return this;
+    }), g);
+    function verb(n) {
+        return function(v) {
+            return step([
+                n,
+                v
+            ]);
+        };
+    }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while(_)try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [
+                op[0] & 2,
+                t.value
+            ];
+            switch(op[0]){
+                case 0:
+                case 1:
+                    t = op;
+                    break;
+                case 4:
+                    _.label++;
+                    return {
+                        value: op[1],
+                        done: false
+                    };
+                case 5:
+                    _.label++;
+                    y = op[1];
+                    op = [
+                        0
+                    ];
+                    continue;
+                case 7:
+                    op = _.ops.pop();
+                    _.trys.pop();
+                    continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) {
+                        _ = 0;
+                        continue;
+                    }
+                    if (op[0] === 3 && (!t || op[1] > t[0] && op[1] < t[3])) {
+                        _.label = op[1];
+                        break;
+                    }
+                    if (op[0] === 6 && _.label < t[1]) {
+                        _.label = t[1];
+                        t = op;
+                        break;
+                    }
+                    if (t && _.label < t[2]) {
+                        _.label = t[2];
+                        _.ops.push(op);
+                        break;
+                    }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop();
+                    continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) {
+            op = [
+                6,
+                e
+            ];
+            y = 0;
+        } finally{
+            f = t = 0;
+        }
+        if (op[0] & 5) throw op[1];
+        return {
+            value: op[0] ? op[1] : void 0,
+            done: true
+        };
+    }
+};
+import path from "path";
+import { fs, ROUTE_SPEC_FILE } from "@modern-js/utils";
+var generateRoutes = function() {
+    var _ref = _asyncToGenerator(function(appContext) {
+        var serverRoutes, distDirectory, output;
+        return __generator(this, function(_state) {
+            switch(_state.label){
+                case 0:
+                    serverRoutes = appContext.serverRoutes, distDirectory = appContext.distDirectory;
+                    output = JSON.stringify({
+                        routes: serverRoutes
+                    }, null, 2);
+                    return [
+                        4,
+                        fs.outputFile(path.join(distDirectory, ROUTE_SPEC_FILE), output)
+                    ];
+                case 1:
+                    _state.sent();
+                    return [
+                        2
+                    ];
+            }
+        });
+    });
+    return function generateRoutes(appContext) {
+        return _ref.apply(this, arguments);
+    };
+}();
+export { generateRoutes };

package/dist/js/treeshaking/utils/types.js

@@ -0,0 +1 @@
+"use strict";

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

@@ -18,20 +18,22 @@ export declare const HTML_PARTIALS_EXTENSIONS: string[];
 export declare const FILE_SYSTEM_ROUTES_COMPONENTS_DIR = "internal_components";
 export declare const NESTED_ROUTE: {
   LAYOUT_FILE: string;
+  LAYOUT_CONFIG_FILE: string;
   LAYOUT_LOADER_FILE: string;
   LAYOUT_DATA_FILE: string;
   LAYOUT_CLIENT_LOADER: string;
   PAGE_FILE: string;
+  PAGE_CONFIG_FILE: string;
   PAGE_LOADER_FILE: string;
   PAGE_DATA_FILE: string;
   PAGE_CLIENT_LOADER: string;
+  SPLATE_FILE: string;
+  SPLATE_LOADER_FILE: string;
+  SPLATE_DATA_FILE: string;
+  SPLATE_CLIENT_DATA: string;
   LOADING_FILE: string;
   ERROR_FILE: string;
   LOADER_FILE: string;
-  SPLATE_FILE: string;
-  SPLATE_LOADER_FILE: string;
-  LAYOUT_CONFIG_FILE: string;
-  PAGE_CONFIG_FILE: string;
 };
 export declare const APP_CONFIG_NAME = "config";
 export declare const APP_INIT_EXPORTED = "init";

package/dist/types/defineConfig.d.ts

@@ -1,9 +1,12 @@
 import type { UserConfigExport } from '@modern-js/core';
 import type { AppLegacyUserConfig, AppUserConfig } from './types';
+/**
+ * This function helps you to autocomplete configuration types.
+ * It accepts a direct config object, or a function that returns a config.
+ */
 export declare const defineConfig: <B extends "webpack" | "rspack" = "webpack">(config: UserConfigExport<AppUserConfig<B>>) => UserConfigExport<AppUserConfig<B>>;
 /**
- * Recommend use `defineConfig` first.
- *
- * `defineLegacyConfig` will be deprecated in the future.
+ * @deprecated Please use `defineConfig` instead.
+ * `defineLegacyConfig` will be removed in the future major version.
  */
 export declare const defineLegacyConfig: (config: AppLegacyUserConfig) => AppLegacyUserConfig;

package/dist/types/index.d.ts

@@ -9,8 +9,14 @@ export type { RuntimeUserConfig } from './types/config';
 export declare const devCommand: (program: Command, api: PluginAPI<AppTools<'shared'>>) => Promise<void>;
 export declare const buildCommand: (program: Command, api: PluginAPI<AppTools<'shared'>>) => Promise<void>;
 export type AppToolsOptions = {
-  /** Specify the use what kind of bundler to compiler, default: `webpack` */
+  /**
+   * Specify which bundler to use for the build.
+   * @default `webpack`
+   * */
   bundler?: 'experimental-rspack' | 'webpack';
 };
+/**
+ * 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/config/deploy.d.ts

@@ -1,9 +1,22 @@
 export interface MicroFrontend {
+  /**
+   * Specifies whether to enable the HTML entry.
+   * When set to `true`, the current child application will be externalized for `react` and `react-dom`.
+   * @default true
+   */
   enableHtmlEntry?: boolean;
+  /**
+   * Specifies whether to use the external base library.
+   * @default false
+   */
   externalBasicLibrary?: boolean;
   moduleApp?: string;
 }
 export interface DeployUserConfig {
+  /**
+   * Used to configure micro-frontend sub-application information.
+   * @default false
+   */
   microFrontend?: boolean | MicroFrontend;
   worker?: {
     ssr?: boolean;

package/dist/types/types/config/dev.d.ts

@@ -3,9 +3,12 @@ type BuilderDevConfig = Required<SharedBuilderConfig>['dev'];
 export type DevProxyOptions = string | Record<string, string>;
 export interface DevUserConfig extends BuilderDevConfig {
   /**
-   * The configuration of `dev.proxy` is provided by `proxy` plugin.
+   * Used to configure a global proxy based on whistle in the development environment,
+   * which can be used to view and modify HTTP/HTTPS requests, responses, and can also be used as a proxy server.
+   *
+   * @requires `proxy` plugin.
+   * This configuration is provided by `proxy` plugin.
    * Please use `yarn new` or `pnpm new` to enable the corresponding capability.
-   * @requires `proxy` plugin
    */
   proxy?: string | Record<string, string>;
 }

package/dist/types/types/config/output.d.ts

@@ -5,10 +5,30 @@ import { UnwrapBuilderConfig } from '../utils';
 export type BuilderOutputConfig = UnwrapBuilderConfig<WebpackBuilderConfig, 'output'>;
 export type RsBuilderOutputConfig = UnwrapBuilderConfig<RspackBuilderConfig, 'output'>;
 export interface SharedOutputConfig extends BuilderSharedOutputConfig {
+  /**
+   * Enable SSG for self-controlled routing or conventional routing.
+   * @default false
+   */
   ssg?: SSGConfig;
+  /**
+   * When using convention-based routing, the framework will split js and css based on the route to load on demand.
+   * If your project does not want to split js and css based on routes, you can set this option to false.
+   * @default true
+   */
   splitRouteChunks?: boolean;
+  /**
+   * Used to control whether to inject the polyfill of the Node module into the code.
+   * @default true
+   */
   disableNodePolyfill?: boolean;
+  /**
+   * Used to control whether to inject convention-based routing information into the HTML.
+   * @default true
+   */
   enableInlineRouteManifests?: boolean;
+  /**
+   * Specify the temporary directory for framework generated files.
+   */
   tempDir?: string;
 }
 export interface OutputUserConfig extends BuilderOutputConfig, SharedOutputConfig {}

package/dist/types/types/config/source.d.ts

@@ -3,23 +3,60 @@ import type { WebpackBuilderConfig, RspackBuilderConfig } from '../../builder/sh
 export type BuilderSourceConfig = NonNullable<WebpackBuilderConfig['source']>;
 export type RsBuilderSourceConfig = NonNullable<RspackBuilderConfig['source']>;
 export type Entry = string | {
+  /**
+   * The entry file path.
+   */
   entry: string;
+  /**
+   * Disable framework's behavior of automatically generating entry code.
+   */
   disableMount?: boolean;
+  /**
+   * Specify the file path of custom bootstrap.
+   */
   customBootstrap?: string;
 };
 export type Entries = Record<string, Entry>;
 export interface SharedSourceConfig extends BuilderSharedSourceConfig {
+  /**
+   * Used to configure custom page entries.
+   */
   entries?: Entries;
+  /**
+   * Used to configure the main entry name.
+   * @default 'main'
+   */
   mainEntryName?: string;
+  /**
+   * This option is used for Module Federation scenario.
+   * When this option is enabled, framework will wrap the automatically generated entry files with dynamic import.
+   * @default false
+   */
   enableAsyncEntry?: boolean;
+  /**
+   * Used to disable the functionality of automatically identifying page entry points based on directory structure.
+   * @default false
+   */
   disableDefaultEntries?: boolean;
+  /**
+   * By default, framework scans the src directory to identify page entries.
+   * You can customize the directory used for identifying page entries with this option.
+   */
   entriesDir?: string;
+  /**
+   * By default, framework identifies the application entry point based on the `src` directory.
+   * You can use this option to prevent some directories from being recognized as application entry points.
+   */
   disableEntryDirs?: string[];
+  /**
+   * Customize the directory of the framework configuration files.
+   */
   configDir?: string;
   /**
+   * Used to define the project's theme configuration such as color palette.
+   * @requires `tailwindcss` plugin.
    * The configuration of `source.designSystem` is provided by `tailwindcss` plugin.
    * Please use `yarn new` or `pnpm new` to enable the corresponding capability.
-   * @requires `tailwindcss` plugin
    */
   designSystem?: Record<string, any>;
 }