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

package/CHANGELOG.md

@@ -1,5 +1,24 @@
 # @modern-js/module-tools-docs
 
+## 2.15.0
+
+### Patch Changes
+
+- @modern-js/doc-tools@2.15.0
+- @modern-js/doc-plugin-auto-sidebar@2.15.0
+
+## 2.14.0
+
+### Patch Changes
+
+- 432ac8b: chore(cli): improve commands descriptions
+
+  chore(cli): 优化命令的描述文案
+
+- Updated dependencies [432ac8b]
+  - @modern-js/doc-tools@2.14.0
+  - @modern-js/doc-plugin-auto-sidebar@2.14.0
+
 ## 2.13.4
 
 ### Patch Changes

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

@@ -282,6 +282,37 @@ Path to the tsconfig file
 - type: `string`
 - default: `. /tsconfig.json`
 
+## esbuildOptions
+
+Directly modify [esbuild configuration](https://esbuild.github.io/api/)
+
+- Type: `Function`
+- Default: `c => c`
+
+For example, if we need to modify the file extension of the generated files:
+
+```ts modern.config.ts
+import { defineConfig } from '@modern-js/module-tools';
+
+export default defineConfig({
+  buildConfig: {
+    esbuildOptions: options => {
+      options.outExtension = { '.js': '.mjs' };
+      return options;
+    },
+  },
+});
+```
+
+:::tip
+We have done many extensions based on the original esbuild build. Therefore, when using this configuration, pay attention to the following:
+
+1. Prefer to use the configuration we provide. For example, esbuild does not support target: 'es5', but we support this scenario internally using swc. Setting target: 'es5' through esbuildOptions will result in an error.
+2. Currently, we use enhanced-resolve internally to replace esbuild's resolve algorithm, so modifying esbuild resolve-related configurations is invalid. We plan to switch back in the future.
+3. When using esbuild plugins, you need to add the plugins to the beginning of the plugins array because we also intervene in the entire build process through an esbuild plugin internally. Therefore, custom plugins need to be registered first.
+
+:::
+
 ## externals
 
 Configure external dependencies that will not be packaged into the final bundle

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

@@ -323,6 +323,37 @@ TypeScript 配置文件的路径。
 - 类型： `string`
 - 默认值： `./tsconfig.json`
 
+## esbuildOptions
+
+直接修改[esbuild 配置](https://esbuild.github.io/api/)
+
+- 类型: `Function`
+- 默认值: `c => c`
+
+例如我们需要修改生成文件的后缀：
+
+```js modern.config.ts
+import { defineConfig } from '@modern-js/module-tools';
+
+export default defineConfig({
+  buildConfig: {
+    esbuildOptions: options => {
+      options.outExtension = { '.js': '.mjs' };
+      return option;
+    },
+  },
+});
+```
+
+:::tip
+我们在原本 esbuild 构建的基础上做了许多扩展，因此使用此配置需要注意以下几点：
+
+1. 优先使用我们提供的配置，例如 esbuild 并不支持`target: 'es5'`，但我们内部使用 swc 支持了此场景，此时通过`esbuildOptions`设置`target: 'es5'`会报错。
+2. 目前我们内部使用`enhanced-resolve`替代了 esbuild 的 resolve 解析算法，所以修改 esbuild resolve 相关配置无效，计划在未来会切换回来。
+3. 使用 esbuild 插件时需要将插件加在 plugins 数组的头部，因为我们内部也是通过一个 esbuild 插件介入到整个构建流程中去的，因此需要将自定义插件优先注册。
+
+:::
+
 ## externals
 
 配置外部依赖，不会被打包到最终的 bundle 中。

package/docs/zh/guide/basic/command-preview.md

@@ -11,7 +11,7 @@ sidebar_position: 2
 ```bash
 Usage: modern build [options]
 
-构建模块命令
+构建生产环境产物
 
 Options:
   -w, --watch            使用监听模式构建代码
@@ -41,7 +41,7 @@ Options:
 ```bash
 Usage: modern new [options]
 
-模块化工程方案中执行生成器
+启用可选功能
 
 Options:
   -d, --debug            开启 Debug 模式，打印调试日志信息 (default: false)
@@ -67,7 +67,7 @@ Options:
 ```bash
 Usage: modern dev [options]
 
-本地开发命令
+运行和调试模块
 
 Options:
   -h, --help             display help for command

package/package.json

@@ -5,15 +5,15 @@
   "bugs": "https://github.com/web-infra-dev/modern.js/issues",
   "repository": "web-infra-dev/modern.js",
   "license": "MIT",
-  "version": "2.13.4",
+  "version": "2.15.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.13.4",
-    "@modern-js/doc-tools": "2.13.4"
+    "@modern-js/doc-plugin-auto-sidebar": "2.15.0",
+    "@modern-js/doc-tools": "2.15.0"
   },
   "scripts": {
     "dev": "modern dev",