@modern-js/app-tools 2.32.0 → 2.32.1

package/CHANGELOG.md

@@ -1,5 +1,34 @@
 # @modern-js/app-tools
 
+## 2.32.1
+
+### Patch Changes
+
+- 90e053a: feat(app-tools): add comments for configurations and functions
+
+  feat(app-tools): 为配置和函数添加 comments 说明
+
+- Updated dependencies [90e053a]
+  - @modern-js/types@2.32.1
+  - @modern-js/builder-rspack-provider@2.32.1
+  - @modern-js/builder-shared@2.32.1
+  - @modern-js/builder-webpack-provider@2.32.1
+  - @modern-js/core@2.32.1
+  - @modern-js/plugin-data-loader@2.32.1
+  - @modern-js/server-core@2.32.1
+  - @modern-js/prod-server@2.32.1
+  - @modern-js/server@2.32.1
+  - @modern-js/utils@2.32.1
+  - @modern-js/builder@2.32.1
+  - @modern-js/builder-plugin-node-polyfill@2.32.1
+  - @modern-js/builder-plugin-esbuild@2.32.1
+  - @modern-js/plugin-i18n@2.32.1
+  - @modern-js/plugin-lint@2.32.1
+  - @modern-js/new-action@2.32.1
+  - @modern-js/node-bundle-require@2.32.1
+  - @modern-js/plugin@2.32.1
+  - @modern-js/upgrade@2.32.1
+
 ## 2.32.0
 
 ### Minor Changes

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>;
 }

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

@@ -2,7 +2,7 @@ import type { TestConfig } from '@modern-js/types';
 export interface TestingUserConfig {
   /**
    * Decide which transformer will be used to compile file
-   * Default: babel-jest
+   * @default 'babel-jest'
    */
   transformer?: TestConfig['transformer'];
 }

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

@@ -11,20 +11,24 @@ export type RsBuilderToolsConfig = UnwrapBuilderConfig<RspackBuilderConfig, 'too
 export type Tailwindcss = Record<string, any> | ((options: Record<string, any>) => Record<string, any> | void);
 export interface SharedToolsConfig extends BuilderSharedToolsConfig {
   /**
+   * Used to custom Tailwind CSS configurations.
+   * @requires `tailwindcss` plugin.
    * The configuration of `tools.tailwindcss` is provided by `tailwindcss` plugin.
    * Please use `yarn new` or `pnpm new` to enable the corresponding capability.
-   * @requires `tailwindcss` plugin
    */
   tailwindcss?: Tailwindcss;
   /**
+   * Used to custom Jest configurations.
+   * @requires `test` plugin.
    * The configuration of `tools.jest` is provided by `test` plugin.
    * Please use `yarn new` or `pnpm new` to enable the corresponding capability.
-   * @requires `test` plugin
    */
   jest?: JestConfig | ((jestConfig: JestConfig) => JestConfig);
   /**
+   * Used to custom SWC configurations.
+   * @requires `swc` plugin.
    * The configuration of `swc` is provided by `swc` plugin.
-   * @requires `swc` plugin
+   * Please use `yarn new` or `pnpm new` to enable the corresponding capability.
    */
   swc?: PluginSwcOptions<'outer'>;
 }

package/dist/types/types/legacyConfig/testing.d.ts

@@ -2,7 +2,7 @@ import type { TestConfig } from '@modern-js/types';
 export interface TestingLegacyUserConfig {
   /**
    * Decide which transformer will be used to compile file
-   * Default: babel-jest
+   * @default 'babel-jest'
    */
   transformer?: TestConfig['transformer'];
 }

package/package.json

@@ -15,7 +15,7 @@
     "modern",
     "modern.js"
   ],
-  "version": "2.32.0",
+  "version": "2.32.1",
   "jsnext:source": "./src/index.ts",
   "types": "./dist/types/index.d.ts",
   "main": "./dist/cjs/index.js",
@@ -73,24 +73,24 @@
     "esbuild": "0.17.19",
     "rspack-plugin-virtual-module": "0.1.7",
     "@swc/helpers": "0.5.1",
-    "@modern-js/builder": "2.32.0",
-    "@modern-js/builder-plugin-esbuild": "2.32.0",
-    "@modern-js/builder-plugin-node-polyfill": "2.32.0",
-    "@modern-js/builder-shared": "2.32.0",
-    "@modern-js/builder-webpack-provider": "2.32.0",
-    "@modern-js/core": "2.32.0",
-    "@modern-js/new-action": "2.32.0",
-    "@modern-js/node-bundle-require": "2.32.0",
-    "@modern-js/plugin": "2.32.0",
-    "@modern-js/plugin-data-loader": "2.32.0",
-    "@modern-js/plugin-i18n": "2.32.0",
-    "@modern-js/plugin-lint": "2.32.0",
-    "@modern-js/prod-server": "2.32.0",
-    "@modern-js/server": "2.32.0",
-    "@modern-js/types": "2.32.0",
-    "@modern-js/upgrade": "2.32.0",
-    "@modern-js/utils": "2.32.0",
-    "@modern-js/server-core": "2.32.0"
+    "@modern-js/builder": "2.32.1",
+    "@modern-js/builder-plugin-esbuild": "2.32.1",
+    "@modern-js/builder-plugin-node-polyfill": "2.32.1",
+    "@modern-js/builder-shared": "2.32.1",
+    "@modern-js/builder-webpack-provider": "2.32.1",
+    "@modern-js/core": "2.32.1",
+    "@modern-js/new-action": "2.32.1",
+    "@modern-js/node-bundle-require": "2.32.1",
+    "@modern-js/plugin": "2.32.1",
+    "@modern-js/plugin-data-loader": "2.32.1",
+    "@modern-js/plugin-i18n": "2.32.1",
+    "@modern-js/plugin-lint": "2.32.1",
+    "@modern-js/prod-server": "2.32.1",
+    "@modern-js/server": "2.32.1",
+    "@modern-js/types": "2.32.1",
+    "@modern-js/upgrade": "2.32.1",
+    "@modern-js/utils": "2.32.1",
+    "@modern-js/server-core": "2.32.1"
   },
   "devDependencies": {
     "@types/babel__traverse": "^7.14.2",
@@ -99,13 +99,13 @@
     "jest": "^29",
     "typescript": "^5",
     "webpack": "^5.88.1",
-    "@modern-js/builder-plugin-swc": "2.32.0",
-    "@modern-js/builder-rspack-provider": "2.32.0",
-    "@scripts/build": "2.32.0",
-    "@scripts/jest-config": "2.32.0"
+    "@modern-js/builder-plugin-swc": "2.32.1",
+    "@modern-js/builder-rspack-provider": "2.32.1",
+    "@scripts/build": "2.32.1",
+    "@scripts/jest-config": "2.32.1"
   },
   "peerDependencies": {
-    "@modern-js/builder-rspack-provider": "^2.32.0"
+    "@modern-js/builder-rspack-provider": "^2.32.1"
   },
   "peerDependenciesMeta": {
     "@modern-js/builder-rspack-provider": {