@modern-js/module-tools-docs 2.3.0 → 2.4.1-beta.0

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

@@ -285,6 +285,44 @@ Generates code for the node environment by default, you can also specify `browse
 - type: `'browser' | 'node'`
 - default: `node`
 
+## sideEffects
+
+Module sideEffects
+
+- Type: `RegExg[] | (filePath: string, isExternal: boolean) => boolean | boolean`
+- Default value: `undefined`
+
+Normally, we configure the module's side effects via the sideEffects field in package.json, but in some cases, such as when we reference a three-party package style file
+
+```js
+import 'other-package/dist/index.css'
+```
+
+But the package.json of this three-party package does not have the style file configured in the sideEffects
+
+```json other-package/package.json
+{
+  "sideEffects": ["dist/index.js"]
+}
+```
+
+This is the time to use this configuration item, which supports regular and functional forms
+
+```js modern.config.ts
+import { defineConfig } from '@modern-js/module-tools';
+export default defineConfig({
+  buildConfig: {
+    sideEffects: [/\.css$/],
+    // or
+    // sideEffects: (filePath, isExternal) => /\.css$/.test(filePath),
+  },
+});
+```
+
+:::tip
+After adding this configuration, the sideEffects field in package.json will no longer be read when packaging
+:::
+
 ## sourceDir
 
 Specify the source directory of the build, default is `src`, which is used to generate the corresponding product directory based on the source directory structure when building `bundleless`.

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

@@ -50,17 +50,17 @@ export const buildConfig = [
     format: 'cjs',
     target: 'es6',
     buildType: 'bundle',
-    outDir: '. /lib',
+    outDir: './dist/lib',
   },
   {
     format: 'esm',
     target: 'es6',
     buildType: 'bundle',
-    outDir: '. /es',
+    outDir: './dist/es',
   },
   {
     buildType: 'bundle',
-    outDir: '. /types',
+    outDir: './dist/types',
     dts: {
       only: true,
     },
@@ -89,23 +89,23 @@ export const buildConfig = [
     format: 'cjs',
     target: 'es6',
     buildType: 'bundle',
-    outDir: '. /lib',
+    outDir: './dist/lib',
   },
   {
     format: 'esm',
     target: 'es6',
     buildType: 'bundle',
-    outDir: '. /es',
+    outDir: './dist/es',
   },
   {
     format: 'umd',
     target: 'es6',
     buildType: 'bundle',
-    outDir: '. /umd',
+    outDir: './dist/umd',
   },
   {
     buildType: 'bundle',
-    outDir: '. /types',
+    outDir: './dist/types',
     dts: {
       only: true,
     },
@@ -135,17 +135,17 @@ export const buildConfig = [
     format: 'cjs',
     target: 'es6',
     buildType: 'bundleless',
-    outDir: '. /lib',
+    outDir: './dist/lib',
   },
   {
     format: 'esm',
     target: 'es6',
     buildType: 'bundleless',
-    outDir: '. /es',
+    outDir: './dist/es',
   },
   {
     buildType: 'bundleless',
-    outDir: '. /types',
+    outDir: './dist/types',
     dts: {
       only: true,
     },
@@ -172,23 +172,23 @@ export const buildConfig = [
     format: 'cjs',
     target: 'es6',
     buildType: 'bundleless',
-    outDir: '. /lib',
+    outDir: './dist/lib',
   },
   {
     format: 'esm',
     target: 'es6',
     buildType: 'bundleless',
-    outDir: '. /es',
+    outDir: './dist/es',
   },
   {
     format: 'umd',
     target: 'es6',
     buildType: 'bundle',
-    outDir: '. /umd',
+    outDir: './dist/umd',
   },
   {
     buildType: 'bundleless',
-    outDir: '. /types',
+    outDir: './dist/types',
     dts: {
       only: true,
     },

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

@@ -342,6 +342,44 @@ export default defineConfig({
 - 类型： `'browser' | 'node'`
 - 默认值： `node`
 
+## sideEffects
+
+配置模块的副作用
+
+- 类型： `RegExg[] | (filePath: string, isExternal: boolean) => boolean | boolean`
+- 默认值： `undefined`
+
+通常情况下，我们通过 package.json 的 `"sideEffects"` 字段来配置模块的副作用，但是在某些情况下，例如我们引用了一个三方包的样式文件。
+
+```js
+import 'other-package/dist/index.css'
+```
+
+但是这个三方包的 package.json 里并没有将样式文件配置到 `"sideEffects"` 里。
+
+```json other-package/package.json
+{
+  "sideEffects": ["dist/index.js"]
+}
+```
+
+这时候就可以使用这个配置项，支持正则和函数形式。
+
+```js modern.config.ts
+import { defineConfig } from '@modern-js/module-tools';
+export default defineConfig({
+  buildConfig: {
+    sideEffects: [/\.css$/],
+    // or
+    // sideEffects: (filePath, isExternal) => /\.css$/.test(filePath),
+  },
+});
+```
+
+:::tip
+添加此配置后，打包时将不会再读取 package.json 里的 `"sideEffects"` 字段。
+:::
+
 ## sourceDir
 
 指定构建的源码目录,默认为 `src`，用于在 `bundleless` 构建时基于源码目录结构生成对应的产物目录。
@@ -619,7 +657,7 @@ const tailwind = {
 - 类型： `Record<string, string>`
 - 默认值： `{}`
 
-```js modern.config.ts
+```ts modern.config.ts
 import { defineConfig } from '@modern-js/module-tools';
 
 export default defineConfig({

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

@@ -50,17 +50,17 @@ export const buildConfig = [
     format: 'cjs',
     target: 'es6',
     buildType: 'bundle',
-    outDir: './lib',
+    outDir: './dist/lib',
   },
   {
     format: 'esm',
     target: 'es6',
     buildType: 'bundle',
-    outDir: './es',
+    outDir: './dist/es',
   },
   {
     buildType: 'bundle',
-    outDir: './types',
+    outDir: './dist/types',
     dts: {
       only: true,
     },
@@ -89,23 +89,23 @@ export const buildConfig = [
     format: 'cjs',
     target: 'es6',
     buildType: 'bundle',
-    outDir: './lib',
+    outDir: './dist/lib',
   },
   {
     format: 'esm',
     target: 'es6',
     buildType: 'bundle',
-    outDir: './es',
+    outDir: './dist/es',
   },
   {
     format: 'umd',
     target: 'es6',
     buildType: 'bundle',
-    outDir: './umd',
+    outDir: './dist/umd',
   },
   {
     buildType: 'bundle',
-    outDir: './types',
+    outDir: './dist/types',
     dts: {
       only: true,
     },
@@ -135,17 +135,17 @@ export const buildConfig = [
     format: 'cjs',
     target: 'es6',
     buildType: 'bundleless',
-    outDir: './lib',
+    outDir: './dist/lib',
   },
   {
     format: 'esm',
     target: 'es6',
     buildType: 'bundleless',
-    outDir: './es',
+    outDir: './dist/es',
   },
   {
     buildType: 'bundleless',
-    outDir: './types',
+    outDir: './dist/types',
     dts: {
       only: true,
     },
@@ -172,23 +172,23 @@ export const buildConfig = [
     format: 'cjs',
     target: 'es6',
     buildType: 'bundleless',
-    outDir: './lib',
+    outDir: './dist/lib',
   },
   {
     format: 'esm',
     target: 'es6',
     buildType: 'bundleless',
-    outDir: './es',
+    outDir: './dist/es',
   },
   {
     format: 'umd',
     target: 'es6',
     buildType: 'bundle',
-    outDir: './umd',
+    outDir: './dist/umd',
   },
   {
     buildType: 'bundleless',
-    outDir: './types',
+    outDir: './dist/types',
     dts: {
       only: true,
     },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@modern-js/module-tools-docs",
-  "version": "2.3.0",
+  "version": "2.4.1-beta.0",
   "description": "docs",
   "main": "index.js",
   "keywords": [],
@@ -11,8 +11,8 @@
     "react": "^18.2.0",
     "react-dom": "^18.2.0",
     "shiki": "^0.11.1",
-    "@modern-js/doc-tools": "2.3.0",
-    "@modern-js/doc-plugin-auto-sidebar": "2.3.0"
+    "@modern-js/doc-plugin-auto-sidebar": "2.4.1-beta.0",
+    "@modern-js/doc-tools": "2.4.1-beta.0"
   },
   "scripts": {
     "dev": "modern dev",