@modern-js/module-tools-docs 2.39.1 → 2.40.0

package/CHANGELOG.md

@@ -1,5 +1,9 @@
 # @modern-js/module-tools-docs
 
+## 2.40.0
+
+## 2.39.2
+
 ## 2.39.1
 
 ## 2.39.0

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

@@ -868,7 +868,8 @@ export default defineConfig({
 
 ## platform
 
-Generates code for the node environment by default, you can also specify `browser` which will generate code for the browser environment
+Generates code for the node environment by default, you can also specify `browser` which will generate code for the browser environment.
+See [esbuild.platform](https://esbuild.github.io/api/#platform) learn more.
 
 - **Type**: `'browser' | 'node'`
 - **Default**: `'node'`
@@ -1022,6 +1023,7 @@ After adding this configuration, the sideEffects field in package.json will no l
 ## sourceDir
 
 Specify the source directory of the build, default is `src`, which is used to generate the corresponding output directory based on the source directory structure when building `bundleless`.
+Same as [esbuild.outbase](https://esbuild.github.io/api/#outbase).
 
 - **Type**: `string`
 - **Default**: `src`
@@ -1042,7 +1044,8 @@ Sets the format of the source code. By default, the source code will be treated
 
 ## splitting
 
-Whether to enable code splitting
+Whether to enable code splitting.
+Only support [format: 'esm'](#format-esm) and [format: 'cjs'](#format-cjs)，see [esbuild.splitting](https://esbuild.github.io/api/#splitting) learn more.
 
 - **Type**: `boolean`
 - **Default**: `false`

package/docs/en/guide/advance/in-depth-about-build.md

@@ -244,7 +244,7 @@ With `buildType: 'bundleless'`, type files are generated using the project's `ts
 
 The **Modern.js Module also supports bundling of type files**, although care needs to be taken when using this feature.
 
-- Some third-party dependencies have incorrect syntax that can cause the bundling process to fail. So in this case, you need to exclude such third-party packages manually with [`buildConfig.externals`](/en/api/config/build-config#externals).
+- Some third-party dependencies have incorrect syntax that can cause the bundling process to fail. So in this case, you need to exclude such third-party packages manually with [`buildConfig.externals`](/en/api/config/build-config#externals) or close [dts.respectExternal](/api/config/build-config#dtsrespectexternal) to external all third-party packages types.
 - It is not possible to handle the case where the type file of a third-party dependency points to a `.ts` file. For example, the `package.json` of a third-party dependency contains something like this: `{"types": ". /src/index.ts"}`.
 
 ### Alias Conversion

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

@@ -20,6 +20,7 @@ Options:
   --platform [platform] Build artifacts for all or specified platforms
   --no-dts disables DTS type file generation and type checking
   --no-clear disables automatic clearing of output directories
+  -c, --config <config>  Specify the path to the config file (default: "modern.config.j(t)s")
   -h, --help Show information about the current command
 ```
 

package/docs/en/guide/faq/build.mdx

@@ -214,6 +214,13 @@ Check if the [`include`](https://www.typescriptlang.org/tsconfig#include) config
 }
 ```
 
+### Bundleless DTS failed
+
+In the bundleless scenario, it's `tsc` that generates the type declaration file directly. You can find the problem file by printing the error message in the terminal. For source code files, it is recommended to fix the type problem, which can better enable reuse of your package. However. if you encounter a type checking problem with a thrid-party package:
+
+1. enable [skipLibCheck](https://www.typescriptlang.org/tsconfig#skipLibCheck) to skip the d.ts check of the thrid-party package.
+2. If the package exports ts files directly, skipLibCheck will not work because it can only skip the d.ts check, so you can only turn off [dts.abortOnError](/api/config/build-config.html#dtsabortonerror) to ignore these errors.
+
 ## Other FAQ
 
 import BuildOtherFAQ from '@site-docs-en/components/faq-build-other';
@@ -239,7 +246,7 @@ import RegisterEsbuildPlugin from '@site-docs-en/components/register-esbuild-plu
 import { defineConfig } from '@modern-js/module-tools';
 
 export default defineConfig(async () => {
-  const { dts } =  await import("@guanghechen/postcss-modules-dts");
+  const { dts } = await import('@guanghechen/postcss-modules-dts');
   return {
     buildConfig: {
       style: {
@@ -247,6 +254,6 @@ export default defineConfig(async () => {
       },
     },
     // custom config
-  }
+  };
 });
 ```

package/docs/en/guide/faq/storybook.mdx

@@ -6,9 +6,7 @@ import BuildStorybookFAQ from '@site-docs-en/components/faq-storybook';
 
 ## Storybook v7 Support
 
-Storybook v7 does not support it yet. Rspack builds are currently planned to be supported in Storybook v7, so progress will be slower.
-
-Related Issue: [#3376](https://github.com/web-infra-dev/modern.js/issues/3376).
+Storybook v7 is now fully supported and has become our recommended version.
 
 ## Using Storybook Addon or other configurations does not work
 

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

@@ -3,7 +3,11 @@
 The Vue plugin provides support for building Vue 3 components. The plugin internally integrates [esbuild-plugin-vue3](https://github.com/pipe01/esbuild-plugin-vue3) and [@vue/babel-plugin-jsx](https://github.com/vuejs/babel-plugin-jsx)。
 
 :::warning
-The current implementation of this plugin integrates directly with the community plugin and therefore does not support writing jsx/tsx in sfc.
+Notice that we have some limitation:
+
+1. The current implementation of this plugin integrates directly with the community plugin and therefore does not support writing jsx/tsx in sfc.
+2. If you want to generate d.ts for the components, please use the official recommendation [vue-tsc](https://www.npmjs.com/package/vue-tsc).
+3. Only support bundle, we recommend to set input to `['src/**/*.vue']` or `['src/index.ts']`.
 :::
 
 ## Quick start
@@ -24,6 +28,10 @@ import { modulePluginVue } from '@modern-js/plugin-module-vue';
 
 export default defineConfig({
   plugins: [moduleTools(), modulePluginVue()],
+  buildType: 'bundle',
+  format: 'esm',
+  input: ['src/index.vue'],
+  dts: false,
 });
 ```
 

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

@@ -864,6 +864,7 @@ export default defineConfig({
 ## platform
 
 默认生成用于 Node.js 环境下的代码，你也可以指定为 `browser`，会生成用于浏览器环境的代码。
+查看[esbuild.platform](https://esbuild.github.io/api/#platform)了解更多。
 
 - 类型： `'browser' | 'node'`
 - 默认值： `'node'`
@@ -1019,6 +1020,7 @@ export default defineConfig({
 ## sourceDir
 
 指定构建的源码目录,默认为 `src`，用于在 `bundleless` 构建时基于源码目录结构生成对应的产物目录。
+等同于[esbuild.outbase](https://esbuild.github.io/api/#outbase)。
 
 - 类型： `string`
 - 默认值： `src`
@@ -1044,6 +1046,7 @@ export default defineConfig({
 ## splitting
 
 是否开启代码分割。
+仅支持 [format: 'esm'](#format-esm) 和 [format: 'cjs'](#format-cjs)，查看[esbuild.splitting](https://esbuild.github.io/api/#splitting)了解更多。
 
 - 类型： `boolean`
 - 默认值： `false`

package/docs/zh/guide/advance/in-depth-about-build.md

@@ -244,7 +244,7 @@ export default defineConfig({
 
 **Modern.js Module 同时还支持对类型文件进行打包**，不过使用该功能的时候需要注意：
 
-- 一些第三方依赖存在错误的语法会导致打包过程失败。因此对于这种情况，需要手动通过 [`buildConfig.externals`](/api/config/build-config#externals) 将这类第三方包排除。
+- 一些第三方依赖存在错误的语法会导致打包过程失败。因此对于这种情况，需要手动通过 [`buildConfig.externals`](/api/config/build-config#externals) 将这类第三方包排除，或者直接关闭[dts.respectExternal](/api/config/build-config#dtsrespectexternal)从而不打包任何三方包类型。
 - 对于第三方依赖的类型文件指向的是一个 `.ts` 文件的情况，目前无法处理。比如第三方依赖的 `package.json` 中存在这样的内容： `{"types": "./src/index.ts"}`。
 
 ### 别名转换

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

@@ -20,6 +20,7 @@ Options:
   --platform [platform]  构建所有或者指定平台的产物
   --no-dts               关闭 DTS 类型文件生成和类型检查
   --no-clear             关闭自动清除产物输出目录的行为
+  -c, --config <config>  指定配置文件（default: "modern.config.j(t)s"）
   -h, --help             展示当前命令的信息
 ```
 

package/docs/zh/guide/faq/build.mdx

@@ -214,6 +214,13 @@ module.exports = {
 }
 ```
 
+### Bundleless DTS failed
+
+在不打包的场景下，是直接 `tsc` 生成类型声明文件。通过终端打印的错误信息，你可以找到问题文件。对于源码文件，推荐将类型问题进行修复，这能够更好地使你的包得到复用。但如果遇到三方包的类型检查问题：
+
+1. 开启 [skipLibCheck](https://www.typescriptlang.org/tsconfig#skipLibCheck) 来跳过三方包的 d.ts 检查。
+2. 如果三方包直接导出 ts 文件， skipLibCheck 将会失效，因为其只能跳过 d.ts 检查，因此你只能关闭[dts.abortOnError](<(/api/config/build-config.html#dtsabortonerror)>)来忽略这些错误。
+
 ## 其他
 
 import BuildOtherFAQ from '@site-docs/components/faq-build-other';
@@ -239,7 +246,7 @@ import RegisterEsbuildPlugin from '@site-docs/components/register-esbuild-plugin
 import { defineConfig } from '@modern-js/module-tools';
 
 export default defineConfig(async () => {
-  const { dts } =  await import("@guanghechen/postcss-modules-dts");
+  const { dts } = await import('@guanghechen/postcss-modules-dts');
   return {
     buildConfig: {
       style: {
@@ -247,6 +254,6 @@ export default defineConfig(async () => {
       },
     },
     // 你的自定义配置
-  }
+  };
 });
 ```

package/docs/zh/guide/faq/storybook.mdx

@@ -6,8 +6,7 @@ import BuildStorybookFAQ from '@site-docs/components/faq-storybook';
 
 ## 支持 Storybook v7
 
-Storybook v7 目前还没支持，目前计划在 Storybook v7 中支持 Rspack 构建，因此进度会慢一些。
-相关 Issue：[#3376](https://github.com/web-infra-dev/modern.js/issues/3376)。
+Storybook v7 目前已全面支持并已成为我们的推荐使用版本。
 
 ## 使用 Storybook Addon 或者其他配置不生效
 

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

@@ -3,7 +3,11 @@
 Vue 插件提供了对 Vue 3 组件构建的支持，插件内部集成了 [esbuild-plugin-vue3](https://github.com/pipe01/esbuild-plugin-vue3) 和 [@vue/babel-plugin-jsx](https://github.com/vuejs/babel-plugin-jsx)。
 
 :::warning
-目前此插件的实现是直接集成社区插件，因此不支持在 sfc 里写 jsx/tsx.
+请注意，此插件仍有一些用法限制：
+
+1. 目前此插件的实现是直接集成社区插件，因此不支持在 sfc 里写 jsx/tsx。
+2. 如果要为组件生成 d.ts，请使用官方推荐方式 [vue-tsc](https://www.npmjs.com/package/vue-tsc)。
+3. 仅支持打包场景，推荐将 input 设置为 `['src/**/*.vue']` 或者 `['src/index.ts']`。
 :::
 
 ## 快速开始
@@ -24,6 +28,10 @@ import { modulePluginVue } from '@modern-js/plugin-module-vue';
 
 export default defineConfig({
   plugins: [moduleTools(), modulePluginVue()],
+  buildType: 'bundle',
+  format: 'esm',
+  input: ['src/index.vue'],
+  dts: false,
 });
 ```
 

package/package.json

@@ -9,14 +9,14 @@
     "directory": "packages/document/module-doc"
   },
   "license": "MIT",
-  "version": "2.39.1",
+  "version": "2.40.0",
   "main": "index.js",
   "devDependencies": {
     "react": "^18.2.0",
     "react-dom": "^18.2.0",
-    "rspress": "1.3.2",
-    "@rspress/shared": "1.3.2",
-    "@modern-js/doc-plugin-auto-sidebar": "2.39.1"
+    "rspress": "1.5.0",
+    "@rspress/shared": "1.5.0",
+    "@modern-js/doc-plugin-auto-sidebar": "2.40.0"
   },
   "scripts": {
     "dev": "rspress dev",