@modern-js/module-tools-docs 2.28.0 → 2.29.0

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # @modern-js/module-tools-docs
 
+## 2.29.0
+
+### Patch Changes
+
+- @modern-js/doc-plugin-auto-sidebar@2.29.0
+- @modern-js/doc-tools@2.29.0
+
 ## 2.28.0
 
 ### Patch Changes

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

@@ -217,7 +217,7 @@ Whether to require peerDep dependencies for external projects
 The build type, `bundle` will package your code, `bundleless` will only do the code conversion
 
 - **Type**: `'bundle' | 'bundleless'`
-- **Default**: `bundle`
+- **Default**: `'bundle'`
 
 ## copy
 
@@ -346,15 +346,37 @@ When this configuration is disabled, there is no guarantee that the type files w
 The output path of the dts file, based on [outDir](/api/config/build-config#outDir)
 
 - **Type**: `string`
-- **Default**: `. /types`
+- **Default**: `./`
+
+For example, output to the `types` directory under the `outDir`:
+
+```js modern.config.ts
+export default defineConfig({
+  buildConfig: {
+    dts: {
+      distPath: './types',
+    },
+  },
+});
+```
 
 ## dts.only
 
-Generate only dts files, not js files
+Whether to generate only type files during the build process without generating JavaScript output files.
 
 - **Type**: `boolean`
 - **Default**: `false`
 
+```js modern.config.ts
+export default defineConfig({
+  buildConfig: {
+    dts: {
+      only: true,
+    },
+  },
+});
+```
+
 ## dts.respectExternal
 
 When set to `false`, the type of third-party packages will be excluded from the bundle, when set to `true`, it will determine whether third-party types need to be bundled based on [externals](#externals).
@@ -365,6 +387,16 @@ So we can avoid it with this configuration.
 - **Type**: `boolean`
 - **Default**: `true`
 
+```js modern.config.ts
+export default defineConfig({
+  buildConfig: {
+    dts: {
+      respectExternal: false,
+    },
+  },
+});
+```
+
 ## dts.tsconfigPath
 
 Path to the tsconfig file
@@ -372,11 +404,22 @@ Path to the tsconfig file
 - **Type**: `string`
 - **Default**: `. /tsconfig.json`
 
+```js modern.config.ts
+export default defineConfig({
+  buildConfig: {
+    dts: {
+      tsconfigPath: './other-tsconfig.json',
+    },
+  },
+});
+```
+
 ## esbuildOptions
 
 Used to modify the [esbuild configuration](https://esbuild.github.io/api/).
 
 - **Type**: `Function`
+- **Build Type**: `Only supported for buildType: 'bundle'`
 - **Default**: `c => c`
 
 For example, if we need to modify the file extension of the generated files:
@@ -645,17 +688,33 @@ export default {
 
 ## outDir
 
-Specifies the output directory of the build
+Specifies the output directory of the build.
 
 - **Type**: `string`
-- **Default**: `dist`
+- **Default**: `./dist`
+
+```js modern.config.ts
+export default defineConfig({
+  buildConfig: {
+    outDir: './dist/esm',
+  },
+});
+```
 
 ## platform
 
 Generates code for the node environment by default, you can also specify `browser` which will generate code for the browser environment
 
 - **Type**: `'browser' | 'node'`
-- **Default**: `node`
+- **Default**: `'node'`
+
+```js modern.config.ts
+export default defineConfig({
+  buildConfig: {
+    platform: 'browser',
+  },
+});
+```
 
 ## redirect
 

package/docs/en/api/config/build-preset.mdx

@@ -100,6 +100,7 @@ export const buildConfig = [
   {
     format: 'umd',
     target: 'es6',
+    platform: 'browser',
     buildType: 'bundle',
     outDir: './dist/umd',
   },
@@ -183,6 +184,7 @@ export const buildConfig = [
   {
     format: 'umd',
     target: 'es6',
+    platform: 'browser',
     buildType: 'bundle',
     outDir: './dist/umd',
   },

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

@@ -218,7 +218,7 @@ export default defineConfig({
 构建类型，`bundle` 会打包你的代码，`bundleless` 只做代码的转换。
 
 - 类型： `'bundle' | 'bundleless'`
-- 默认值： `bundle`
+- 默认值： `'bundle'`
 
 ## copy
 
@@ -345,16 +345,38 @@ export default defineConfig({
 
 类型文件的输出路径，基于 [outDir](/api/config/build-config#outDir) 进行输出。
 
-- 类型: `string`
-- 默认值: `./types`
+- 类型： `string`
+- 默认值： `./`
+
+比如输出到 `outDir` 下面的 `types` 目录：
+
+```js modern.config.ts
+export default defineConfig({
+  buildConfig: {
+    dts: {
+      distPath: './types',
+    },
+  },
+});
+```
 
 ## dts.only
 
-只生成类型文件，不生成 js 文件。
+是否在构建时只生成类型文件，不生成 JavaScript 产物文件。
 
 - 类型： `boolean`
 - 默认值： `false`
 
+```js modern.config.ts
+export default defineConfig({
+  buildConfig: {
+    dts: {
+      only: true,
+    },
+  },
+});
+```
+
 ## dts.respectExternal
 
 当设为 `false` 时，不会打包任何三方包类型，设为 `true` 时，会根据 [externals](#externals) 来决定是否需要打包三方类型。
@@ -364,6 +386,16 @@ export default defineConfig({
 - 类型： `boolean`
 - 默认值： `true`
 
+```js modern.config.ts
+export default defineConfig({
+  buildConfig: {
+    dts: {
+      respectExternal: false,
+    },
+  },
+});
+```
+
 ## dts.tsconfigPath
 
 TypeScript 配置文件的路径。
@@ -371,12 +403,22 @@ TypeScript 配置文件的路径。
 - 类型： `string`
 - 默认值： `./tsconfig.json`
 
+```js modern.config.ts
+export default defineConfig({
+  buildConfig: {
+    dts: {
+      tsconfigPath: './other-tsconfig.json',
+    },
+  },
+});
+```
+
 ## esbuildOptions
 
 用于修改底层的 [esbuild 配置](https://esbuild.github.io/api/)。
 
-- 类型: `Function`
-- 默认值: `c => c`
+- 类型： `Function`
+- 默认值： `c => c`
 
 例如，我们需要修改生成文件的后缀：
 
@@ -645,17 +687,33 @@ export default defineConfig({
 
 ## outDir
 
-指定构建的输出目录
+指定构建的输出目录。
+
+- 类型： `string`
+- 默认值： `./dist`
 
-- 类型: `string`
-- 默认值: `dist`
+```js modern.config.ts
+export default defineConfig({
+  buildConfig: {
+    outDir: './dist/esm',
+  },
+});
+```
 
 ## platform
 
 默认生成用于 Node.js 环境下的代码，你也可以指定为 `browser`，会生成用于浏览器环境的代码。
 
 - 类型： `'browser' | 'node'`
-- 默认值： `node`
+- 默认值： `'node'`
+
+```js modern.config.ts
+export default defineConfig({
+  buildConfig: {
+    platform: 'browser',
+  },
+});
+```
 
 ## redirect
 

package/docs/zh/api/config/build-preset.mdx

@@ -100,6 +100,7 @@ export const buildConfig = [
   {
     format: 'umd',
     target: 'es6',
+    platform: 'browser',
     buildType: 'bundle',
     outDir: './dist/umd',
   },
@@ -183,6 +184,7 @@ export const buildConfig = [
   {
     format: 'umd',
     target: 'es6',
+    platform: 'browser',
     buildType: 'bundle',
     outDir: './dist/umd',
   },

package/package.json

@@ -9,15 +9,15 @@
     "directory": "packages/document/module-doc"
   },
   "license": "MIT",
-  "version": "2.28.0",
+  "version": "2.29.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.28.0",
-    "@modern-js/doc-tools": "2.28.0"
+    "@modern-js/doc-plugin-auto-sidebar": "2.29.0",
+    "@modern-js/doc-tools": "2.29.0"
   },
   "scripts": {
     "dev": "modern dev",