@modern-js/module-tools-docs 2.15.0 → 2.16.0

package/CHANGELOG.md

@@ -1,5 +1,23 @@
 # @modern-js/module-tools-docs
 
+## 2.16.0
+
+### Minor Changes
+
+- b06f571: docs: 新增 buildConfig api 和更新 plugin-import 内容
+  docs: add buildConfig api content and update plugin-import content
+
+### Patch Changes
+
+- 4e876ab: chore: package.json include the monorepo-relative directory
+
+  chore: 在 package.json 中声明 monorepo 的子路径
+
+- Updated dependencies [628be4b]
+- Updated dependencies [4e876ab]
+  - @modern-js/doc-tools@2.16.0
+  - @modern-js/doc-plugin-auto-sidebar@2.16.0
+
 ## 2.15.0
 
 ### Patch Changes

package/docs/en/api/config/build-config.md

@@ -234,6 +234,15 @@ To prevent excessive global replacement substitution, it is recommended that the
 
 :::
 
+<!-- ## disableSwcTransform
+
+Starting with version 2.16.0, SWC Transform is enabled by default for code transformation. If you want to disable this feature, you can use this configuration. Only Esbuild Transform is used in this case.
+
+The use of SWC Transform can reduce the impact of auxiliary functions on the volume of the constructed product.
+
+* **Type**: `boolean`
+* **Default**: `false` -->
+
 ## dts
 
 The dts file generates the relevant configuration, by default it generates.
@@ -313,6 +322,50 @@ We have done many extensions based on the original esbuild build. Therefore, whe
 
 :::
 
+<!-- ## externalHelpers
+
+By default, the output JS code may depend on helper functions to support the target environment or output format, and these helper functions will be inlined in the file that requires it.
+
+When using SWC Transform for code transformation, you can enable the `externalHelpers` configuration to convert inline helper functions to import them from the external module `@swc/helpers`.
+
+* **Type**: `boolean`
+* **Default**: `false`
+
+Below is a comparison of the product changes before and after using this configuration.
+
+Before enable:
+
+``` js ./dist/index.js
+// helper function
+function asyncGeneratorStep(gen, resolve, reject, _next, _throw, key, arg) {
+  // ...
+}
+// helper function
+function _async_to_generator(fn) {
+  return function() {
+    // use asyncGeneratorStep
+    // ...
+  };
+}
+
+// your code
+export var yourCode = function() {
+  // use _async_to_generator
+}
+```
+
+After enabled:
+
+``` js ./dist/index.js
+// helper functions imported from @swc/helpers
+import { _ as _async_to_generator } from "@swc/helpers/_/_async_to_generator";
+
+// your code
+export var yourCode = function() {
+  // use _async_to_generator
+}
+``` -->
+
 ## externals
 
 Configure external dependencies that will not be packaged into the final bundle
@@ -468,6 +521,13 @@ Whether to generate sourceMap or not
 - type: `boolean | 'inline' | 'external'`
 - default: `false`
 
+<!-- ## sourceType
+
+Sets the format of the source code. By default, the source code will be treated as EsModule. When the source code is using CommonJS, you need to set `commonjs`.
+
+- **Type**: `commonjs` | `module`
+- **Default**: `module` -->
+
 ## splitting
 
 Whether to enable code splitting
@@ -739,6 +799,40 @@ Specify the target environment for the build
 - type: `'es5' | 'es6' | 'es2015' | 'es2016' | 'es2017' | 'es2018' | 'es2019' | 'es2020' | 'es2021' | 'es2022' | 'esnext'`
 - default: `'es6'`
 
+<!-- ## transformImport
+
+Using [SWC](https://swc.rs/) provides the same ability and configuration as [`babel-plugin-import`](https://github.com/umijs/babel-plugin-import).
+
+* **Type**: `Array`
+* **Default**: `[]`
+
+The elements of the array are configuration objects for `babel-plugin-import`, which can be referred to [options](https://github.com/umijs/babel-plugin-import#options)。
+
+**Example:**
+
+```ts
+import moduleTools, { defineConfig} from '@modern-js/module-tools';
+
+export default defineConfig({
+  buildConfig: {
+    transformImport: [
+      // babel-plugin-import`s options config
+      {
+        libraryName: 'foo',
+        style: true,
+      },
+    ],
+  },
+  plugins: [
+    moduleTools(),
+  ],
+});
+```
+
+### Notes
+
+Reference the [Import Plugin - Notes](plugins/official-list/plugin-import.html#Notes) -->
+
 ## umdGlobals
 
 Specify global variables for external import of umd products

package/docs/en/plugins/official-list/plugin-import.mdx

@@ -2,6 +2,12 @@
 
 Using [SWC](https://swc.rs/) provides the same ability and configuration as [`babel-plugin-import`](https://github.com/umijs/babel-plugin-import).
 
+{/*
+:::tip
+[As of @modern-js/module-tools version 2.16.0, this plugin functionality is built into module-tools and is provided by [`transformImport`](api/config/build-config.html#transformimport).]: #
+:::
+*/}
+
 ## Quick Start
 
 ### Install

package/docs/zh/api/config/build-config.md

@@ -275,6 +275,15 @@ export default defineConfig({
 
 :::
 
+<!-- ## disableSwcTransform
+
+从 2.16.0 版本开始，默认开启 SWC Transform 进行代码转换。如果想要关闭该功能，可以使用该配置。此时仅使用 Esbuild Transform。
+
+使用 SWC Transform 可以减小辅助函数对构建产物体积的影响。
+
+* 类型：`boolean`
+* 默认值：`false` -->
+
 ## dts
 
 类型文件生成的相关配置，默认情况会生成。
@@ -354,6 +363,52 @@ export default defineConfig({
 
 :::
 
+<!-- ## externalHelpers
+
+默认情况下，输出的 JS 代码可能会依赖一些辅助函数来支持目标环境或者输出格式，这些辅助函数会被内联在需要它的文件中。
+
+当在使用 SWC Transform 进行代码转换的时候，可以启动 `externalHelpers` 配置，将内联的辅助函数转换为从外部模块 `@swc/helpers` 导入这些辅助函数。
+
+* 类型：`boolean`
+* 默认值：`false`
+
+
+下面是使用该配置前后的产物变化比较。
+
+开启前：
+
+``` js ./dist/index.js
+// 辅助函数
+function asyncGeneratorStep(gen, resolve, reject, _next, _throw, key, arg) {
+  // ...
+}
+// 辅助函数
+function _async_to_generator(fn) {
+  return function() {
+    // use asyncGeneratorStep
+    // ...
+  };
+}
+
+// 你的代码
+export var yourCode = function() {
+  // use _async_to_generator
+}
+```
+
+开启后：
+
+``` js ./dist/index.js
+// 从 @swc/helpers 导入的辅助函数
+import { _ as _async_to_generator } from "@swc/helpers/_/_async_to_generator";
+
+// 你的代码
+export var yourCode = function() {
+  // use _async_to_generator
+}
+``` -->
+
+
 ## externals
 
 配置外部依赖，不会被打包到最终的 bundle 中。
@@ -514,6 +569,13 @@ export default defineConfig({
 - 类型： `boolean | 'inline' | 'external'`
 - 默认值： `false`
 
+<!-- ## sourceType
+
+设置源码的格式。默认情况下，会将源码作为 EsModule 进行处理。当源码使用的是 CommonJS 的时候，需要设置 `commonjs`。
+
+- 类型：`commonjs` | `module`
+- 默认值：`module` -->
+
 ## splitting
 
 是否开启代码分割。
@@ -799,6 +861,41 @@ const tailwind = {
 - 类型： `'es5' | 'es6' | 'es2015' | 'es2016' | 'es2017' | 'es2018' | 'es2019' | 'es2020' | 'es2021' | 'es2022' | 'esnext'`
 - 默认值： `'es6'`
 
+<!-- ## transformImport
+
+提供与 babel-plugin-import 等价的能力和配置，基于 SWC 实现。
+
+* 类型：`Array`
+* 默认值：`[]`
+
+数组元素为一个 babel-plugin-import 的配置对象。配置对象可以参考 [options](https://github.com/umijs/babel-plugin-import#options)。
+
+使用示例：
+
+```ts
+import moduleTools, { defineConfig} from '@modern-js/module-tools';
+
+export default defineConfig({
+  buildConfig: {
+    transformImport: [
+      // babel-plugin-import 的 options 配置
+      {
+        libraryName: 'foo',
+        style: true,
+      },
+    ],
+  },
+  plugins: [
+    moduleTools(),
+  ],
+});
+```
+
+### 注意事项
+
+参考[【Import 插件——注意事项】](plugins/official-list/plugin-import.html#注意事项) -->
+
+
 ## umdGlobals
 
 指定 UMD 产物外部导入的全局变量。

package/docs/zh/plugins/official-list/plugin-import.mdx

@@ -2,6 +2,13 @@
 
 提供与 [babel-plugin-import](https://github.com/umijs/babel-plugin-import) 等价的能力和配置，基于 [SWC](https://swc.rs/) 实现。
 
+{/*
+:::tip
+从 @modern-js/module-tools 2.16.0 版本开始，该插件功能内置在 module-tools 中，由 [`transformImport`](api/config/build-config.html#transformimport)
+配置提供。
+:::
+*/}
+
 ## 快速开始
 
 ### 安装

package/package.json

@@ -3,17 +3,21 @@
   "description": "Shared documentation of Modern.js Module Tools",
   "homepage": "https://modernjs.dev/module-tools",
   "bugs": "https://github.com/web-infra-dev/modern.js/issues",
-  "repository": "web-infra-dev/modern.js",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/web-infra-dev/modern.js",
+    "directory": "packages/document/module-doc"
+  },
   "license": "MIT",
-  "version": "2.15.0",
+  "version": "2.16.0",
   "main": "index.js",
   "dependencies": {
     "@code-hike/mdx": "^0.7.4",
     "react": "^18.2.0",
     "react-dom": "^18.2.0",
     "shiki": "^0.11.1",
-    "@modern-js/doc-plugin-auto-sidebar": "2.15.0",
-    "@modern-js/doc-tools": "2.15.0"
+    "@modern-js/doc-plugin-auto-sidebar": "2.16.0",
+    "@modern-js/doc-tools": "2.16.0"
   },
   "scripts": {
     "dev": "modern dev",