@modern-js/module-tools-docs 2.59.0 → 2.60.1

package/doc_build/static/search_index.zh.e818eee4.json

@@ -0,0 +1 @@
+[{"id":46,"title":"buildConfig","content":"#\n\nbuildConfig 是一个用来描述如何编译、生成构建产物的配置项，它包含了构建的所有配置。\n\n * 类型：object | object[]\n\nTIP\n\n在开始使用 buildConfig 之前，请先阅读以下文档来了解其作用：\n\n * 修改输出产物\n * 深入理解构建\n\n\nalias#\n\n * 类型：Record | Function\n * 默认值：{'@': 'src',}\n\nTIP\n\n对于 TypeScript 项目，只需要在 tsconfig.json 中配置 compilerOptions.paths, Modern.js Module\n会自动识别 tsconfig.json 里的别名，因此不需要额外配置 alias 字段。\n\n\n\n以上配置完成后，如果在代码中引用 @common/Foo.tsx, 则会映射到 /src/common/Foo.tsx 路径上。\n\nalias 的值定义为函数时，可以接受预设的 alias 对象，并对其进行修改。\n\n\n\n也可以在函数中返回一个新对象作为最终结果，新对象会覆盖预设的 alias 对象。\n\n\n\n\nasset#\n\n包含静态资源相关的配置。\n\n\nasset.name#\n\n静态资源输出文件名。\n\n * 类型： string | ((assetPath) => name)\n * 默认值： [name].[hash].[ext]\n\n当 asset.name 为 string 类型时，会自动对 [name]、[ext]、[hash] 进行替换，分别替换为文件名、拓展名、文件 hash。\n如果想要更高的自由度，可以把 asset.name 作为方法使用，返回值即为文件名。此时，该方法接收一个参数 assetPath，对应资源路径。\n\n\n\n\nasset.limit#\n\n用于设置静态资源被自动内联为 base64 的体积阈值。\n\nModern.js Module 在进行打包时，默认会内联体积小于 10KB 的图片、字体、媒体等资源，将它们通过 Base64\n编码，并内联到产物中，不再会发送独立的 HTTP 请求。\n\n你可以通过修改 limit 参数来调整这个阈值。\n\n * 类型： number\n * 默认值： 10 * 1024\n\n例如，将 limit 设置为 0 来避免资源内联：\n\n\n\n\nasset.path#\n\n静态资源输出路径，会基于 outDir 进行输出。\n\n * 类型： string\n * 默认值： assets\n\n\nasset.publicPath#\n\n打包时给未内联资源的 CDN 前缀。\n\n * 类型： string\n * 默认值： undefined\n\n\n\n此时，所有静态资源都会添加 https://xxx/ 前缀。\n\n\nasset.svgr#\n\n打包时将 SVG 作为一个 React 组件处理，options 参考 svgr，另外还支持了 include 和 exclude\n两个配置项，用于匹配需要处理的 SVG 文件。\n\n * 类型： boolean | object\n * 默认值： false\n\n开启 svgr 功能后，可以使用默认导出的方式将 SVG 当做组件使用。\n\n\n\n当开启功能后，可以新建一个类型描述文件，并在 modern-app-env.d.ts 文件中增加，修改使用 SVG 的类型：\n\n\n\n\n\n\nasset.svgr.include#\n\n设定匹配的 SVG 文件\n\n * 类型： string | RegExp | (string | RegExp)[]\n * 默认值： /\\.svg$/\n\n\nasset.svgr.exclude#\n\n设定不匹配的 SVG 文件\n\n * 类型： string | RegExp | (string | RegExp)[]\n * 默认值： undefined\n\n\nasset.svgr.exportType#\n\n用于配置使用 SVGR 时 SVG 的导出形式。\n\n * 类型： 'named' | 'default'\n * 默认值： default\n\n当此选项设置为 'named' 时，你可以使用以下语法导入组件：\n\n\n\n命名导出默认为 ReactComponent，并可以通过 asset.svgr.namedExport 进行自定义。\n\n\nautoExtension#\n\n根据 format 和 type 自动添加产物里 js 文件和类型描述文件的后缀。\n\n * 类型：boolean\n * 默认值：false\n * 版本：>=2.38.0\n\n关闭时，js 产物后缀为 .js，类型描述文件后缀为 d.ts。\n\n开启后，当 type 为 module 时，node 默认将 .js 作为 esm 加载，因此当我们要输出 cjs 产物时，js 产物后缀为\n.cjs，类型描述文件后缀为 d.cts; 反之，如果缺少 type 字段或者 type 为 commonjs 时， node 默认将 .js 文件作为 cjs\n加载，因此当我们要输出 esm 产物时，js 产物后缀为 .mjs，类型描述文件后缀为 d.mts。\n\nWARNING\n\n在 bundleless 模式下使用时，我们会有一步额外的操作，那就是处理每个文件里的 import/export 语句。我们会给相对路径加上 js\n文件后缀，可能是 .mjs 或者 .cjs，这取决于你的包配置，此行为可以通过 redirect.autoExtension关闭。\n\n注意 noUselessIndex 规则会破坏此行为，你需要禁用此规则 如果你需要在 bundleless 使用此配置，请补齐 index，例如 utils\n是一个文件夹， 你需要将 改写为\n\n\n\n\nautoExternal#\n\n自动外置项目的 \"dependencies\" 和 \"peerDependencies\"，不会将其打包到最终的 bundle 产物中。\n\n * 类型： boolean | object\n * 默认值： true\n\n当我们希望关闭对于第三方依赖的默认处理行为时候，可以通过以下方式来实现：\n\n\n\n这样对于 \"dependencies\" 和 \"peerDependencies\" 下面的依赖都会进行打包处理。如果只想要关闭其中某个下面的依赖处理，则可以使用\nbuildConfig.autoExternal 的对象形式：\n\n\n\n\nautoExternal.dependencies#\n\n是否需要外置项目的 \"dependencies\" 依赖。\n\n * 类型： boolean\n * 默认值： true\n\n\nautoExternal.peerDependencies#\n\n是否需要外置项目的 \"peerDependencies\" 依赖。\n\n * 类型： boolean\n * 默认值： true\n\n\nbanner#\n\n提供为每个 JS , CSS 和 DTS 文件的顶部和底部注入内容的能力。\n\n\n\n * 类型： BannerAndFooter\n * 默认值: {}\n * 版本： >=2.36.0\n\n例如你想为 JS 和 CSS 文件添加版权信息:\n\n\n\n\nbuildType#\n\n构建类型，bundle 会打包你的代码，bundleless 只做代码的转换。\n\n * 类型： 'bundle' | 'bundleless'\n * 默认值： 'bundle'\n\n\ncopy#\n\n将文件或目录拷贝到指定位置。\n\n * 类型： object\n\n\n\n\ncopy.patterns#\n\n * 类型： CopyPattern[]\n * 默认值： []\n\n\n\n\ncopy.options#\n\n * 类型：\n\n\n\n * 默认值： { concurrency: 100, enableCopySync: false }\n\n * concurrency: 指定并行执行多少个复制任务。\n\n * enableCopySync: 使用 fs.copySync，默认情况下 fs.copy。\n\n\ndefine#\n\n定义全局变量，注入到代码中\n\n * 类型： Record\n * 默认值： {}\n\n由于 define 功能是由全局文本替换实现的，所以需要保证全局变量值为字符串，更为安全的做法是将每个全局变量的值转化为字符串，如下所示：\n\nINFO\n\n框架内部会自动进行 JSON 序列化处理，因此不需要手动执行序列化。\n\n如果不需要自动序列化，可以通过配置 esbuildOptions 定义 alias 来实现。\n\n\n\n不过要注意：如果项目是一个 TypeScript 项目，那么你可能需要在项目源代码目录下的 .d.ts 文件里增加以下内容：\n\n> 如果不存在 d.ts 文件，则可以手动创建。\n\n\n\n我们也可以进行环境变量替换：\n\n\n\n通过上面的配置，我们就可以将下面这段代码：\n\n\n\n在执行 VERSION=1.0.0 modern build 的时候，转换为：\n\n\n\nTIP\n\n为了防止全局替换替换过度，建议使用时遵循以下两个原则：\n\n * 全局常量使用大写\n * 自定义全局常量前缀后缀，确保独一无二\n\n\ndts#\n\n类型文件生成的相关配置，默认情况会生成。\n\n * 类型： false | object\n * 默认值：\n\n\n\n\ndts.abortOnError#\n\n用于控制在出现类型错误的时候，是否允许构建成功。\n\n * 类型：boolean\n * 默认值：true\n\n默认情况下，在出现类型错误的时候会导致构建失败。将 abortOnError 设置为 false 后，即使代码中出现了类型问题，构建依然会成功：\n\n\n\nWARNING\n\n当关闭该配置后，无法保证类型文件能正常生成，且不保证内容正确。在 buildType: 'bundle' 时，即打包模式下，类型文件一定不会生成。\n\n\ndts.distPath#\n\n类型文件的输出路径，基于 outDir 进行输出。\n\n * 类型： string\n * 默认值： ./\n\n比如输出到 outDir 下面的 types 目录：\n\n\n\n\ndts.enableTscBuild#\n\n开启 tsc '--build' 选项。当使用 project reference 时， 可以使用 '--build'\n选项以实现项目之间的协同工作以加快构建速度。\n\n此选项要求版本 > 2.43.0， 事实上，我们在 2.42.0 版本曾试验性地开启此选项，但其带来的许多问题使我们不得不动态开启。\n\n\n\n * 类型： boolean\n * 默认值： false\n * 版本： >2.43.0\n\n\n\n\ndts.only#\n\n是否在构建时只生成类型文件，不生成 JavaScript 产物文件。\n\n * 类型： boolean\n * 默认值： false\n\n\n\n\ndts.respectExternal#\n\n当设为 false 时，不会打包任何三方包类型，设为 true 时，会根据 externals 来决定是否需要打包三方类型。\n\n在对类型文件进行打包时，构建工具还未对 export\n进行分析，因此当你引用的任何一个三方包出现类型错误时，都可能会中断当前的构建流程，这会导致构建流程不可控，因此我们可以通过这个配置来避免该问题。\n\n * 类型： boolean\n * 默认值： true\n\n\n\n\ndts.tsconfigPath#\n\n废弃，使用 tsconfig 配置替代。\n\n指定用于生成类型文件的 tsconfig 文件路径。\n\n\n\n\nesbuildOptions#\n\n用于修改底层的 esbuild 配置。\n\n * 类型： Function\n * 默认值： c => c\n\n例如，我们需要修改生成文件的后缀：\n\n\n\n例如，注册一个 esbuild 插件：\n\n\n\n在增加 esbuild 插件时，请注意你需要将插件加在 plugins 数组的头部，因为 Modern.js Module 内部也是通过一个 esbuild\n插件介入到整个构建流程中去的，因此需要将自定义插件优先注册。\n\nTIP\n\n我们在原本 esbuild 构建的基础上做了许多扩展，因此使用此配置需要注意以下几点：\n\n 1. 优先使用 Modern.js Module 提供的配置，例如 esbuild 并不支持 target: 'es5'，但我们内部使用 SWC\n    支持了此场景，此时通过 esbuildOptions 设置target: 'es5'会报错。\n 2. 目前我们内部使用 enhanced-resolve 替代了 esbuild 的 resolve 解析算法，所以修改 esbuild resolve\n    相关配置无效，计划在未来会切换回来。\n\n\nexternalHelpers#\n\n默认情况下，输出的 JS 代码可能会依赖一些辅助函数来支持目标环境或者输出格式，这些辅助函数会被内联在需要它的文件中。\n\n使用此配置，将会使用 SWC 对代码进行转换，将内联的辅助函数转换为从外部模块 @swc/helpers 导入这些辅助函数。\n\n * 类型：boolean\n * 默认值：false\n\n下面是使用该配置前后的产物变化比较。\n\n开启前：\n\n\n\n开启后：\n\n\n\n\nexternals#\n\n用于在打包时排除一些外部依赖，避免将这些依赖打包到最终的 bundle 中。\n\n * 类型：\n\n\n\n * 默认值： []\n * 构建类型：仅支持 buildType: 'bundle'\n * 示例：\n\n\n\n\nfooter#\n\n同 banner 配置，用于在输出文件末尾添加注释。\n\n\nformat#\n\n用于设置 JavaScript 产物输出的格式，其中 iife 和 umd 只在 buildType 为 bundle 时生效。\n\n * 类型：'esm' | 'cjs' | 'iife' | 'umd'\n * 默认值：cjs\n\n\nformat: esm#\n\nesm 代表 \"ECMAScript 模块\"，它需要运行环境支持 import 和 export 语法。\n\n * 示例：\n\n\n\n\nformat: cjs#\n\ncjs 代表 \"CommonJS\"，它需要运行环境支持 exports、require 和 module 语法，通常为 Node.js 环境。\n\n * 示例：\n\n\n\n\nformat: iife#\n\niife 代表 \"立即调用函数表达式\"，它将代码包裹在函数表达式中，确保代码中的任何变量不会意外地与全局范围中的变量冲突，通常在浏览器环境中运行。\n\n * 示例：\n\n\n\n\nformat: umd#\n\numd 代表 \"Universal Module Definition\"，用于在不同环境（浏览器、Node.js 等）中运行。umd\n格式的模块可以在多种环境下使用，既可以作为全局变量访问，也可以通过模块加载器（如 RequireJS）进行模块化加载。\n\n * 示例：\n\n\n\n\nhooks#\n\n构建生命周期钩子,允许在构建流程的特定阶段注入自定义逻辑。\n\n * 类型：\n\n\n\n * 默认值：[]\n\n我们可以在 apply 方法里拿到 compiler 实例，修改其属性，以及在不同阶段执行自定义逻辑，对于 Hook 的详细介绍， 参考使用 Hook\n介入构建流程。\n\n\n\n\ninput#\n\n指定构建的入口文件，数组形式可以指定目录。\n\n * 类型：\n\n\n\n * 默认值：bundle 模式下默认为 ['src/index.ts']，bundleless 模式下默认为 ['src']\n\n数组用法：\n\n在 bundle 模式下，下面的配置会以 src/index.ts 和 src/index2.ts 为入口分别进行构建。bundle 模式不支持配置 input\n为目录。\n\n\n\n在 bundleless 模式下，下面的配置会同时处理 src/a 目录下的文件和 src/index.ts 文件。\n\n\n\n在 bundleless 模式下，数组模式还支持使用 ! 来过滤部分文件：\n\n\n\n上面的配置将打包 src 目录下的文件，同时会过滤以 spec.ts 为后缀的文件。这在测试文件与源码文件在同一个根目录下的情况会很有用。\n\n对象用法：\n\n当在 bundle 模式下需要修改产物的输出文件名称的时候，可以使用对象形式进行配置。\n\n对象的 Key 是产物的文件名称，Value 是源码的文件路径。\n\n\n\n\njsx#\n\n指定 JSX 的编译方式，默认支持 React 17 及更高版本，自动注入 JSX 运行时代码。\n\n * 类型： automatic | transform | preserve\n * 默认值： automatic\n\n如果你需要支持 React 16，则可以设置 jsx 为 transform：\n\n\n\nTIP\n\n如果你不需要转换 JSX ,可以设置 jsx 为 preserve, 但此时请不要使用 swc 做代码转换。 关于 JSX Transform\n的更多说明，可以参考以下链接：\n\n * React Blog - Introducing the New JSX Transform.\n * esbuild - JSX.\n\n\nloader#\n\n试验性功能\n\n此选项用来更改给定输入文件的解释方式。例如你需要将 js 文件当做 jsx 处理\n\n\n\n\nmetafile#\n\n这个选项用于构建分析，开启该选项后，esbuild 会以 JSON 格式生成有关构建的一些元数据。\n\n * 类型：boolean\n * 默认值：false\n * 构建类型：仅支持 buildType: 'bundle'\n\n开启 metafile 生成：\n\n\n\n在执行 build 构建后，产物目录下会生成 metafile-[xxx].json 文件，你可以通过 esbuild analyze 和\nbundle-buddy 等工具进行可视化分析。\n\n\nminify#\n\n使用 esbuild 或者 terser 压缩代码，也可以传入 terserOptions。\n\n * 类型： 'terser' | 'esbuild' | false | object\n * 默认值： false\n\n\n\n\noutDir#\n\n指定构建的输出目录。\n\n * 类型： string\n * 默认值： ./dist\n\n\n\n\nplatform#\n\n默认生成用于 Node.js 环境下的代码，你也可以指定为 browser，会生成用于浏览器环境的代码。 查看esbuild.platform了解更多。\n\n * 类型： 'browser' | 'node'\n * 默认值： 'node'\n\n\n\n\nredirect#\n\n在 buildType: 'bundleless' 构建模式下，会对引用路径进行重定向，确保指向了正确的产物，例如：\n\n * import './index.less' 会被改写成 import './index.css'\n * 会被改写成 （依实际情况而定）\n * 会被改写成 (如果生成了 utils.mjs，视实际情况而定)\n\n在某些场景下，你可能不需要这些功能，那么可以通过此配置关闭它，关闭后，其引用路径将不会发生改变。\n\n\n\n\nresolve#\n\n自定义模块解析选项\n\n\nresolve.alias#\n\n基本用法和 alias 一致。\n\nalias 的问题在于我们在 bundleless 场景下错误的处理了 Module ID 的情况：\n\n\n\n当我们配置了 alias: { react: 'react-native' } 后，结果会变成\n\n\n\n一个 Module ID 被错误的处理成了相对路径，显然这是不符合预期的。\n\n我们想要修复这个问题，但是这可能会破坏已有的项目，因此我们在 2.58.0 版本提供了 resolve.alias 来解决这个问题。 并且\nresolve.alias 里移除了 alias 提供的默认值 { \"@\": \"./src\"}\n\n如果你需要此功能，请使用 resolve.alias。\n\n在下一个大版本，resolve.alias 将会取代 alias 。\n\nWARNING\n * 注意此配置不要与 alias 混用。\n * 注意此配置必须标注一个相对路径，例如 { \"@\": \"./src\" } 而非 { \"@\": \"src\"}。\n\n\nresolve.mainFields#\n\npackage.json 中，在解析包的入口点时尝试的字段列表。\n\n * 类型：string[]\n * 默认值：取决于platform\n   * node: ['module', 'main']\n   * browser: ['module', 'browser', 'main']\n * 版本：>=2.36.0\n\n例如，我们想要先加载 js:source 字段：\n\n\n\nWARNING\n\nresolve.mainFields 比 package.json 中 exports 字段的优先级低，如果一个入口点从 exports\n成功解析，resolve.mainFields 将被忽略。\n\n\nresolve.jsExtentions#\n\n支持隐式文件扩展名\n\n * 类型： string[]\n * 默认值： ['.jsx', '.tsx', '.js', '.ts', '.json']\n * 版本：>=2.36.0\n\n对于 css 文件，请不要使用隐式文件扩展名，目前 Module 仅支持 ['.less', '.css', '.sass', '.scss'] 后缀。\n\nNode 的解析算法不会将 .mjs 和 cjs 视为隐式文件扩展名，因此这里默认也不会，但是可以通过更改此配置来包含：\n\n\n\n\nshims#\n\n在构建 cjs / esm 产物时注入一些垫片代码。\n\n例如 __dirname 只能在 commonjs 里使用，开启此选项后，当产物格式为 esm 时，会将 __dirname 编译为\npath.dirname(fileURLToPath(import.meta.url))。\n\n详细代码见 shims， 需要注意的是 esm shims 只会在 platform 为 node 时注入，因为用到了 url 模块。\n\n * 类型： boolean\n * 默认值： false\n * 版本：>=2.38.0\n\n\n\n\nsideEffects#\n\n配置模块的副作用\n\n * 类型： RegExg[] | (filePath: string, isExternal: boolean) => boolean | boolean\n * 默认值： undefined\n\n通常情况下，我们通过 package.json 的 \"sideEffects\" 字段来配置模块的副作用，但是在某些情况下，三方包的 package.json\n是不可靠的。 例如我们引用了一个三方包的样式文件。\n\n\n\n但是这个三方包的 package.json 里并没有将样式文件配置到 \"sideEffects\" 里。\n\n\n\n同时你又设置了 style.inject 为 true，在控制台可以看到类似的警告信息：\n\n\n\n这时候就可以使用这个配置项，手动配置模块的\"sideEffects\"，配置支持正则和函数形式。\n\n\n\nTIP\n\n添加此配置后，打包时将不会再读取 package.json 里的 \"sideEffects\" 字段。\n\n\nsourceDir#\n\n指定构建的源码目录,默认为 src，用于在 bundleless 构建时基于源码目录结构生成对应的产物目录。 等同于esbuild.outbase。\n\n * 类型： string\n * 默认值： src\n\n\nsourceMap#\n\n控制 sourceMap 如何生成。\n\n * 类型： boolean | 'inline' | 'external'\n * 默认值： false\n\n\nsourceType#\n\nWARNING\n\n已废弃，此配置不会产生任何影响。\n\n设置源码的格式。默认情况下，会将源码作为 EsModule 进行处理。当源码使用的是 CommonJS 的时候，需要设置 commonjs。\n\n * 类型：'commonjs' | 'module'\n * 默认值：'module'\n\n\nsplitting#\n\n是否开启代码分割。 仅支持 format: 'esm' 和 format: 'cjs'，查看esbuild.splitting了解更多。\n\n * 类型： boolean\n * 默认值： false\n\n\nstyle#\n\n配置样式相关的配置。\n\n\nstyle.less#\n\nless 相关配置。\n\n\nstyle.less.lessOptions#\n\n详细配置参考 less。\n\n * 类型： object\n * 默认值： { javascriptEnabled: true }\n\n\nstyle.less.additionalData#\n\n在入口文件起始添加 Less 代码。\n\n * 类型： string\n * 默认值： undefined\n\n\n\n\nstyle.less.implementation#\n\n配置 Less 使用的实现库，在不指定的情况下，使用的内置版本是 4.1.3。\n\n * 类型： string | object\n * 默认值： undefined\n\n设置 object 类型时，可以指定 Less 的实现库。\n\n\n\nstring 类型时，指定 Less 的实现库的路径\n\n\n\n\nsass#\n\nSass 相关配置。\n\n\nstyle.sass.sassOptions#\n\n详细配置参考 node-sass\n\n * 类型： object\n * 默认值： {}\n\n\nstyle.sass.additionalData#\n\n在入口文件起始添加 Sass 代码。\n\n * 类型： string | Function\n * 默认值： undefined\n\n\n\n\nstyle.sass.implementation#\n\n配置 Sass 使用的实现库，在不指定的情况下，使用的内置版本是 1.5.4。\n\n * 类型： string | object\n * 默认值： undefined\n\n设置为 object 类型时，可以指定 Sass 的实现库。\n\n\n\nstring 类型时，指定 Sass 的实现库的路径\n\n\n\n\nstyle.postcss#\n\n用于配置 PostCSS 的选项，传入的值会与默认配置通过 Object.assign 合并。注意 Object.assign 是浅拷贝，因此会完全覆盖内置的\nplugins 数组。\n\n详细配置请查看 PostCSS。\n\n * 类型：\n\n\n\n * 默认值：\n\n\n\n * 示例：\n\n\n\n\nstyle.inject#\n\n配置打包模式下是否将 CSS 样式插入到 JavaScript 代码中。\n\n * 类型： boolean\n * 默认值： false\n\n将 inject 设置为 true 来开启此功能：\n\n\n\n开启后，你会看到源码中引用的 CSS 代码被包含在了打包后的 JS 产物中。\n\n例如，你在源码里写了 import './index.scss'，那么在产物中你会看到以下代码：\n\n\n\nTIP\n\n开启 inject 后，你需要注意以下几点：\n\n * CSS 文件中的 @import 不会被处理。如果你的 CSS 文件中有 @import ，那么你需要在 JS 文件中手动引入 CSS\n   文件（less,scss 文件不需要，因为它们会有预处理）。\n * 需要考虑 sideEffects 的影响。默认情况下，我们的构建器会认为 CSS 是有副作用的，如果你的项目中或者三方包的 package.json\n   设置了 sideEffects 字段并且没有包含此 CSS 文件，那么你将会得到一个警告：\n\n\n\n此时可以通过配置 sideEffects 来解决。\n\n\nstyle.autoModules#\n\n根据文件名自动启用 CSS Modules。\n\n * 类型： boolean | RegExp\n * 默认值： true\n\ntrue : 为以 .module.css .module.less .module.scss .module.sass 文件名结尾的样式文件启用 CSS\nModules。\n\nfalse : 禁用 CSS Modules.\n\nRegExp : 为匹配正则条件的所有文件启用 CSS Modules.\n\n\nstyle.modules#\n\nCSS Modules 配置。\n\n * 类型： object\n * 默认值： {}\n\n一个常用的配置是 localsConvention，它可以改变 CSS Modules 的类名生成规则。\n\n\n\n对于以下样式：\n\n\n\n你可以使用 styles.boxTitle 来访问。\n\n详细配置查看 postcss-modules\n\n\nstyle.tailwindcss#\n\n用于修改 Tailwind CSS 的配置项。\n\n * 类型： object | Function\n * 默认值：\n\n\n\n\n启用 Tailwind CSS#\n\n在使用 style.tailwindcss 之前，你需要启用 Modern.js Module 的 Tailwind CSS 插件。\n\n请阅读「使用 Tailwind CSS」 章节来了解开启方式。\n\n\n类型#\n\n值为 object 类型时，与默认配置通过 Object.assign 合并。\n\n值为 Function 类型时，函数返回的对象与默认配置通过 Object.assign 合并。\n\n其他的使用方式和 Tailwind CSS 一致: 快速传送门。\n\n\n注意事项#\n\n注意：\n\n * 如果你同时使用了 tailwind.config.{ts,js} 文件和 tools.tailwindcss 选项，那么\n   tools.tailwindcss 定义的配置会优先生效，并覆盖 tailwind.config.{ts,js} 中定义的内容。\n * 如果你同时使用了 designSystem 配置项，那么 Tailwind CSS 的 theme 配置将会被 designSystem 的值所覆盖。\n\n其他配置的使用方式与 Tailwind CSS 官方用法一致，请参考 tailwindcss - Configuration。\n\n\ntarget#\n\ntarget 用于为生成的 JavaScript 代码设置目标环境。它让 Modern.js Module 将目标环境无法识别的 JavaScript\n语法转换为在这些环境中可用的低版本 JavaScript 语法。\n\n * 类型：\n\n\n\n * 默认值： 'es6'\n\n例如，将代码编译到 es5 语法：\n\n\n\n\ntransformImport#\n\n提供与 babel-plugin-import 等价的能力和配置，基于 SWC 实现，使用此配置，将会使用 SWC 对代码进行转换。\n\n * 类型：object[]\n * 默认值：[]\n\n数组元素为一个 babel-plugin-import 的配置对象。配置对象可以参考 options。\n\n使用示例：\n\n\n\n参考「Import 插件——注意事项」\n\n\ntransformLodash#\n\n是否模块化 lodash 的导入，删除未使用的 lodash 模块，从而减少 lodash 代码体积。这项优化基于 babel-plugin-lodash 和\nswc-plugin-lodash 实现。 使用此配置，将会使用 SWC 对代码进行转换。\n\n * 类型：boolean\n * 默认值：false\n\n当开启此选项时，Modern.js Module 会自动将 lodash 的代码引用指向子路径。\n\n比如：\n\n\n\n转换后的代码：\n\n\n\n\ntsconfig#\n\nTypeScript 配置文件的路径。\n\n * 类型： string\n * 默认值： tsconfig.json\n * 版本： >=2.36.0\n\n\n\n\numdGlobals#\n\n指定 UMD 产物外部导入的全局变量。\n\n * 类型： Record\n * 默认值： {}\n\n\n\n此时，react 和 react-dom 会被看做是外部导入的全局变量，不会被打包进 UMD 产物中，而是通过 global.React 和\nglobal.ReactDOM 的方式进行访问。\n\n\numdModuleName#\n\n指定 UMD 产物的模块名。\n\n * 类型： string | Function\n * 默认值： name => name\n\n\n\n此时 UMD 产物会去挂载到 global.myLib 上。\n\nTIP\n * 需要遵守 UMD 规范，UMD 产物的模块名不能和全局变量名冲突。\n * 模块名会被转换为驼峰命名，如 my-lib 会被转换为 myLib，可参考toIdentifier。\n\n同时函数形式可以接收一个参数，为当前打包文件的输出路径\n\n","routePath":"/module-tools/api/config/build-config","lang":"zh","toc":[{"text":"alias","id":"alias","depth":2,"charIndex":141},{"text":"asset","id":"asset","depth":2,"charIndex":483},{"text":"asset.name","id":"assetname","depth":2,"charIndex":506},{"text":"asset.limit","id":"assetlimit","depth":2,"charIndex":753},{"text":"asset.path","id":"assetpath","depth":2,"charIndex":981},{"text":"asset.publicPath","id":"assetpublicpath","depth":2,"charIndex":1052},{"text":"asset.svgr","id":"assetsvgr","depth":2,"charIndex":1159},{"text":"asset.svgr.include","id":"assetsvgrinclude","depth":2,"charIndex":1411},{"text":"asset.svgr.exclude","id":"assetsvgrexclude","depth":2,"charIndex":1510},{"text":"asset.svgr.exportType","id":"assetsvgrexporttype","depth":2,"charIndex":1611},{"text":"autoExtension","id":"autoextension","depth":2,"charIndex":1802},{"text":"autoExternal","id":"autoexternal","depth":2,"charIndex":2393},{"text":"autoExternal.dependencies","id":"autoexternaldependencies","depth":2,"charIndex":2670},{"text":"autoExternal.peerDependencies","id":"autoexternalpeerdependencies","depth":2,"charIndex":2758},{"text":"banner","id":"banner","depth":2,"charIndex":2854},{"text":"buildType","id":"buildtype","depth":2,"charIndex":2984},{"text":"copy","id":"copy","depth":2,"charIndex":3087},{"text":"copy.patterns","id":"copypatterns","depth":2,"charIndex":3128},{"text":"copy.options","id":"copyoptions","depth":2,"charIndex":3180},{"text":"define","id":"define","depth":2,"charIndex":3341},{"text":"dts","id":"dts","depth":2,"charIndex":3802},{"text":"dts.abortOnError","id":"dtsabortonerror","depth":2,"charIndex":3864},{"text":"dts.distPath","id":"dtsdistpath","depth":2,"charIndex":4097},{"text":"dts.enableTscBuild","id":"dtsenabletscbuild","depth":2,"charIndex":4196},{"text":"dts.only","id":"dtsonly","depth":2,"charIndex":4419},{"text":"dts.respectExternal","id":"dtsrespectexternal","depth":2,"charIndex":4499},{"text":"dts.tsconfigPath","id":"dtstsconfigpath","depth":2,"charIndex":4718},{"text":"esbuildOptions","id":"esbuildoptions","depth":2,"charIndex":4790},{"text":"externalHelpers","id":"externalhelpers","depth":2,"charIndex":5293},{"text":"externals","id":"externals","depth":2,"charIndex":5501},{"text":"footer","id":"footer","depth":2,"charIndex":5617},{"text":"format","id":"format","depth":2,"charIndex":5655},{"text":"format: esm","id":"format-esm","depth":3,"charIndex":5780},{"text":"format: cjs","id":"format-cjs","depth":3,"charIndex":5859},{"text":"format: iife","id":"format-iife","depth":3,"charIndex":5957},{"text":"format: umd","id":"format-umd","depth":3,"charIndex":6058},{"text":"hooks","id":"hooks","depth":2,"charIndex":6211},{"text":"input","id":"input","depth":2,"charIndex":6359},{"text":"jsx","id":"jsx","depth":2,"charIndex":6824},{"text":"loader","id":"loader","depth":2,"charIndex":7147},{"text":"metafile","id":"metafile","depth":2,"charIndex":7208},{"text":"minify","id":"minify","depth":2,"charIndex":7446},{"text":"outDir","id":"outdir","depth":2,"charIndex":7566},{"text":"platform","id":"platform","depth":2,"charIndex":7620},{"text":"redirect","id":"redirect","depth":2,"charIndex":7754},{"text":"resolve","id":"resolve","depth":2,"charIndex":7985},{"text":"resolve.alias","id":"resolvealias","depth":3,"charIndex":8007},{"text":"resolve.mainFields","id":"resolvemainfields","depth":3,"charIndex":8457},{"text":"resolve.jsExtentions","id":"resolvejsextentions","depth":3,"charIndex":8774},{"text":"shims","id":"shims","depth":2,"charIndex":9031},{"text":"sideEffects","id":"sideeffects","depth":2,"charIndex":9298},{"text":"sourceDir","id":"sourcedir","depth":2,"charIndex":9740},{"text":"sourceMap","id":"sourcemap","depth":2,"charIndex":9856},{"text":"sourceType","id":"sourcetype","depth":2,"charIndex":9943},{"text":"splitting","id":"splitting","depth":2,"charIndex":10101},{"text":"style","id":"style","depth":2,"charIndex":10214},{"text":"style.less","id":"styleless","depth":2,"charIndex":10235},{"text":"style.less.lessOptions","id":"stylelesslessoptions","depth":2,"charIndex":10261},{"text":"style.less.additionalData","id":"stylelessadditionaldata","depth":2,"charIndex":10352},{"text":"style.less.implementation","id":"stylelessimplementation","depth":2,"charIndex":10436},{"text":"sass","id":"sass","depth":2,"charIndex":10611},{"text":"style.sass.sassOptions","id":"stylesasssassoptions","depth":2,"charIndex":10631},{"text":"style.sass.additionalData","id":"stylesassadditionaldata","depth":2,"charIndex":10701},{"text":"style.sass.implementation","id":"stylesassimplementation","depth":2,"charIndex":10796},{"text":"style.postcss","id":"stylepostcss","depth":2,"charIndex":10972},{"text":"style.inject","id":"styleinject","depth":2,"charIndex":11131},{"text":"style.autoModules","id":"styleautomodules","depth":2,"charIndex":11627},{"text":"style.modules","id":"stylemodules","depth":2,"charIndex":11861},{"text":"style.tailwindcss","id":"styletailwindcss","depth":2,"charIndex":12040},{"text":"启用 Tailwind CSS","id":"启用-tailwind-css","depth":3,"charIndex":12122},{"text":"类型","id":"类型","depth":3,"charIndex":12242},{"text":"注意事项","id":"注意事项","depth":3,"charIndex":12373},{"text":"target","id":"target","depth":2,"charIndex":12663},{"text":"transformImport","id":"transformimport","depth":2,"charIndex":12829},{"text":"transformLodash","id":"transformlodash","depth":2,"charIndex":13025},{"text":"tsconfig","id":"tsconfig","depth":2,"charIndex":13267},{"text":"umdGlobals","id":"umdglobals","depth":2,"charIndex":13355},{"text":"umdModuleName","id":"umdmodulename","depth":2,"charIndex":13515}],"domain":"","frontmatter":{"sidebar_position":1},"version":""},{"id":47,"title":"buildPreset","content":"#\n\n构建的预设字符串或者预设函数。提供开箱即用的构建配置。\n\n * 类型：string | Function\n\n * 默认值: undefined\n\n\nnpm-library#\n\n在类 NPM 包管理器下使用的 Library 通用模式，包含 esm 和 cjs 两种 Bundle 产物，并且包含一份类型文件。\n\nINFO\n\n关于类 NPM 包管理器\n\n * npm\n * yarn\n * pnpm\n\n\n\n预设字符串对应的构建配置：\n\n\n\n\nnpm-library-with-umd#\n\n在类 NPM 包管理器下使用，并且 Library 支持类似 unpkg 的模式。在预设 'npm-library' 的基础上，额外提供 umd 产物。\n\n\n\n预设字符串对应的构建配置：\n\n\n\n\nnpm-component#\n\n在类 NPM 包管理器下使用的 组件（库）通用模式。包含 esm 和 cjs 两种 Bundleless 产物（便于 Tree shaking\n优化），以及包含一份类型文件。\n\n对于源码中包含的样式文件，产物中提供样式的编译产物和样式的源文件。\n\n\n\n预设字符串对应的构建配置：\n\n\n\n\nnpm-component-with-umd#\n\n在类 NPM 包管理器下使用的组件（库），同时支持类 unpkg 的模式。 在预设 'npm-component' 的基础上，额外提供 umd 产物。\n\n\n\n\n\n\nnpm-library-{es5...esnext}#\n\n当想要使用支持其他 ECMAScript 版本的 buildPreset 预设的时候，可以直接在\n'npm-library'、'npm-library-with-umd'、'npm-component'、'npm-component-with-umd'\n这些预设值后面增加想要支持的版本。\n\n例如希望 'npm-library' 预设支持 'es2017'，则可以按照如下方式配置：\n\n\n\n\nstring / function#\n\nbuildPreset 除了支持基本的字符串形式，还支持函数形式，可以通过 preset 或者 extendPreset\n参数获取我们提供的预设值，然后进行修改。\n\n以下是两个分别使用 preset 和 extendPreset 的例子：\n\n\n\nextendPreset 里会使用 lodash.merge 进行配置合并\n\n","routePath":"/module-tools/api/config/build-preset","lang":"zh","toc":[{"text":"`npm-library`","id":"npm-library","depth":2,"charIndex":-1},{"text":"`npm-library-with-umd`","id":"npm-library-with-umd","depth":2,"charIndex":-1},{"text":"`npm-component`","id":"npm-component","depth":2,"charIndex":-1},{"text":"`npm-component-with-umd`","id":"npm-component-with-umd","depth":2,"charIndex":-1},{"text":"`npm-library-{es5...esnext}`","id":"npm-library-es5esnext","depth":2,"charIndex":-1},{"text":"string / function","id":"string--function","depth":2,"charIndex":835}],"domain":"","frontmatter":{"sidebar_position":2},"version":""},{"id":48,"title":"dev","content":"#\n\n本章节描述了 Modern.js Module 关于调试工具相关的所有配置。\n\n\nstorybook#\n\nWARNING\n\nDeprecated：该配置已过时，只适用于 StorybookV6，详情请看使用Storybook。\n\n\nstorybook.webpack#\n\n * 类型：object | Function | undefined\n * 默认值：undefined\n\n\n\n你可以通过 dev.storybook.webpack 来修改 Storybook Preview-iframe 的 webpack 配置。使用方式可以参考\nModern.js 的 tools.webpack 配置。\n\n\n\n配置 Manager App#\n\n对于 Storybook Manager App 部分的 webpack 配置，可以通过增加 ./config/storybook/main.js\n文件进行配置。\n\n\n\n\nstorybook.webpackChain#\n\n * 类型：Function | undefined\n * 默认值：undefined\n\n\n\n你可以通过 dev.storybook.webpackChain 来修改 Storybook Preview-iframe 的 webpack\n配置。使用方式可以参考 Modern.js 的 tools.webpackChain 配置。","routePath":"/module-tools/api/config/dev","lang":"zh","toc":[{"text":"storybook","id":"storybook","depth":2,"charIndex":43},{"text":"storybook.webpack","id":"storybookwebpack","depth":3,"charIndex":118},{"text":"配置 Manager App","id":"配置-manager-app","depth":4,"charIndex":306},{"text":"storybook.webpackChain","id":"storybookwebpackchain","depth":3,"charIndex":409}],"domain":"","frontmatter":{"sidebar_position":3},"version":""},{"id":49,"title":"plugins","content":"#\n\n本章介绍注册 Modern.js Module 插件的配置。\n\n * 类型：ModuleToolsPlugin[]\n * 默认值：undefined\n\n\n插件执行顺序#\n\n默认情况下，自定义插件会按照 plugins 数组的顺序依次执行，Modern.js Module 内置插件的执行时机早于自定义插件。\n\n当插件内部使用了控制顺序的相关字段，比如 pre、post 时，会基于声明的字段对执行顺序进行调整，详见 插件之间的关系。\n\n\n开发插件#\n\n关于如何编写插件，可以查看「插件编写指南」。\n\n\n示例#\n\n\n使用 npm 上的插件#\n\n使用 npm 上的插件，需要通过包管理器安装插件，并通过 import 引入。\n\n\n\n使用本地插件#\n\n使用本地代码仓库中的插件，直接通过相对路径 import 引入即可。\n\n\n\n\n插件配置项#\n\n如果插件提供了一些自定义的配置项，你可以通过插件函数的参数传入配置。\n\n","routePath":"/module-tools/api/config/plugins","lang":"zh","toc":[{"text":"插件执行顺序","id":"插件执行顺序","depth":2,"charIndex":79},{"text":"开发插件","id":"开发插件","depth":2,"charIndex":221},{"text":"示例","id":"示例","depth":2,"charIndex":253},{"text":"使用 npm 上的插件","id":"使用-npm-上的插件","depth":3,"charIndex":259},{"text":"使用本地插件","id":"使用本地插件","depth":4,"charIndex":316},{"text":"插件配置项","id":"插件配置项","depth":3,"charIndex":364}],"domain":"","frontmatter":{"sidebar_position":4},"version":""},{"id":50,"title":"概览","content":"#","routePath":"/module-tools/api/","lang":"zh","toc":[],"domain":"","frontmatter":{"overview":true,"sidebar_label":"概览","sidebar_position":1},"version":""},{"id":51,"title":"Plugin Hooks","content":"#\n\n本章介绍关于 Modern.js Module 支持的生命周期钩子。\n\n目前主要包含以下几类生命周期钩子：\n\n * 配置钩子：用于处理用户配置。\n * 构建钩子：仅在执行 build 命令构建源码产物时触发。\n * buildPlatform 钩子：仅在执行 build --platform 命令生成其他构建产物时触发。\n * 调试钩子：运行 dev 命令时会触发的钩子。\n\n这里详细解释了 Hook 模型\n\n\n配置钩子#\n\n\nresolveModuleUserConfig#\n\n用于修改用户配置。\n\n类型：AsyncWaterfall\n\n\n\n\n构建钩子#\n\n在执行 build 命令的时候，会按照顺序触发以下 Hooks：\n\n * beforeBuild\n * beforeBuildTask\n * afterBuildTask\n * afterBuild\n\n\nbeforeBuild#\n\n执行整体构建流程之前触发。\n\n类型：ParallelWorkflow\n\n\n\n参数类型：\n\n\n\n> BuildConfig 类型参考 API 配置\n\n\nbeforeBuildTask#\n\n根据构建配置，Modern.js Module 会将整体构建分成多个子构建任务。该 Hook 将会在每一个构建子任务之前触发。\n\n类型：AsyncWaterfall\n\n\n\n\nafterBuildTask#\n\n类型：ParallelWorkflow，每一个构建子任务结束之后触发。\n\n\n\n参数和返回值类型：\n\n\n\n\nafterBuild#\n\n类型：ParallelWorkflow，整体构建流程结束之后触发。\n\n\n\n参数和返回值类型：\n\n\n\n\nbuildPlatform 钩子#\n\nmodule-tools 还提供了 build --platform 命令来执行特定的构建任务。\n\n例如在安装了 Doc 插件后，就可以执行 build --platform 或者 build --platform doc 来执行 doc 的构建任务。因为\ndoc 插件基于 buildPlatform Hooks 实现了该功能。\n\n在执行 build --platform 后会按照以下顺序触发 Hooks：\n\n * registerBuildPlatform\n * beforeBuildPlatform\n * buildPlatform\n * afterBuildPlatform\n\n\nregisterBuildPlatform#\n\n获取在执行 build --platform 命令时候需要运行的任务信息。\n\n\n\n入参和返回的参数类型：\n\n\n\n\nbeforeBuildPlatform#\n\n当执行 build --platform 命令的时候，会触发所有已注册的构建任务。beforeBuildPlatform 会在执行整体的构建任务之前触发。\n\n\n\n入参和返回的参数类型：\n\n\n\n\nbuildPlatform#\n\n当执行 build --platform 命令的时候，会触发所有已注册的构建任务。buildPlatform 会在每个构建任务执行之前触发。\n\n\n\n入参和返回的参数类型：\n\n\n\n\nafterBuildPlatform#\n\n当执行 build --platform 命令的时候，会触发所有已注册的构建任务。afterBuildPlatform 会在整体 platform\n构建任务结束后触发。\n\n\n\n入参和返回的参数类型：\n\n\n\n\n调试钩子#\n\n在执行 dev 命令的时候，会按照顺序触发以下 Hooks：\n\n * registerDev: 在获取调试功能信息的时候触发。\n * beforeDev: 开始执行调试整体流程之前触发。\n * beforeDevMenu: 出现调试列表/菜单之前触发。\n * afterDevMenu: 选择调试列表/菜单选项后触发。\n * beforeDevTask: 执行调试任务之前触发。\n * afterDev: 执行 dev 整体流程最后触发。\n\n\nregisterDev#\n\n注册调试工具相关的数据。主要包含：\n\n * 调试工具的名称\n * 显示在菜单列表中的项目名称以及对应的值。\n * dev 子命令的定义。\n * 是否在运行调试任务之前执行源码构建\n * 执行调试任务的函数。\n\n\n\n入参和返回的参数类型：\n\n\n\n\nbeforeDev#\n\n在收集完所有调试工具元数据后，执行 dev 任务之前触发。\n\n\n\n入参和返回的参数类型：\n\n\n\n\n(before|after)DevMenu#\n\nbeforeDevMenu 在出现调试列表/菜单之前触发。接收 inquirer question 作为参数。默认值为：\n\n\n\nafterDevMenu 选择调试列表/菜单选项后触发。\n\n\n\n入参和返回的参数类型：\n\n\n\n\nbeforeDevTask#\n\n执行调试任务之前触发。\n\n\n\n入参和返回的参数类型：\n\n\n\n\nafterDev#\n\n在中断调试任务进程时触发。\n\n","routePath":"/module-tools/api/plugin-api/plugin-hooks","lang":"zh","toc":[{"text":"配置钩子","id":"配置钩子","depth":2,"charIndex":209},{"text":"`resolveModuleUserConfig`","id":"resolvemoduleuserconfig","depth":3,"charIndex":-1},{"text":"构建钩子","id":"构建钩子","depth":2,"charIndex":276},{"text":"`beforeBuild`","id":"beforebuild","depth":3,"charIndex":-1},{"text":"`beforeBuildTask`","id":"beforebuildtask","depth":3,"charIndex":-1},{"text":"`afterBuildTask`","id":"afterbuildtask","depth":3,"charIndex":-1},{"text":"`afterBuild`","id":"afterbuild","depth":3,"charIndex":-1},{"text":"buildPlatform 钩子","id":"buildplatform-钩子","depth":2,"charIndex":713},{"text":"`registerBuildPlatform`","id":"registerbuildplatform","depth":3,"charIndex":-1},{"text":"`beforeBuildPlatform`","id":"beforebuildplatform","depth":3,"charIndex":-1},{"text":"`buildPlatform`","id":"buildplatform","depth":3,"charIndex":-1},{"text":"`afterBuildPlatform`","id":"afterbuildplatform","depth":3,"charIndex":-1},{"text":"调试钩子","id":"调试钩子","depth":2,"charIndex":1459},{"text":"`registerDev`","id":"registerdev","depth":3,"charIndex":-1},{"text":"`beforeDev`","id":"beforedev","depth":3,"charIndex":-1},{"text":"`(before|after)DevMenu`","id":"beforeafterdevmenu","depth":3,"charIndex":-1},{"text":"`beforeDevTask`","id":"beforedevtask","depth":3,"charIndex":-1},{"text":"`afterDev`","id":"afterdev","depth":3,"charIndex":-1}],"domain":"","frontmatter":{},"version":""},{"id":52,"title":"","content":"","routePath":"/module-tools/components/faq-build-exception","lang":"zh","toc":[],"domain":"","frontmatter":{},"version":""},{"id":53,"title":"","content":"","routePath":"/module-tools/components/faq-build-other","lang":"zh","toc":[],"domain":"","frontmatter":{},"version":""},{"id":54,"title":"","content":"","routePath":"/module-tools/components/faq-build-product","lang":"zh","toc":[],"domain":"","frontmatter":{},"version":""},{"id":55,"title":"","content":"","routePath":"/module-tools/components/faq-storybook","lang":"zh","toc":[],"domain":"","frontmatter":{},"version":""},{"id":56,"title":"","content":"","routePath":"/module-tools/components/publish-emo","lang":"zh","toc":[],"domain":"","frontmatter":{},"version":""},{"id":57,"title":"","content":"在增加 esbuild 插件时，请注意你需要将插件加在 plugins 数组的头部，因为 Modern.js Module 内部也是通过一个 esbuild\n插件介入到整个构建流程中去的，因此需要将自定义插件优先注册。","routePath":"/module-tools/components/register-esbuild-plugin","lang":"zh","toc":[],"domain":"","frontmatter":{},"version":""},{"id":58,"title":"","content":"","routePath":"/module-tools/components/release-module-doc","lang":"zh","toc":[],"domain":"","frontmatter":{},"version":""},{"id":59,"title":"处理静态资源","content":"#\n\nModern.js Module 会对代码中使用的静态资源进行处理。如果需要配置，则可以使用 buildConfig.asset API。\n\n\n默认行为#\n\n默认情况下，Modern.js Module 会处理以下静态资源：\n\n * '.svg'、'.png'、'.jpg'、'.jpeg'、'.gif'、'.webp'\n * '.ttf'、'.otf'、'.woff'、'.woff2'、'.eot'\n * '.mp3'、'.mp4'、'.webm'、'.ogg'、'.wav'、'.flac'、'.aac'、'.mov'\n\n对于静态文件的处理，Modern.js Module 目前默认支持的功能有：\n\n * 输出静态资源至 ./assets。\n * 对于不超过 10kb 的文件会内联到代码中。\n\n\n示例#\n\n让我们看下面的例子：\n\n * 项目源代码：\n\n\n\n * 如果 bg.png 的大小小于 10 kb，则此时产物目录结构和产物内容为：\n\n\n\n\n\n * 如果 bg.png 的大小大于 10 kb，则此时产物目录结构和产物内容为：\n\n\n\n\n\n当你想要修改默认行为的时候，可以使用以下 API：\n\n * asset.path：修改静态资源文件输出路径。\n * asset.limit：修改内联静态资源文件的阈值。","routePath":"/module-tools/guide/advance/asset","lang":"zh","toc":[{"text":"默认行为","id":"默认行为","depth":2,"charIndex":74},{"text":"示例","id":"示例","depth":2,"charIndex":355}],"domain":"","frontmatter":{"sidebar_position":7},"version":""},{"id":60,"title":"构建 umd 产物","content":"#\n\numd 全称为 Universal Module Definition，这种格式的 JS 文件可以运行在多个运行环境：\n\n * 浏览器环境：基于 AMD 规范进行模块加载\n * Node.js 环境：基于 CommonJS 进行模块加载\n * 其他情况：将模块挂载在全局对象上。\n\n因此我们可以通过下面的方式，将项目的构建产物指定为 umd 产物：\n\n\n\n\numd 产物的第三方依赖处理#\n\n在 「如何处理第三方依赖」 章节中，我们知道可以通过 autoExternals 和 externals API 来控制项目是否对第三方依赖打包。 因此在构建\numd 产物的过程中，我们也可以这样使用：\n\n\n示例#\n\n * 如果项目依赖了 react：\n\n\n\n * modern.config.ts 配置：\n\n\n\n * 当源码中使用了 react 依赖：\n\n\n\n * 此时产物中不会将 react 代码打包到产物中：\n\n\n\n通过上面的例子我们知道，当使用 autoExternal 和 externals API 后：\n\n * 在 Node.js 环境下，可以通过 require('react') 获取 react 依赖。\n * 在 浏览器环境下，可以通过 global.react 获取 react 依赖。\n\n\n三方依赖的全局变量名称#\n\n然而在浏览器环境下，获取第三方依赖的时候，全局变量名称不一定与依赖名称完全相同，此时就要使用 buildConfig.umdGlobals API。\n\n还是使用之前的例子，当 react 依赖以 windows.React 或者 global.React 全局变量的形式存在于浏览器环境下，那么此时：\n\n * modern.config.ts 配置：\n\n\n\n * 当源码中使用了 react 依赖：\n\n\n\n * 此时我们会看到这样的产物代码：\n\n\n\n此时项目就可以运行在浏览器中，并使用存在于全局对象上的 React 变量了。\n\n\n更改项目的全局变量名称#\n\n当我们将下面的代码打包成 umd 产物并运行在浏览器的时候，我们可以通过 window.index 来使用该模块。\n\n\n\n默认情况下，以源码文件名称作为该模块在浏览器里全局变量的名称。对于上面的例子，其产物内容如下：\n\n\n\n如果需要修改它，则需要使用 buildConfig.umdModuleName API。\n\n当使用该 API 后：\n\n\n\n此时构建产物的内容为：\n\n","routePath":"/module-tools/guide/advance/build-umd","lang":"zh","toc":[{"text":"umd 产物的第三方依赖处理","id":"umd-产物的第三方依赖处理","depth":2,"charIndex":181},{"text":"示例","id":"示例","depth":3,"charIndex":302},{"text":"三方依赖的全局变量名称","id":"三方依赖的全局变量名称","depth":3,"charIndex":556},{"text":"更改项目的全局变量名称","id":"更改项目的全局变量名称","depth":2,"charIndex":836}],"domain":"","frontmatter":{"sidebar_position":5},"version":""},{"id":61,"title":"使用 Copy 工具","content":"#\n\nModern.js Module 提供了 Copy 工具用于将已经存在的单个文件或整个目录复制到产物目录中。接下来我们学习如何使用它。\n\n\n了解 Copy API#\n\n我们可以通过 buildConfig.copy API 来使用 Copy 工具，它包含以下两个主要配置：\n\n * patterns\n * options\n\n\nAPI 详解#\n\ncopy.patterns 用于寻找复制的文件以及配置输出的路径。\n\n其中 patterns.from 用于指定要复制的文件或者目录。它接收 Glob 形式字符串或具体路径。Glob 形式字符串是指 fast-glob\npattern-syntax。因此我们可以按照如下两种方式使用它：\n\n\n\npatterns.context 一般和 patterns.from 配合使用，默认情况下它的值与 buildConfig.sourceDir\n相同，因此我们可以按照如下方式指定 src/data.json 文件为要复制的文件：\n\n> 默认情况下，buildConfig.sourceDir 为 src\n\n\n\n当指定的文件不在源码目录的时候，可以修改 context 配置。例如指定项目目录下的 temp/index.html 为要复制的文件：\n\n\n\npatterns.to 用于指定复制文件的输出路径，默认情况下它的值为 buildConfig.outDir对应的值。因此我们按照如下方式将\nsrc/index.html 复制到 dist 目录下：\n\n\n\n当我们配置了 patterns.to 的时候：\n\n * 如果是相对路径，则该路径会相对于 buildConfig.outDir 计算出复制文件输出的绝对路径。\n * 如果是绝对路径，则会直接使用该值。\n\n最后 patterns.globOptions 用于配置寻找复制文件 globby 对象，其配置可参考：\n\n * globby.options\n\n\n不同场景使用示例#\n\n\n将文件复制文件#\n\n\n\n\n将文件复制到目录#\n\n\n\n\n从目录复制到目录#\n\n\n\n\n从目录到文件#\n\n\n\n\n使用 Glob#\n\n","routePath":"/module-tools/guide/advance/copy","lang":"zh","toc":[{"text":"了解 Copy API","id":"了解-copy-api","depth":2,"charIndex":72},{"text":"API 详解","id":"api-详解","depth":2,"charIndex":165},{"text":"不同场景使用示例","id":"不同场景使用示例","depth":2,"charIndex":826},{"text":"将文件复制文件","id":"将文件复制文件","depth":3,"charIndex":838},{"text":"将文件复制到目录","id":"将文件复制到目录","depth":3,"charIndex":851},{"text":"从目录复制到目录","id":"从目录复制到目录","depth":3,"charIndex":865},{"text":"从目录到文件","id":"从目录到文件","depth":3,"charIndex":879},{"text":"使用 Glob","id":"使用-glob","depth":3,"charIndex":891}],"domain":"","frontmatter":{"sidebar_position":3},"version":""},{"id":62,"title":"处理三方依赖","content":"#\n\n一般来说，项目所需要的第三方依赖可以通过包管理器的 install 命令安装，在安装第三方依赖成功后，这些第三方依赖一般会出现在项目 package.json\n的 dependencies 和 devDependencies 下。\n\n\n\n\"dependencies\" 下的依赖通常来说是这个包运行所需的依赖， \"devDependencies\" 则代表着开发依赖。\n\n除了 \"dependencies\" 以外，\"peerDependencies\" 也可以声明在生产环境下运行所需要的依赖，此时会和它的宿主共享一份依赖。\n\n\n第三方依赖的默认处理#\n\n在 Modern.js Module 里，默认情况下不会对 \"dependencies\" 以及 \"peerDependencies\"\n下的第三方依赖进行打包处理。\n\n这是因为在安装 npm 包时，其 \"dependencies\" 也会被安装。不打包 \"dependencies\"，可以减小包产物的体积。\n\n如果需要打包某些依赖，建议将它们从 \"dependencies\" 挪到 \"devDependencies\" ，这相当于对依赖进行 prebundle\n，可以减小依赖安装的体积。\n\n\n示例#\n\n如果项目依赖了 react:\n\n\n\n当源码中使用了 react 依赖:\n\n\n\n此时产物中不会包含 react 的代码:\n\n\n\n如果想要修改默认的处理方式，可以通过下面的 API 进行修改：\n\n * buildConfig.autoExternal\n\n\n排除指定第三方依赖#\n\n在上面我们提到了 buildConfig.autoExternal API 的用途，同时 buildConfig.externals\n可以实现对三方依赖更细微的处理。\n\n例如当我们需要仅对某些依赖不进行打包处理的时候，可以按照如下方式进行配置：\n\n> 一般这种情况，可能是某些依赖不适合进行打包处理。如果遇到这种情况，则可以按照下面的方式进行处理。\n\n","routePath":"/module-tools/guide/advance/external-dependency","lang":"zh","toc":[{"text":"第三方依赖的默认处理","id":"第三方依赖的默认处理","depth":2,"charIndex":264},{"text":"示例","id":"示例","depth":3,"charIndex":521},{"text":"排除指定第三方依赖","id":"排除指定第三方依赖","depth":2,"charIndex":652}],"domain":"","frontmatter":{"sidebar_position":4},"version":""},{"id":63,"title":"深入理解构建","content":"#\n\n在 \"基础使用\" 的部分，我们已经知道可以通过 buildConfig 配置对项目的输出产物进行修改。buildConfig\n不仅描述了产物的一些特性，同时还为构建产物提供了一些功能。\n\nTIP\n\n如果你还不了解 buildConfig 的作用，请先阅读 修改输出产物。\n\n而在本章里我们将要深入理解某些构建配置的作用以及了解执行 modern build 命令的时候发生了什么。\n\n\nbundle / bundleless#\n\n那么首先我们来了解一下 bundle 和 bundleless。\n\n所谓 bundle 是指对构建产物进行打包，构建产物可能是一个文件，也有可能是基于一定的代码拆分策略得到的多个文件。\n\n而 bundleless 则是指对每个源文件单独进行编译构建，但是并不将它们打包在一起。每一个产物文件都可以找到与之相对应的源码文件。bundleless\n构建的过程，也可以理解为仅对源文件进行代码转换的过程。\n\n它们有各自的好处：\n\n * bundle 可以减少构建产物的体积，也可以对依赖预打包，减小安装依赖的体积。提前对库进行打包，可以加快应用项目构建的速度。\n * bundleless 则是可以保持原有的文件结构，更有利于调试和 tree shaking。\n\nWARNING\n\nbundleless 是单文件编译模式，因此对于类型的引用和导出你需要加上 type 字段， 例如 import type { A } from\n'./types，背景参考 esbuild 文档。\n\n在 buildConfig 中可以通过 buildConfig.buildType 来指定当前构建任务是 bundle 还是 bundleless。\n\n\ninput / sourceDir#\n\nbuildConfig.input 用于指定读取源码的文件路径或者目录路径，其默认值在 bundle 和 bundleless 构建过程中有所不同：\n\n * 当 buildType: 'bundle' 的时候，input 默认值为 src/index.(j|t)sx?\n * 当 buildType: 'bundleless' 的时候，input 默认值为 ['src']\n\n从默认值上我们可以知道：使用 bundle 模式构建时一般指定一个或多个文件作为构建的入口，而使用 bundleless\n构建则是指定一个目录，将目录下所有文件作为入口。\n\nsourceDir 用于指定源码目录，它只与以下两个内容有关系：\n\n * 类型文件生成\n * 指定构建过程中的 outbase\n\n因此我们可以得到其最佳实践：\n\n * 在 bundle 构建过程中，只能指定 input 。\n * 一般情况下，bundleless 只需要指定 sourceDir（此时 input 会与 sourceDir 保持一致）。\n\n如果我们想要在 bundleless 里只对一部分文件进行转换，例如只需要转换 src/runtime 目录的文件，此时需要配置 input:\n\n\n\n\n使用 swc#\n\n在部分场景下，esbuild 不足以满足我们的需求，此时我们会使用 swc 来做代码转换。\n\n从 2.36.0 版本开始，涉及到以下功能时，Modern.js Module 默认会使用 swc ，但不这意味着不使用 esbuild 了，其余功能还是使用\nesbuild:\n\n * transformImport\n * transformLodash\n * externalHelpers\n * format: umd\n * target: es5\n * emitDecoratorMetadata: true\n\n事实上，我们在 2.16.0 版本开始全量使用 swc 进行代码转换。不过 swc 同样也存在一些限制，为此我们添加了 sourceType 配置，当源码格式为\n'commonjs' 时关闭 swc， 但这种方式并不符合用户直觉，另外，swc 格式化输出的 cjs 模式没有给每个导出名称添加注释，这在 node\n中使用可能会带来一些问题。 因为我们废弃了此行为，回到了最初的设计 - 只在需要的场景下使用 swc 作为补充。\n\n\n使用 Hook 介入构建流程#\n\nModern.js Module 提供了 Hook 机制，允许我们在构建流程的不同阶段注入自定义逻辑。 Modern.js Module Hook 使用了\ntapable 实现，扩展了 esbuild 的插件机制，若 esbuild plugins 已经满足了你的需求,建议直接使用它。 下面展开说明其用法:\n\n\nHook 类型#\n\nAsyncSeriesBailHook#\n\n串行执行的 hooks，如果某个 tapped function 返回非 undefined 结果，则后续其他的 tapped function 停止执行。\n\nAsyncSeriesWaterFallHooks#\n\n串行执行的 hooks，其结果会传递给下一个 tapped function\n\n\nHook 顺序#\n\nHook 的执行顺序和注册顺序保持一致，可以通过 applyAfterBuiltIn 来控制在 BuiltIn Hook 前或后注册。\n\n\nHook API#\n\nload#\n\n * AsyncSeriesBailHook\n * 在 esbuild onLoad callbacks 触发，根据模块路径来获取模块内容\n * 输入参数\n\n\n\n * 返回参数\n\n\n\n * 例子\n\n\n\ntransform#\n\n * AsyncSeriesWaterFallHooks\n * 在 esbuild onLoad callbacks 触发， 将 load 阶段获取的模块内容进行转换\n * 输入参数(返回参数)\n\n\n\n * 例子\n\n\n\nrenderChunk#\n\n * AsyncSeriesWaterFallHooks\n * 在 esbuild onEnd callbacks 触发， 类似于 transform hook，但是作用在 esbuild 生成的产物\n * 输入参数(返回参数)\n\n\n\n * 例子\n\n\n\n\n类型文件生成#\n\nbuildConfig.dts 配置主要用于类型文件的生成。\n\n\n关闭类型生成#\n\n默认情况下类型生成功能是开启的，如果需要关闭的话，可以按照如下配置：\n\n\n\nTIP\n\n关闭类型文件后，一般来说构建速度会有所提升。\n\n\n打包类型文件#\n\n在 buildType: 'bundleless' 的时候，类型文件的生成是使用项目的 tsc 命令来完成生产。\n\nModern.js Module 同时还支持对类型文件进行打包，不过使用该功能的时候需要注意：\n\n * 对类型文件进行打包不会开启类型检查。\n * 一些第三方依赖存在错误的语法会导致打包过程失败。因此对于这种情况，需要手动通过 buildConfig.externals\n   将这类第三方包排除，或者直接关闭dts.respectExternal从而不打包任何三方包类型。\n * 对于第三方依赖的类型文件指向的是一个 .ts 文件的情况，目前无法处理。比如第三方依赖的 package.json 中存在这样的内容： {\"types\":\n   \"./src/index.ts\"。\n\n对于上述问题，我们推荐的处理方式是首先使用 tsc 生成 d.ts 文件，然后将 index.d.ts 作为入口进行打包处理，并且关闭\ndts.respectExternal。在之后的演进我们也会逐渐向这种处理方式靠拢。\n\n\n别名转换#\n\n在 bundleless 构建过程中，如果源代码中出现了别名，例如：\n\n\n\n使用 tsc 生成的产物类型文件也会包含这些别名。不过 Modern.js Module 会对 tsc 生成的类型文件里的别名进行转换处理。\n\n\n一些示例#\n\n\n\n\n\n\n构建过程#\n\n当执行 modern build 命令的时候，会发生\n\n * 根据 buildConfig.outDir 清理产物目录。\n * 编译 js/ts 源代码生成 bundle / bundleless 的 JS 构建产物。\n * 使用 tsc 生成 bundle / bundleless 的类型文件。\n * 处理 copy 任务。\n\n\n构建报错#\n\n当发生构建报错的时候，基于以上了解到的信息，可以很容易的明白在终端出现的报错内容：\n\njs 或者 ts 构建的报错：\n\n\n\n类型文件生成过程的报错：\n\n\n\n对于 js/ts 构建错误，我们可以从报错信息中知道：\n\n * 报错的 buildType\n * 报错的 format\n * 报错的 target\n * 其他具体报错信息\n\n\n调试模式#\n\n从 2.36.0 版本开始，为了便于排查问题，Modern.js Module 提供了调试模式，你可以在执行构建时添加 DEBUG=module\n环境变量来开启调试模式。\n\n\n\n调试模式下，你会看到 Shell 中输出更详细的构建日志，这主要以流程日志为主：\n\n\n\n另外，Module 还提供了调试内部工作流程的能力。你可以通过设置环境变量 DEBUG=module:* 来开启更详细的调试日志:\n\n目前只支持了 DEBUG=module:resolve，可以查看 Module 内部模块解析的详细日志:\n\n","routePath":"/module-tools/guide/advance/in-depth-about-build","lang":"zh","toc":[{"text":"`bundle` / `bundleless`","id":"bundle--bundleless","depth":2,"charIndex":-1},{"text":"`input` / `sourceDir`","id":"input--sourcedir","depth":2,"charIndex":-1},{"text":"使用 swc","id":"使用-swc","depth":2,"charIndex":1281},{"text":"使用 Hook 介入构建流程","id":"使用-hook-介入构建流程","depth":2,"charIndex":1762},{"text":"Hook 类型","id":"hook-类型","depth":3,"charIndex":1936},{"text":"AsyncSeriesBailHook","id":"asyncseriesbailhook","depth":4,"charIndex":1946},{"text":"AsyncSeriesWaterFallHooks","id":"asyncserieswaterfallhooks","depth":4,"charIndex":2048},{"text":"Hook 顺序","id":"hook-顺序","depth":3,"charIndex":2117},{"text":"Hook API","id":"hook-api","depth":3,"charIndex":2197},{"text":"load","id":"load","depth":4,"charIndex":2208},{"text":"transform","id":"transform","depth":4,"charIndex":2316},{"text":"renderChunk","id":"renderchunk","depth":4,"charIndex":2438},{"text":"类型文件生成","id":"类型文件生成","depth":2,"charIndex":2580},{"text":"关闭类型生成","id":"关闭类型生成","depth":3,"charIndex":2622},{"text":"打包类型文件","id":"打包类型文件","depth":3,"charIndex":2699},{"text":"别名转换","id":"别名转换","depth":3,"charIndex":3170},{"text":"一些示例","id":"一些示例","depth":3,"charIndex":3288},{"text":"构建过程","id":"构建过程","depth":2,"charIndex":3300},{"text":"构建报错","id":"构建报错","depth":2,"charIndex":3474},{"text":"调试模式","id":"调试模式","depth":2,"charIndex":3647}],"domain":"","frontmatter":{"sidebar_position":1},"version":""},{"id":64,"title":"深入理解 dev 命令","content":"#\n\nModern.js Module 提供的 dev 命令主要用于代码的调试。\n\n\n命令运行的整体流程#\n\n 1. 当执行 dev 命令的时候，Modern.js Module 开始寻找是否存在可以执行的调试工具或者任务。调试工具或者任务就是类似 doc 这样的\n    Modern.js Module 调试工具插件。\n 2. 当发现存在一个调试工具的时候，则会立即执行它。\n 3. 当发现多个调试工具的时候，则显示调试工具列表菜单。可以通过选择某个调试工具对应的名称选项启动它。\n 4. 当没有发现调试工具的时候，则告诉用户没有可用的调试工具。\n\n我们除了可以执行 dev 命令以外，也可以通过 dev [调试工具名称] 的方式来直接启动调试工具或者任务。\n\n\n扩展 dev 命令#\n\n如果需要扩展 dev 命令或者说提供自己的 Modern.js Module 调试工具插件，那么你需要先了解以下内容：\n\n * 开发插件\n * 调试工具插件 API\n\n一般来说，实现一个什么都不做的调试工具，其实现代码以及相关配置如下：\n\n\n\n如果需要使用该调试工具插件，则需要在配置文件中增加它：\n\n\n\n此时我们执行 dev 或者 dev do-nothing 命令的时候，就可以执行它了。在执行后，它会先执行监听模式的源码构建任务，并紧接着打印日志信息。\n\n对于目前官方支持的调试工具和第三方支持的调试工具，可以在插件列表中查看。","routePath":"/module-tools/guide/advance/in-depth-about-dev-command","lang":"zh","toc":[{"text":"命令运行的整体流程","id":"命令运行的整体流程","depth":2,"charIndex":42},{"text":"扩展 dev 命令","id":"扩展-dev-命令","depth":2,"charIndex":333}],"domain":"","frontmatter":{"sidebar_position":2},"version":""},{"id":65,"title":"开始之前","content":"#\n\n\n环境准备#\n\n为了使用 Modern.js Module，首先需要 NodeJS，我们推荐最新的长期维护版本，并确保 Node 版本大于等于 16.0.0。因为非稳定的\nNodeJS 时常有一些 Bug，你可以使用 nvm-windows 和 nvm（Mac / Linux）安装，这样你就可以方便地切换到不同的 NodeJS\n版本，这些版本可能会用于不同的项目。\n\n\n初识 npm#\n\n当 NodeJS 被安装后，你不仅可以在命令行中访问 node 可执行程序，同时你也可以执行 npm 命令。\n\nnpm 是 NodeJS 的标准软件包管理器。它一开始的用途是用于下载和管理 NodeJS 包的依赖关系，但后来它逐渐变成为一个用于前端 JavaScript\n的工具。\n\n如果你已经对 npm 和 npm 包的使用方式有所了解，那么可以直接跳到「npm 包管理器」部分。\n\n\nnpm 包类型项目#\n\n那么什么是 npm 包类型的项目呢？当我们在一个空的项目目录下执行 npm init 命令的时候，它会在当前目录下面创建一个文件名为 package.json\n的 JSON 文件。在创建过程中，我们需要填写包括但不限于 npm 包的名称、版本号、描述等等内容，这些填写的内容都会在生成的 package.json\n文件中找到：\n\n\n\n此时这个包含了初始化后的 package.json 文件的项目就是一个 npm 包类型的项目，你可以执行 npm publish 命令将这个项目发布到 npm\nRegistry。\n\nnpm Registry 是一个 npm 包存储的地方，开发者们不仅可以将他们自己的 npm 包发布到 npm Registry，还可以通过 npm\nRegistry 使用其他开发者发布的 npm 包。\n\n优质的 npm 包会有更多的人去使用，因为它不仅节省了很多代码实现的工作，同时也不容易让项目出现问题。\n\n\n使用第三方 npm 包#\n\n当要为初始化的项目增加第三方的 npm 包的时候，我们可以把这一过程叫做“为项目安装依赖”或是“为项目增加依赖”。在增加依赖之前，首先我们要特别了解一件事情\n—— npm 依赖的软件包类型：\n\n * \"dependencies\"：一种是你的应用程序在生产环境中需要的软件包。\n * \"devDependencies\"：另一种是仅在本地开发和测试中需要的软件包。\n   \n   > 软件包可以理解为是第三方的 npm 包。\n\n你可以通过执行 npm install npm-package-name 或者 npm add npm-package-name\n的方式来安装在生产环境中需要的软件包，或者也可以在 package.json 文件中手动的将需要安装的包和对应的语义化版本写在 \"dependencies\"\n里，并执行 npm install 命令：\n\n\n\n同理，你也可以执行 npm install npm-package-name --save-dev 或 npm add npm-package-name\n--save-dev 的方式来安装仅在本地开发和测试中需要的软件包，或者也可以在 package.json 文件中手动的将需要安装的包和对应的语义化版本写在\n\"devDependencies\" 里，并执行 npm install 命令：\n\n\n\n在安装或者使用第三方 npm 包的时候一定要确定它们的用途，以及通过区分它们的类型确定好它们应该放在 \"dependencies\" 还是\n\"devDependencies\" 中。\n\nTIP\n\n一般来说，需要在源代码中使用到的包都属于 dependencies 依赖。除非你通过打包的方式将依赖的代码输出到本地，那么这种情况可以将它作为\ndevDependencies 依赖。\n\n\n还需要了解的 npm 零碎知识#\n\n\nnpm 包的程序入口#\n\n在 package.json 中存在一个 \"main\" 属性，它对应的值是一个模块 ID，或者更直观的说是一个 NodeJS 文件路径，它是你程序的主要入口。\n\n例如你的包名为 foo，并且用户安装了它，然后执行 require(\"foo\") 代码，那么 foo 这个 npm 包的 \"main\"\n字段对应的文件将会被导出。\n\n推荐在你的 npm 包里一定要设置 \"main\" 字段。如果没有设置 \"main\"，则默认入口为包的根目录下的 index.js 文件。\n\n除了需要设置 \"main\" 属性以外，一般还会设置 \"module\" 属性。它与 \"main\" 属性的用途类似，它主要是用于在 webpack\n场景下使用。webpack 在大多数情况下，会以 \"module\" -> \"main\" 这个顺序读取 npm 包的入口（文件）。\n\n> 想要了解关于 webpack 如何做这件事，可以查看这个链接。\n\n\n\"scripts\"#\n\npackage.json 文件的 \"scripts\" 属性支持一些内置的脚本和 npm 预设的生命周期事件，以及任意的脚本。\n\n这些都可以通过运行 npm run-script 或简称 npm run 来执行。\n\n名称匹配的前置命令和后置命令也会被运行（例如 premyscript、myscript、postmyscript）。\n\n\n\n当执行 npm run myscripts 的时候，premyscripts 对应的脚本会在它之前执行，postmyscripts 对应的脚本会在它之后执行。\n\n来自依赖的脚本命令可以用 npm explore -- npm run 运行。\n\n还有一些特殊的生命周期脚本（Life Scripts），只在某些情况下发生。这里介绍几个通常需要了解的情况。\n\nnpm install#\n\n当你运行 npm install -g 时，以下脚本会运行。\n\n * preinstall\n * install\n * postinstall\n * prepublish\n * preprepare\n * prepare\n * postprepare\n\n如果你的软件包根目录有一个 binding.gyp 文件，而你没有定义 install 或 preinstall 脚本，那么 npm 将以 node-gyp\nrebuild 作为默认的 install 命令，使用 node-gyp 进行编译。\n\nnpm publish#\n\n当发布项目的时候，执行该命令会触发以下脚本：\n\n * prepublishOnly\n * prepack\n * prepare\n * postpack\n * publish\n * postpublish\n\n当以 --dry-run 模式运行的时候，prepare 对应的脚本将不会执行。\n\n\npeerDependencies#\n\n在某些情况下，你的 npm 项目与它的宿主工具或者库之间存在某种兼容关系（例如一个 webpack 插件项目和 webpack），同时你的 npm\n项目不想将宿主作为必要的依赖，这个时候通常说明你的项目可能是这个宿主工具或者库的插件。你的 npm\n项目会对宿主包的版本有一定的要求，因为只有在特定的版本下才会暴露出 npm 项目所需要的 API。\n\n关于更多 peerDependencies 的解释，可以通过下面的链接了解 npm、pnpm、Yarn 对于它的不同处理方式：\n\n * npm 对 peerDependencies 的解释\n * pnpm vs npm VS Yarn\n\n\nnpm 包管理器#\n\n除了 npm 这种标准的包管理器以外，目前主流的还有 pnpm 和 Yarn，它们都是不错的 npm cli 替代品。\n\n推荐使用 pnpm 来管理项目依赖，可以通过下面的方式安装它：\n\n\n\n\nModern.js Module 配置文件#\n\n通过 @modern-js/create 创建的项目目录下提供了 Modern.js Module 的配置文件 ——\nmodern.config.(j|t)s。但 modern.config 配置文件不是必须存在的。\n\n默认情况下，生成的配置文件的内容如下：\n\n\n\n我们推荐使用 defineConfig 函数，不过并不强制使用它。因此你也可以在配置文件中直接返回一个对象：\n\n","routePath":"/module-tools/guide/basic/before-getting-started","lang":"zh","toc":[{"text":"环境准备","id":"环境准备","depth":2,"charIndex":3},{"text":"初识 npm","id":"初识-npm","depth":2,"charIndex":188},{"text":"npm 包类型项目","id":"npm-包类型项目","depth":2,"charIndex":391},{"text":"使用第三方 npm 包","id":"使用第三方-npm-包","depth":2,"charIndex":818},{"text":"还需要了解的 npm 零碎知识","id":"还需要了解的-npm-零碎知识","depth":2,"charIndex":1602},{"text":"npm 包的程序入口","id":"npm-包的程序入口","depth":3,"charIndex":1621},{"text":"\"scripts\"","id":"scripts","depth":3,"charIndex":2042},{"text":"`npm install`","id":"npm-install","depth":4,"charIndex":-1},{"text":"`npm publish`","id":"npm-publish","depth":4,"charIndex":-1},{"text":"peerDependencies","id":"peerdependencies","depth":3,"charIndex":2825},{"text":"npm 包管理器","id":"npm-包管理器","depth":2,"charIndex":3139},{"text":"Modern.js Module 配置文件","id":"modernjs-module-配置文件","depth":2,"charIndex":3247}],"domain":"","frontmatter":{"sidebar_position":1},"version":""},{"id":66,"title":"CLI 命令","content":"#\n\nModern.js Module 项目可以使用的 CLI 命令如下：\n\n\nmodern build#\n\n\n\nModern.js Module 支持 platform 构建模式，可以用于执行其他工具的构建任务，目前官方支持的有 Rspress。例如，可以通过执行\nmodern build --platform 命令启动 doc 构建任务生成 doc 产物。\n\n\nmodern new#\n\n\n\nmodern new 命令用于启动微生成器功能，它可以为项目启用默认没有提供的功能。\n\n目前可以开启的功能有：\n\n * Storybook V7\n * Tailwind CSS 支持\n * Modern.js Runtime API\n\n关于这些功能，可以通过「使用微生成器」 章节了解更多。\n\n\nmodern dev#\n\n\n\nModern.js Module 提供了使用调试工具的能力，可以通过 modern dev\n命令来启动。不过要注意的是，默认情况下是没有提供调试相关的插件，因此此时执行 modern dev 会提示： \"No dev tools found\navailable\"。\n\n目前官方支持的调试工具有 Rspress，因此在你执行 modern new 命令开启它后，就可以执行 modern dev 或者 modern dev doc\n执行它。\n\n\nmodern change#\n\n\n\nmodern change 命令用于生成 changesets 需要的 Markdown 文件。\n\n\nmodern pre#\n\n\n\n可以使用 modern pre 命令在正式发布前预发布一个版本。\n\n\nmodern bump#\n\n\n\n按照 changesets 生成的变更记录的 Markdown 文件修改 package.json 中的版本号， 同时生成 CHANGELOG.md 文件。\n\n\nmodern release#\n\n\n\nmodern release 命令可以将模块发布到 npm Registry 上。\n\n * --tag 参数可以指定发布时具体的 dist tags。\n\n\nmodern gen-release-note#\n\n\n\n根据当前仓库的 changeset 信息自动生成 Release Note。\n\nTIP\n\n需要在 bump 命令之前执行。\n\n\nmodern upgrade#\n\n\n\nmodern upgrade 命令，用于升级项目 Modern.js 相关依赖至最新版本。\n\n在项目根目录下执行命令 npx modern upgrade，会默认将当前执行命令项目的 package.json 中的 Modern.js\n相关依赖更新至最新版本。","routePath":"/module-tools/guide/basic/command-preview","lang":"zh","toc":[{"text":"`modern build`","id":"modern-build","depth":2,"charIndex":-1},{"text":"`modern new`","id":"modern-new","depth":2,"charIndex":-1},{"text":"`modern dev`","id":"modern-dev","depth":2,"charIndex":-1},{"text":"`modern change`","id":"modern-change","depth":2,"charIndex":-1},{"text":"`modern pre`","id":"modern-pre","depth":2,"charIndex":-1},{"text":"`modern bump`","id":"modern-bump","depth":2,"charIndex":-1},{"text":"`modern release`","id":"modern-release","depth":2,"charIndex":-1},{"text":"`modern gen-release-note`","id":"modern-gen-release-note","depth":2,"charIndex":-1},{"text":"`modern upgrade`","id":"modern-upgrade","depth":2,"charIndex":-1}],"domain":"","frontmatter":{"sidebar_position":2},"version":""},{"id":67,"title":"修改输出产物","content":"#\n\n\n默认输出产物#\n\n当你在初始化的项目里使用 modern build 命令的时候，Modern.js Module 会根据当前配置内容，生成相应的构建产物。\n\n模板创建的默认配置内容如下：\n\n\n\n默认生成产物具有以下特点：\n\n * 会生成 CommonJS 和 ESM 两份产物。\n * 代码语法支持到 ES6 ,更高级的语法将会被转换。\n * 所有的代码经过打包变成了一个文件，即进行了 bundle 处理。\n * 产物输出根目录为项目下的 dist 目录，类型文件输出的目录为 dist/types。\n\n看到这里你可能会有以下疑问：\n\n 1. buildPreset 是什么？\n 2. 产物的这些特点是由什么决定的？\n\n接下来，我们首先来了解一下 buildPreset。\n\n\n构建预设#\n\nbuildPreset 代表着提前准备好的一组或者多组构建相关的配置，只需要使用 buildPreset\n对应的预设值，就可以省去麻烦且复杂的配置工作，得到符合预期的产物。\n\nModern.js Module 主要内置了两套构建预设，包括:\n\n * npm-component: 用于构建组件库。\n * npm-library: 用于打包其他库类型的项目，如工具库。\n\n同时，还提供一些变体，例如 npm-library-with-umd 和 npm-library-es5，顾名思义，分别对应带有 umd 产物和支持到 es5\n语法的库预设。 详细配置可以查看其 API 。\n\n除此之外，我们也可以完全自定义构建配置:\n\n\n构建配置#\n\nbuildConfig 是一个用来描述如何编译、生成构建产物的配置项。在最开始提到的关于“构建产物的特点”，其实都是 buildConfig\n所支持的属性。目前所支持的属性覆盖了大部分模块类型项目在构建产物时的需求，buildConfig\n不仅包含一些产物所具备的属性，也包含了构建产物所需要的一些特性功能。接下来从分类的角度简单罗列一下：\n\n构建产物的基本属性包括：\n\n * 产物是否被打包：对应的 API 是 buildConfig.buildType。\n * 产物对于语法的支持：对应的 API 是 buildConfig.target。\n * 产物格式：对应的 API 是 buildConfig.format。\n * 产物类型文件如何处理，对应的 API 是 buildConfig.dts。\n * 产物的 sourceMap 如何处理：对应的 API 是 buildConfig.sourceMap。\n * 产物对应的输入（或者是源文件）：对应的 API 是 buildConfig.input。\n * 产物输出的目录：对应的 API 是 buildConfig.outDir。\n * 构建的源码目录：对应的 API 是 buildConfig.sourceDir。\n\n构建产物所需的常用功能包括：\n\n * 别名：对应的 API 是 buildConfig.alias。\n * 静态资源处理：对应的 API 是 buildConfig.asset。\n * 第三方依赖处理：对应的 API 有：\n   * buildConfig.autoExternal。\n   * buildConfig.externals。\n * 拷贝：对应的 API 是 buildConfig.copy。\n * 全局变量替换：对应的 API 是 buildConfig.define。\n * 指定 JSX 编译方式，对应的 API 是 buildConfig.jsx。\n\n一些高级属性或者使用频率不高的功能：\n\n * 产物代码压缩：对应的 API 是 buildConfig.minify。\n * 代码分割：buildConfig.spitting\n * 指定构建产物用于 NodeJS 环境还是浏览器环境：对应的 API 是 buildConfig.platform。\n * umd 产物相关：\n   * 指定 umd 产物外部导入的全局变量：对应的 API 是 buildConfig.umdGlobals。\n   * 指定 umd 产物的模块名：对应的 API 是 buildConfig.umdModuleName。\n\n除了以上分类以外，关于这些 API 的常见问题和最佳实践可以通过下面的链接来了解：\n\n * 关于 bundle 和 bundleless\n * 关于 input 和 sourceDir。\n * 关于类型描述文件。\n * 如何使用 define\n * 如何处理第三方依赖\n * 如何使用拷贝\n * 如何构建 umd 产物\n * 如何使用静态资源\n\n\n结合配置与预设#\n\n了解 buildPreset 和 buildConfig 之后，我们可以将二者进行结合使用。\n\n在实际项目中,我们可以先使用 buildPreset 来快速获取一套默认构建配置。如果需要自定义,可以使用 buildConfig 进行覆盖和扩展。\n\n扩展的逻辑如下:\n\n * 当 buildConfig 是数组时，会在原来的预设基础上添加新的配置项。\n\n\n\n这会在原本预设的基础上，额外生成一份 IIFE 格式、支持到 ES2020 语法的产物，输出目录为项目下的 dist/global 目录。\n\n * 当 buildConfig 是对象时,会将对象中的配置项覆盖到预设中。\n\n\n\n这会使得每一项构建任务都会生成 sourceMap 文件。","routePath":"/module-tools/guide/basic/modify-output-product","lang":"zh","toc":[{"text":"默认输出产物","id":"默认输出产物","depth":2,"charIndex":3},{"text":"构建预设","id":"构建预设","depth":2,"charIndex":344},{"text":"构建配置","id":"构建配置","depth":2,"charIndex":664},{"text":"结合配置与预设","id":"结合配置与预设","depth":2,"charIndex":1952}],"domain":"","frontmatter":{"sidebar_position":3},"version":""},{"id":68,"title":"版本管理与发布","content":"#\n\n一个 npm 类型的模块项目发布流程包含了两个阶段：\n\n * 第一阶段是在开发期间，开发者需要提供变更文件，该文件记录了在发布期间需要的变更内容；\n * 第二阶段是在发布期间，需要收集所有的变更文件来更新版本、更新发布日志，并发布新的包到 npm Registry 上。\n\nModern.js Module 提供了一套版本管理与发布的方案，这适用于单包场景。对于 monorepo 里的 npm 包你需要遵循各类 monorepo\n解决方案提供的策略。\n\n\n跟踪变更#\n\n当项目发生变化的时候需要将变化的内容记录下来。项目发生的变化一般是指：\n\n * 新功能\n * 修复问题\n * 配置文件修改\n * ...\n\n当这些任务一旦开发完成后，需要通过以下命令来对当前的变化进行记录：\n\n * modern change\n\n执行 modern change 命令后会向开发者提出几个问题，并根据开发者的回答生成变更记录。变更记录文件包含了版本变化的类型和其描述，该文件会被提交到\ngit 仓库中。\n\n\n\n当执行成功后，生成的包含变更记录的 Markdown 文件会保存在项目的 .changeset 目录下面。其内容类似下面这样：\n\n\n\n\n版本更新#\n\n当需要更新项目版本的时候，执行以下命令：\n\n * modern bump\n\n执行 modern bump 将会基于 .changeset/ 目录下记录了变更的 Markdown 文件内容来修改 package.json\n中的版本号，同时生成 CHANGELOG.md 文件。而当版本更新完成后，这些记录变更的 Markdown 文件也会被删除，也可说这些 Markdown\n文件被“消耗”掉了。\n\n\n\n\n发布#\n\n发布项目可以执行以下命令：\n\n * modern release\n\nmodern release 命令可以将项目发布到 npm Registry。\n\n此时发布的是 latest 版本，也可以说是正式版本。如果想要修改 dist-tag，可以通过 modern release --tag 命令来指定。例如：\n\n\n\n但是如果希望将当前项目的版本号也修改为预发布的版本号，则需要使用 modern pre 命令。\n\n> 所谓 dist-tag，可以理解：为当前发布的版本打标签。一般来说，默认发布的版本对应的 dist-tag 为 latest，因此可以把 latest\n> 认为是正式版本的 dist-tag。\n\n\n预发布#\n\n当需要在正式发布之前进行预发布，则需要执行以下命令：\n\n * modern pre\n\n首先 modern pre enter 进入预发布模式， 可以与发布项目的时候使用 modern release --tag 命令指定的 tag 一致。\n\n\n\n接着可以使用 modern bump 命令更新具体的版本号，此时不会真正的“消耗”记录变更的 Markdown 文件：\n\n\n\n然后可以看到 package.json 中更新的版本号会类似这样：0.1.2-next.0。\n\n最后，如果不需要再进行预发布，则一定要执行 modern pre exit 命令，这样可以退出预发布状态，并且当再次执行 modern bump\n命令的时候，就可以发布正式的版本。","routePath":"/module-tools/guide/basic/publish-your-project","lang":"zh","toc":[{"text":"跟踪变更","id":"跟踪变更","depth":2,"charIndex":231},{"text":"版本更新","id":"版本更新","depth":2,"charIndex":519},{"text":"发布","id":"发布","depth":2,"charIndex":728},{"text":"预发布","id":"预发布","depth":2,"charIndex":1040}],"domain":"","frontmatter":{"sidebar_position":7},"version":""},{"id":69,"title":"使用微生成器","content":"#\n\nModern.js Module 提供了微生成器工具，它可以为当前项目：\n\n * 新增目录和文件\n * 修改 package.json\n * 执行命令\n\n因此通过这些能力，微生成器可以为项目开启额外的特性功能。\n\n可以通过 modern new 启动微生成器。目前 Modern.js Module 支持的微生成器功能有：\n\n\n开发模块文档#\n\n当我们想要为模块编写文档的时候，可以启用模块文档功能。会在项目目录下创建 docs 目录以及相关文件，在 package.json 中新增\n\"@modern-js/plugin-rspress\" 依赖。 使用 modern dev 和 modern build --platform\n来调试和构建你的文档站点。\n\nTIP\n\n在成功开启后，会提示需要手动在配置中增加如下类似的代码。\n\n\n\n\nStorybook 调试#\n\n当我们想要对组件或者普通模块进行调试的时候，可以启用 Storybook 调试功能。启动该功能后，会在项目目录下创建 stories 目录以及\n.storybook 目录，在 package.json 中新增 \"@modern-js/storybook\" 依赖。使用 storybook dev 和\nstorybook build 来调试和构建。\n\n\nTailwind CSS 支持#\n\nTailwind CSS 是一个以 Utility Class 为基础的 CSS 框架和设计系统，可以快速地为组件添加常用样式，同时支持主题样式的灵活扩展。\n\n如果你想要在项目使用 Tailwind CSS，可以参考 「使用 Tailwind CSS」。\n\n\nModern.js Runtime API 支持#\n\nModern.js 提供了 Runtime API 能力，这些 API 只能在 Modern.js 的应用项目环境中使用。如果你需要开发一个 Modern.js\n应用环境中使用的组件，那么你可以开启该特性，微生成器会增加 \"@modern-js/runtime\"依赖。\n\n另外，Storybook 调试工具也会通过检测项目的依赖确定项目是否需要使用 Runtime API，并且提供与 Modern.js 应用项目一样的\nRuntime API 运行环境。\n\nTIP\n\n在成功开启后，会提示需要手动在配置中增加如下类似的代码。\n\n","routePath":"/module-tools/guide/basic/use-micro-generator","lang":"zh","toc":[{"text":"开发模块文档","id":"开发模块文档","depth":2,"charIndex":166},{"text":"Storybook 调试","id":"storybook-调试","depth":2,"charIndex":370},{"text":"Tailwind CSS 支持","id":"tailwind-css-支持","depth":2,"charIndex":561},{"text":"Modern.js Runtime API 支持","id":"modernjs-runtime-api-支持","depth":2,"charIndex":709}],"domain":"","frontmatter":{"sidebar_position":4},"version":""},{"id":70,"title":"开发模块文档","content":"#\n\n本章介绍如何为模块项目快速搭建一个静态文档站点。\n\n\n开始之前#\n\n\n为什么我们需要为模块搭建一个文档站点#\n\n 1. 文档站点可以帮助我们更好地组织文档的结构。\n 2. 文档站点具有更好的表现形式，例如可以在页面中执行函数，渲染组件等。\n 3. 可以更好地利用 AI 搜索的能力。\n\n\n前置准备#\n\n 1. 通过微生成器开启文档功能。\n 2. 阅读Rspress 介绍。\n\n完成准备工作之后，接下来我们会基于 Rspress 为模块项目搭建一个文档站点。\n\n\n站点基本结构#\n\n站点整体布局由三部分组成：导航栏、侧边栏以及正文部分，其中正文还包括了 TOC(Table of contents found at the beginning\nof a book or document)。\n\nRspress 使用的是文件系统路由，模块文档基于此实现了侧边栏的自动生成。 例如，如果你有以下的文件结构：\n\n\n\n那么 foo/bar.md 的路由路径会是 /foo/bar，foo.md 的路由路径会是 /foo，index.md 的路由路径会是 /。\n\n具体映射规则如下：\n\n文件路径            路由路径\nindex.md        /\n/foo.md         /foo\n/foo/index.md   /foo/\n/foo/bar.md     /foo/bar\n\n与上述文件路径和路由路径依次对应的侧边栏如下所示：\n\n\n配置侧边栏#\n\n如上图所示，模块文档已经为文件系统路由自动生成了侧边栏，其中侧边栏每一栏的文本是由文件的一级标题或者目录名决定。 如果你需要自定义侧边栏，请使用\n_meta.json 或者直接配置 sidebar。\n\nINFO\n\n如果你的文档目录结构是符合国际化的，例如：\n\n\n\n你需要按照国际化章节，同时配置 lang 和 locales，否则模块自动生成的侧边栏不会处理 zh 和 en 这两个目录。\n\n\n编写文档#\n\n接下来我们可以专注于文档内容的编写了。除了最基本的编写 markdown 以外，你可能还需要了解以下进阶内容：\n\n * 使用 MDX\n * 使用静态资源\n\n\n组件预览#\n\n模块文档为组件库提供了预览能力，jsx和tsx的代码块里的内容将会被解析为 React 组件。\n\n\n示例#\n\n假设我们的项目名是demo，并导出了一个 Button 组件。\n\n 1. 首先新增 docs/Button.mdx 文件：\n\n\n\n 2. 在tsconfig.json里配置别名，将包名指向当前项目目录，使得文档开发者和用户使用组件方式一致：\n\n\n\n 3. 在 .gitignore 文件下添加 doc_build/，文档产物将会生成在此目录下：\n\n\n\n恭喜你，已经完成了一个组件文档的编写，执行pnpm run dev看看效果吧，记得先构建一下组件库，确保组件产物存在。\n\n\n移动端预览#\n\n同时，我们也支持了移动端预览的方式，即使用 iframe 渲染移动端组件，并可以通过 iframePosition 设置 iframe\n的位置，支持扫码预览以及新页面打开。\n\n\n\nTIP\n\n如果只想要改变某一个 jsx 和 tsx 代码块的预览方式，可以使用不同的修饰符进行标识：\n\n\n\n\n使用外部 demo#\n\n如果我们的 demo 非常复杂，那么建议单独编写 demo，然后在 MDX 中使用 code 标签：\n\n\n\n这同样支持单独设置代码块的预览方式，例如：\n\n\n\n\n使用内置组件#\n\n插件内部实现了一部分内置组件，以便于你可以更轻松地开发模块文档。\n\n\nAPI#\n\n展示模块的 API 内容\n\n解析文件#\n\n在使用 API 组件之前，首先我们需要指定解析的文件：\n\n\n\n内容生成#\n\n接下来我们了解一下根据解析的文件会生成什么样的 markdown 内容。\n\n内容可以通过 react-docgen-typescript 或者 documentation 两个不同的工具生成：\n\n * react-docgen-typescript针对于组件库场景，仅会解析 props 生成表格。\n\n\n\n上面是一个标准写法，其中 ButtonProps 将被提取至表格中， Button 作为表格的标题。如果使用默认导出，文件名将作为表格标题。\n\n需要注意的是，export 导出事先定义的特性将不会被解析。\n\n\n\n生成的内容如下：\n\n\n\nWARNING\n\n如果 Props 里使用了 React 的类型，你需要在 tsconfig.json 里添加 types ，否则会解析不到 React 命名空间下的类型。\n\n\n\n更好的方式是直接引用类型，例如\n\n\n\n * documentation适用于工具库场景，用来解析 JSDoc 注释。\n\n\n\n上面是一个带有 JSDoc 注释的 greet 函数。生成的内容如下：\n\n\n\n组件使用#\n\n接下来，你便可以在文档里使用我们的内置 API 组件了，将key值传入moduleName属性里\n\n\n\n\nOverview#\n\n展示模块列表，可以放在首页用来展示所有模块。\n\nOverview 组件只有一个 list 属性，接收一个对象数组，下面是对象的属性\n\n属性      说明       类型                默认值\nicon    图标       React.ReactNode   \ntext    文本(必填)   string            \nlink    链接(必填)   string            \narrow   是否展示箭头   boolean           false\n\n\n插件配置#\n\n\napiParseTool#\n\nAPI 解析工具\n\n * 类型：'react-docgen-typescript' | 'documentation'\n * 默认值：'react-docgen-typescript'\n\n\ndoc#\n\n文档框架配置\n\n\nentries#\n\n自动生成文档的模块名称及相对路径\n\n * 类型：Entries | ToolEntries\n * 默认值：{}\n\n\n\nEntries 同时支持针对不同的文件使用不同的解析工具：\n\n\n\n\niframePosition#\n\niframe 所处页面位置\n\n * 类型：'follow' | 'fixed'\n * 默认值: 'follow'\n\nfollow时，每一个代码块都会有一个 iframe 展示其渲染视图。 fixed时，iframe 将会固定在页面右侧，展示当前页面所有代码块的视图。\n\n\nparseToolOptions#\n\nAPI 解析工具的参数\n\n * 类型：ParseToolOptions\n * 默认值：{}\n\n\n\n\npreviewMode#\n\n代码块预览方式。\n\n * 类型：'internal' | 'iframe'\n * 默认值: 'internal'\n\ninternal时，代码块内容将会直接渲染在页面中，反之将会通过 iframe 加载。\n\n\ndeprecated: languages#\n\nWARNING\n\n从 2.44.0 版本开始，请参考 国际化 章节来实现多语言。\n\n\ndeprecated: useModuleSidebar#\n\nWARNING\n\n从 2.44.0 版本开始，内部实现了嗅探机制，请直接使用 _meta.json 或者直接配置 sidebar 来实现自定义侧边栏。\n\n\n命令行#\n\n * modern dev: 启动文档站本地开发。\n * modern build --platform: 构建生产环境产物。\n\n\n进阶指南#\n\n以上已经介绍完了开发模块文档的基本内容，但是这对于开发一个完整的文档站是不够的。查看Rspress以深入了解我们的文档框架。 你可以通过 doc\n配置来修改文档框架配置。\n\n","routePath":"/module-tools/guide/basic/use-module-doc","lang":"zh","toc":[{"text":"开始之前","id":"开始之前","depth":2,"charIndex":29},{"text":"为什么我们需要为模块搭建一个文档站点","id":"为什么我们需要为模块搭建一个文档站点","depth":3,"charIndex":37},{"text":"前置准备","id":"前置准备","depth":3,"charIndex":146},{"text":"站点基本结构","id":"站点基本结构","depth":2,"charIndex":233},{"text":"配置侧边栏","id":"配置侧边栏","depth":3,"charIndex":625},{"text":"编写文档","id":"编写文档","depth":2,"charIndex":830},{"text":"组件预览","id":"组件预览","depth":2,"charIndex":916},{"text":"示例","id":"示例","depth":3,"charIndex":973},{"text":"移动端预览","id":"移动端预览","depth":3,"charIndex":1216},{"text":"使用外部 demo","id":"使用外部-demo","depth":3,"charIndex":1369},{"text":"使用内置组件","id":"使用内置组件","depth":2,"charIndex":1461},{"text":"API","id":"api","depth":3,"charIndex":1505},{"text":"解析文件","id":"解析文件","depth":4,"charIndex":1525},{"text":"内容生成","id":"内容生成","depth":4,"charIndex":1563},{"text":"组件使用","id":"组件使用","depth":4,"charIndex":2032},{"text":"Overview","id":"overview","depth":3,"charIndex":2092},{"text":"插件配置","id":"插件配置","depth":2,"charIndex":2360},{"text":"apiParseTool","id":"apiparsetool","depth":3,"charIndex":2368},{"text":"doc","id":"doc","depth":3,"charIndex":2478},{"text":"entries","id":"entries","depth":3,"charIndex":2493},{"text":"iframePosition","id":"iframeposition","depth":3,"charIndex":2596},{"text":"parseToolOptions","id":"parsetooloptions","depth":3,"charIndex":2749},{"text":"previewMode","id":"previewmode","depth":3,"charIndex":2818},{"text":"deprecated: languages","id":"deprecated-languages","depth":3,"charIndex":2936},{"text":"deprecated: useModuleSidebar","id":"deprecated-usemodulesidebar","depth":3,"charIndex":3003},{"text":"命令行","id":"命令行","depth":2,"charIndex":3112},{"text":"进阶指南","id":"进阶指南","depth":2,"charIndex":3184}],"domain":"","frontmatter":{"sidebar_position":5},"version":""},{"id":71,"title":"使用 Storybook","content":"#\n\nStorybook 是一个专门用于组件调试的工具，它围绕着组件开发提供了：\n\n * 丰富多样的调试能力\n * 可与一些测试工具结合使用\n * 可重复使用的文档内容\n * 可分享能力\n * 工作流程自动化\n\n在使用 Storybook 时，难免会遇到各种配置问题，需要手动配置 Babel 插件，手动配置 Webpack 去支持 less，sass 等。\nModern.js 集成了 Storybook，这对于我们开发 Storybook 项目来说极大地简化了配置工作。\n\n\nV7 (推荐)#\n\n\n开启 Storybook#\n\n可以直接使用如下命令开启 Storybook 功能。\n\n\n\n该命令会创建好 Storybook 常用的模版，包括\n\n * 创建配置文件夹 .storybook，以及默认配置文件 .storybook/main.ts\n * 创建 stories 组件示例\n * 更新 package.json，新增依赖 @storybook/addon-essential 和 @modern-js/storybook，以及创建\n   storybook 相关脚本。\n\n\n开启产物调试#\n\n事实上，Modern.js Module 是基于 esbuild 实现的，而 Storybook 使用 Webpack\n作为默认构建工具，二者的配置无法完全兼容， 所以这里我们推荐先对组件进行构建，然后在 stories 里引入组件产物。\n\n引入组件产物的方式非常简单，假设你的模块导出了一个 Button 组件，那么在 stories 里可以这样使用:\n\n\n\n如果想要更新组件，则可以在启动 Storybook 前启动监听模式的构建：\n\n\n\nINFO\n\n在开发过程中，可能会遇到无法实时获得类型定义的情况。因为只有当保存代码后，产物目录下的类型文件才会更新。此时：\n\n对于 pnpm 的项目，可以按照下面的内容对 package.json 进行修改：\n\n\n\n> 关于 pnpm 的 publishConfig 的使用，可以阅读下面这个链接。\n\n而对于 npm 和 Yarn 的项目，则只能通过手动的方式在开发阶段和发布阶段对 package.json 的 types 的值进行修改。\n\n\n开启 Rspack 构建#\n\nRspack 构建速度非常快，只需要如下配置即可使用 Rspack 作为构建工具。\n\n\n\n注意上面配置中，更改了 reactDocgen 配置，因为 Rspack 目前还不支持\n@storybook/react-docgen-typescript-plugin。\n\n\n配置#\n\n在 .storybook/main.js 中包含一些独有的配置。\n\nbundler#\n\n * 类型: 'webpack' | 'rspack'\n * 默认值: webpack\n\n指定底层打包工具使用 Webpack 还是 Rspack。\n\n\n\nbuilderConfig#\n\n * 类型: BuilderConfig\n * 默认值: undefined\n\nModern.js 的 Storybook 构建能力由 Rsbuild 提供，可通过 builderConfig 修改 Rsbuild 构建配置。\n\n\n\n\n命令行#\n\n@modern-js/storybook 代理了部分 storybook cli 的命令。\n\nstorybook dev#\n\n启动 Storybook，查看详情\n\nstorybook build#\n\n对 Storybook 进行生产环境构建，查看详情\n\n\n配置文件#\n\n配置文件中除了 Rsbuild 配置还包含一个额外的字段，builderPlugins，方便使用 Rsbuild 插件，例如启用 SWC 编译。\n\n\n\n\n从 V6 迁移至 V7#\n\n我们对于两个版本的支持方式不同，因此如果你是从 V6 迁移至 V7 的用户，我们希望你也按上述方式使用 V7，同时做以下调整:\n\n * 配置文件：将原来 root/config/storybook/main.(j|t)s 里的自定义配置（如果有）迁移到新的\n   root/.storybook/main.(j|t)s。\n * 依赖：升级 @storybook/addon-* 系列依赖（如果有）到 7 版本，并删除 @modern-js/plugin-storybook 依赖。\n * 命令: 将原来 edenx dev storybook 和 edenx build --platform 命令删除，如果习惯了原来的 pnpm run\n   dev 的调用方式，可以 将其替换成 storybook dev -p 6006 和 storybook build。\n * modern.config.(j|t)s : 删除 @modern-js/plugin-storybook 插件的注册。\n\n\nV6 (legacy)#\n\n从 2.40.0 版本开始，@modern-js/plugin-storybook将停止迭代。建议使用 V7 版本。 如果你的\n@modern-js/module-tools 版本低于 2.40.0，可以按照以下方式使用 Storybook V6:\n\n\n开启 Storybook#\n\n可以直接使用如下命令开启 Storybook 功能。\n\n\n\n该命令会创建好 Storybook 常用的模版，包括\n\n * 创建 stories 组件示例\n * 更新 package.json，新增依赖 @modern-js/plugin-storybook，以及添加 pnpm dev storybook\n   等相关脚本。\n\n\n配置 Storybook#\n\nStorybook 官方通过一个名为 .storybook 的文件夹来进行项目配置，其中包含各种配置文件。在 Modern.js Module 中，可以在项目的\nconfig/storybook 目录下增加 Storybook 配置文件。\n\n关于 Storybook 各种配置文件的使用方式，可以查看下面的链接：\n\n * Configure Storybook\n\n不过这在模块项目里使用时存在一些限制：\n\n * 不能修改 Story 文件存放的位置，即无法在 main.js 文件里修改 stories 配置。\n * 不能修改 Webpack 和 Babel 相关的配置，即无法在 main.js 文件里修改 webpackFinal 和 babel 配置。\n\n\n构建 Storybook 产物#\n\n除了可以对组件或者普通的模块进行 Storybook 调试，还可以通过下面的命令来执行 Storybook 的构建任务。\n\n\n\n构建完成后，可以在 dist/storybook-static 目录看到构建产物文件。","routePath":"/module-tools/guide/basic/using-storybook","lang":"zh","toc":[{"text":"V7 (推荐)","id":"v7-推荐","depth":2,"charIndex":239},{"text":"开启 Storybook","id":"开启-storybook","depth":3,"charIndex":250},{"text":"开启产物调试","id":"开启产物调试","depth":3,"charIndex":492},{"text":"开启 Rspack 构建","id":"开启-rspack-构建","depth":3,"charIndex":946},{"text":"配置","id":"配置","depth":3,"charIndex":1095},{"text":"bundler","id":"bundler","depth":4,"charIndex":1134},{"text":"builderConfig","id":"builderconfig","depth":4,"charIndex":1222},{"text":"命令行","id":"命令行","depth":3,"charIndex":1356},{"text":"storybook dev","id":"storybook-dev","depth":4,"charIndex":1409},{"text":"storybook build","id":"storybook-build","depth":4,"charIndex":1444},{"text":"配置文件","id":"配置文件","depth":3,"charIndex":1490},{"text":"从 V6 迁移至 V7","id":"从-v6-迁移至-v7","depth":2,"charIndex":1574},{"text":"V6 (legacy)","id":"v6-legacy","depth":2,"charIndex":2037},{"text":"开启 Storybook","id":"开启-storybook-1","depth":3,"charIndex":2178},{"text":"配置 Storybook","id":"配置-storybook","depth":3,"charIndex":2358},{"text":"构建 Storybook 产物","id":"构建-storybook-产物","depth":3,"charIndex":2705}],"domain":"","frontmatter":{"sidebar_position":5},"version":""},{"id":72,"title":"开发组件","content":"#\n\n本章将要介绍如何使用 Modern.js Module 开发组件项目。\n\n\n初始化项目#\n\n 1. 推荐使用 @modern-js/create 命令来初始化一个 npm 项目。\n\n\n\n 2. 初始化的目录结构如下：\n\n\n\n 3. 最后修改 ./src/index.ts 文件后缀和内容如下，就完成了组件项目的初始化。\n\n\n\n\n使用 Storybook 调试代码#\n\n请参考 「使用 Storybook」 来使用 Storybook 调试代码。\n\n\n开发样式#\n\n接下来我们可以给组件添加样式。\n\n目前支持开发样式的能力有：\n\n * CSS/PostCSS\n * Less\n * Scss/Sass\n * Tailwind CSS\n * CSS Modules\n\n\nCSS/PostCSS#\n\nModern.js Module 支持 PostCSS，并且内置了以下 PostCSS 插件：\n\n * flexbugs-fixes\n * custom-properties\n * initial\n * page-break\n * font-variant\n * media-minmax\n * nesting\n\n因此我们可以在项目中创建 .css 文件，并且可以直接在 css 文件中使用这些插件提供的语法支持和能力。\n\n * 源代码：\n\n\n\n * CSS 产物：\n\n\n\n\nLess#\n\nModern.js Module 支持使用 Less 开发样式。\n\n> 目前内置的 Less 版本为 v4.1.3\n\n * 源代码：\n\n\n\n * Less 产物：\n\n\n\n\nSass/Scss#\n\nModern.js Module 支持使用 Scss/Sass 开发样式。\n\n> 目前内置的 Sass 版本为 v1.54.4\n\n * 源代码：\n\n\n\n * Sass 产物：\n\n\n\n\nTailwind CSS#\n\n请参考 「使用 Tailwind CSS」 来了解相关用法。\n\n\nCSS Modules#\n\nModern.js Module 支持使用 CSS Module 开发样式。默认情况下会将以下文件识别为 CSS Module 文件：\n\n * .module.css\n * .module.less\n * .module.scss\n * .module.sass\n\n如果需要对 CSS Modules 进行配置，可以查看以下 API：\n\n * style.autoModules\n * style.modules\n\n下面是一个代码示例：\n\n\n\n\n\n\n配置构建产物#\n\n根据组件项目使用的多数场景，推荐使用 npm-component 构建预设。该预设得到的产物目录结构为：\n\n\n\n * ./dist/es: 包含了支持 es6 语法的 ES modules 格式的 bundleless 产物。\n * ./dist/lib: 包含了支持 es6 语法的 CommonJS 格式的 bundleless 产物。\n * ./dist/types: 包含了类型文件。\n\n如果对使用语法支持有要求，可以手动配置 buildPreset，并且支持在 npm-component 基础上增加后缀的方式修改支持的语法：\n\n\n\n如果对构建产物目录结构有特殊需求，则可以使用 buildConfig API，可以通过以下文档来了解使用方式：\n\n * 修改输出产物\n * 深入理解构建\n\n\n发布组件#\n\n推荐使用 Modern.js Module 提供的版本发布功能，可以参考 「版本管理与发布」。","routePath":"/module-tools/guide/best-practices/components","lang":"zh","toc":[{"text":"初始化项目","id":"初始化项目","depth":2,"charIndex":40},{"text":"使用 Storybook 调试代码","id":"使用-storybook-调试代码","depth":2,"charIndex":166},{"text":"开发样式","id":"开发样式","depth":2,"charIndex":227},{"text":"CSS/PostCSS","id":"csspostcss","depth":3,"charIndex":335},{"text":"Less","id":"less","depth":3,"charIndex":587},{"text":"Sass/Scss","id":"sassscss","depth":3,"charIndex":680},{"text":"Tailwind CSS","id":"tailwind-css","depth":3,"charIndex":784},{"text":"CSS Modules","id":"css-modules","depth":3,"charIndex":832},{"text":"配置构建产物","id":"配置构建产物","depth":2,"charIndex":1071},{"text":"发布组件","id":"发布组件","depth":2,"charIndex":1431}],"domain":"","frontmatter":{"sidebar_position":1},"version":""},{"id":73,"title":"使用 Tailwind CSS","content":"#\n\nTailwind CSS 是一个以 Utility Class 为基础的 CSS 框架和设计系统，可以快速地为组件添加常用样式，同时支持主题样式的灵活扩展。\n\nModern.js Module 支持使用 Tailwind CSS 开发组件样式。\n\n\n启用 Tailwind CSS#\n\n在 Modern.js Module 中使用 Tailwind CSS，你只需要按照以下步骤操作：\n\n 1. 在项目根目录下执行 pnpm run new，按照如下进行选择：\n\n\n\n成功开启后，你会看到 package.json 中新增了 tailwindcss 和 @modern-js/plugin-tailwindcss 依赖。\n\n 2. 在 modern.config.ts 中注册 Tailwind 插件:\n\n\n\n 3. 创建 index.css 文件，添加以下代码：\n\n\n\nINFO\n\n根据需求不同，你可以选择性地导入 Tailwind CSS 提供的 CSS 样式。请参考 @tailwind 文档 来了解 @tailwind 指令的详细用法。\n\n 4. 引用 index.css 文件，比如在入口的 src/index.jsx 文件添加如下代码：\n\n\n\n 5. 然后即可在各个组件中使用 Tailwind CSS 提供的 Utility Class 了：\n\n\n\n\n配置 Tailwind CSS#\n\n在 Modern.js Module 中，你有两种方式来配置 Tailwind CSS：\n\n 1. 使用 tailwind.config.{ts,js} 文件，该用法与 Tailwind CSS 的官方用法一致，请参考 \"Tailwind CSS -\n    Configuration\" 来了解更多用法。\n\n\n\nTIP\n\n请升级 Modern.js Module 到 >= 2.33.0 版本，以支持自动读取 tailwind.config.{ts,js} 文件。\n\n 2. 使用 style.tailwindcss 配置项，这是旧版本的用法，我们更推荐使用 tailwind.config.{ts,js} 文件进行配置。\n\n\n\n如果你同时使用了 tailwind.config.{ts,js} 文件和 style.tailwindcss 选项，那么 style.tailwindcss\n定义的配置会优先生效，并覆盖 tailwind.config.{ts,js} 中定义的内容。\n\n\nTailwind CSS 自动补全#\n\nTailwind CSS 官方提供了 Tailwind CSS IntelliSense 插件，用于在 VS Code 中自动补全 Tailwind CSS 的\nclass names、CSS functions 和 directives。\n\n你可以参考以下步骤来启动自动补全功能：\n\n 1. 在 VS Code 中安装 Tailwind CSS IntelliSense 插件。\n 2. 如果项目的根目录没有 tailwind.config.{ts,js} 文件，那么你需要创建该文件，并写入当前项目的 Tailwind CSS 配置，否则\n    IDE 插件将无法正确生效。\n\n\n构建模式#\n\n在使用 Tailwind CSS 时，请注意构建产物在 bundle 和 bundleless 两种模式下会有很大区别。\n\nTIP\n\n关于 bundle 和 bundleless 的定义，可以查看 「深入理解构建」\n\n\nBundle 模式#\n\n在 Bundle 模式下，会生成一份单独的产物 CSS 文件，并且 JS 产物不会自动引用产物 CSS 文件。\n\n * 源代码：\n\n\n\n * 产物代码：\n\n\n\n\n\n如果你需要将样式注入 JS 产物中，可以开启 style.inject 选项。\n\n如果你没有开启 style.inject，那么也可以让用户手动引用产物 CSS 文件：\n\n\n\n\nBundleless 模式#\n\n在 Bundleless 模式下，默认会引用产物 CSS 文件，无须进行额外处理。\n\n * 产物代码：\n\n\n\n\n类名前缀#\n\n你可以通过 Tailwind CSS 提供的 prefix 选项来添加类名前缀，这样可以避免潜在的类名冲突问题（比如 App 和 Module 使用了不同版本的\nTailwind CSS）。\n\n例如，通过 prefix 选项添加 foo- 前缀：\n\n\n\n * 源代码：\n\n\n\n * 产物代码：\n\n\n\n\n用法介绍#\n\n下面是一些 Tailwind CSS 的用法示例。\n\n\nHTML 类名#\n\nTailwind CSS 支持在 HTML 标签上通过类名的方式增加样式。当使用 HTML 类名的时候，请注意必须要提前导入 Tailwind CSS 相应的\nCSS 样式。\n\n\n\n样式产物（此时是 bundle 构建）：\n\n\n\n\n@apply#\n\nTailwind CSS 提供了 @apply 指令，可以通过它将 Tailwind CSS 提供的样式内联到我们编写的样式中。\n\n@apply 可以用于 CSS、Less、Sass 中。\n\n\n\n但是使用过程中，对于 Less 和 Sass 有些情况需要注意：\n\nSass#\n\n当将 Tailwind 与 Sass 一起使用时，@apply 后面存在 !important 的时候，需要使用插值来让 Sass 正确编译。\n\n * 不能正常工作：\n\n\n\n * 能够正常工作：\n\n\n\nLess#\n\n在与 Less 一起使用 Tailwind 时，你不能嵌套 Tailwind 的 @screen 指令。\n\n * 不能正常工作：\n\n\n\n * 相反，使用常规的媒体查询和 theme() 函数来引用你的屏幕尺寸，或者干脆不要嵌套你的 @screen 指令。\n\n\n\n\n\n\n关于 designSystem 配置#\n\ndesignSystem 是 Modern.js Module 中废弃的配置项。\n\n从 Modern.js Module v2.33.0 版本开始，你可以使用 Tailwind CSS 的 theme 配置项来代替\ndesignSystem，不再需要将 theme 配置拆分并设置到 designSystem 上。\n\n * 旧版本用法：\n\n\n\n * 当前版本用法：\n\n","routePath":"/module-tools/guide/best-practices/use-tailwindcss","lang":"zh","toc":[{"text":"启用 Tailwind CSS","id":"启用-tailwind-css","depth":2,"charIndex":127},{"text":"配置 Tailwind CSS","id":"配置-tailwind-css","depth":2,"charIndex":585},{"text":"Tailwind CSS 自动补全","id":"tailwind-css-自动补全","depth":2,"charIndex":1047},{"text":"构建模式","id":"构建模式","depth":2,"charIndex":1360},{"text":"Bundle 模式","id":"bundle-模式","depth":3,"charIndex":1477},{"text":"Bundleless 模式","id":"bundleless-模式","depth":3,"charIndex":1660},{"text":"类名前缀","id":"类名前缀","depth":2,"charIndex":1732},{"text":"用法介绍","id":"用法介绍","depth":2,"charIndex":1890},{"text":"HTML 类名","id":"html-类名","depth":3,"charIndex":1925},{"text":"`@apply`","id":"apply","depth":3,"charIndex":-1},{"text":"Sass","id":"sass","depth":4,"charIndex":2192},{"text":"Less","id":"less","depth":4,"charIndex":2300},{"text":"关于 `designSystem` 配置","id":"关于-designsystem-配置","depth":2,"charIndex":-1}],"domain":"","frontmatter":{"sidebar_position":2},"version":""},{"id":74,"title":"通用类问题","content":"#\n\n\nModern.js Module 和 Rsbuild 的关系？#\n\nModern.js Module 使用 esbuild 构建工具库和组件库，Rsbuild 专注于解决 Web 应用构建场景。\n\n\nModern.js Module 是否可以使用 webpack plugin 或者 loader?#\n\nModern.js Module 基于 esbuild 构建，无法使用 webpack 相关生态的工具。 这里可以发现更多 esbuild 社区插件\n\n如果 Modern.js Module 生产的 UMD 产物达不到你的要求，可以使用 Rsbuild 并添加 UMD Plugin 构建 UMD 产物。","routePath":"/module-tools/guide/faq/basic","lang":"zh","toc":[{"text":"Modern.js Module 和 Rsbuild 的关系？","id":"modernjs-module-和-rsbuild-的关系","depth":2,"charIndex":3},{"text":"Modern.js Module 是否可以使用 webpack plugin 或者 loader?","id":"modernjs-module-是否可以使用-webpack-plugin-或者-loader","depth":2,"charIndex":103}],"domain":"","frontmatter":{},"version":""},{"id":75,"title":"构建相关问题","content":"#\n\n这里只记录了一些常见问题和 bad case。\n\n如果是构建产物不符合预期的场景，尤其是配置了 buildPreset 的情况下， 请先了解 buildPreset 代表了哪些配置项，再根据所有的配置项逐个检查\n\n\n产物问题#\n\n\nClass Fields 的初始化处理#\n\nTypeSript 提供了 useDefineForClassFields 配置用于控制对于 public class fields 的转换处理。\n\n如果有一段代码：\n\n\n\n当 useDefineForClassFields 为 false 的时候，则编译后的代码会变为：\n\n\n\n当 useDefineForClassFields 为 true 的时候，则编译后的代码会变为：\n\n\n\n同时该配置的默认值会根据 tsconfig.json 的 target 配置而变化：当 target 是 ES2022 或者更高的时候，则\nuseDefineForClassFields 默认配置为 true，否则就是默认为 false。\n\n关于 TypeScript 这个配置的更多信息，可以参考下面的链接：\n\n * The useDefineForClassFields Flag and The declare Property Modifier\n\nModern.js Module 目前会根据下面的逻辑进行处理：\n\n 1. 首先根据当前项目的 tsconfig.json 的 useDefineForClassFields 配置确定在 Modern.js Module\n    内部如何处理。目前只会读取当前项目路径下的 tsconfig.json 文件的内容，暂时不支持根据 extends 配置来获取最终的 tsconfig\n    配置。\n 2. 如果没有检测 tsconfig.json 的 useDefineForClassFields 配置，则会根据 tsconfig.json 的\n    target 配置来确定默认值。如果 target 大于 ES2022（包含 EsNext），则useDefineForClassFields默认为\n    true，否则为 false。\n 3. 如果没有检测到 tsconfig.json 的 target，则按照 useDefineForClassFields的值 为 true 进行处理。\n\n\nbabel-plugin-lodash 将引入的 lodash 处理成 undefined#\n\n当使用类似下面的方式的时候，会出现这个问题：\n\n\n\n目前在 babel-plugin-lodash Github 上的相关 Issue：\n\n * #235\n\n这个问题的解决办法是移除 babel-plugin-lodash，因为此时不需要该插件进行按需引用，使用该插件会产生副作用。\n\n类似的情况在 babel-plugin-import 上也可能会出现。比如有类似如下的代码：\n\n\n\n此时 babel-plugin-import 也可能会导致 Comps 变为 undefined。因此也需要移除对应的 babel-plugin-import。\n\n\nCannot find module 'http'#\n\n如果产物在浏览器运行时报了类似 Cannot find module 'http' 的错误，说明你的产物打包进了 node 模块。\n这可能会发生于你的依赖里有一些同时支持 browser 和 node 的三方包，例如 axios，此时只需要将 platform 设置为 browser 即可。\n如果一些三方包不支持 browser, 你可能需要手动注入 node polyfill。\n\n\n异常类问题#\n\n\nDynamic require of \"react\" is not supported#\n\n问题描述#\n\n当构建的产物配置中产物格式为 ES modules 的时候：\n\n\n\n如果导入了的第三方 npm 包的 cjs 产物，那么生成的产物可能会在 webpack 下有可能无法正常运行。\n\n\n\n解决办法#\n\n 1. 首先需要找到是哪个第三方包引起的问题。例如报错信息中指向了 react 这个包，那么就要寻找在哪个第三方包里存在 require('react')\n    这样的代码。比如 react-draggable ，这个包仅包含 cjs 产物，那么问题定位到 react-draggable 这个包。\n 2. 然后我们需要将这个包通过下面的配置进行排除，即不打包存在问题的第三方包。\n\n\n\n参考链接#\n\n * When using esbuild with external react I get Dynamic require of \"react\" is\n   not supported\n\n\n编译过程中，因为某个组件库的 less 文件报错：'Operation on an invalid type'#\n\n可能是因为该组件库依赖的 Less 版本是 v3，而 Modern.js Module 默认是 v4。v3 与 v4 在 math 配置上存在有 Break\nChange，可以查看这个链接 了解详情。\n\n因此，如果是在源码中使用了类似这样的组件库：\n\n在构建配置中使用了 buildPreset 的情况下，按照下面进行修改：\n\n\n\n或者使用了自定义的 buildConfig 的情况下，按照下面进行修改：\n\n\n\n如果是在 Storybook 中使用了类似这样的组件，则需要修改 Storybook 的调试配置：\n\n\n\n\nBundleless DTS failed#\n\n在不打包的场景下，是直接 tsc\n生成类型声明文件。通过终端打印的错误信息，你可以找到问题文件。对于源码文件，推荐将类型问题进行修复，这能够更好地使你的包得到复用。但如果遇到三方包的类型检查问题\n：\n\n 1. 开启 skipLibCheck 来跳过三方包的 d.ts 检查。\n 2. 如果三方包直接导出 ts 文件， skipLibCheck 将会失效，因为其只能跳过 d.ts 检查，因此你只能关闭 dts.abortOnError\n    来忽略这些错误。\n\n\nBundle DTS failed#\n\nModern.js Module 直接使用 rollup-plugin-dts 来打包你的类型描述文件。 它可能无法处理某些第三方依赖的类型文件。\n\n如果遇到 Modern.js Module 构建过程中出现 Bundle DTS failed\n的错误信息标题的时候，可以观察报错信息是来自某个第三方依赖。尝试设置 dts.respectExternal 为 false\n来关闭打包第三方依赖的类型文件的行为。\n\n\ndefineConfig 函数类型报错：如果没有引用 \"...\"，则无法命名 \"default\" 的推断类型#\n\n检查项目的 tsconfig.json 文件中是否存在 include 配置，如果没有，则尝试增加下面的内容：\n\n\n\n\n其他#\n\n\nbundleless 如何跳过对 less / scss 文件的预处理#\n\nbundleless 是单文件编译的方式，只需要将你的 less / scss 文件从入口里移除并且将其拷贝到产物里即可。 注意我们还会把 js 引用 less\n/ scss 的 moduleId 进行改写，你可以通过 redirect 配置关闭它。\n\n下面是一个跳过 less 文件处理的例子，你会发现 src 里面所有的 less 文件都被拷贝到 dist 里并且保留了一致的相对路径。\n\n\n\n\n增加额外的编译能力#\n\nModern.js Module 基于 esbuild 实现，因此如果有特殊需求或者想要增加额外的编译能力，可以通过实现 esbuild 插件来解决。\n\nModern.js Module 提供了 esbuildOptions 配置允许修改 Modern.js Module 内部的 esbuild\n配置，因此可以通过该配置来增加自定义的 esbuild 插件：\n\n\n\n在增加 esbuild 插件时，请注意你需要将插件加在 plugins 数组的头部，因为 Modern.js Module 内部也是通过一个 esbuild\n插件介入到整个构建流程中去的，因此需要将自定义插件优先注册。\n\n\n支持生成 CSS Modules 的 TypeScript 声明文件#\n\n * 方案一：typed-css-modules\n * 方案二：postcss-modules-dts\n\n","routePath":"/module-tools/guide/faq/build","lang":"zh","toc":[{"text":"产物问题","id":"产物问题","depth":2,"charIndex":110},{"text":"Class Fields 的初始化处理","id":"class-fields-的初始化处理","depth":3,"charIndex":118},{"text":"babel-plugin-lodash 将引入的 lodash 处理成 `undefined`","id":"babel-plugin-lodash-将引入的-lodash-处理成-undefined","depth":3,"charIndex":-1},{"text":"Cannot find module 'http'","id":"cannot-find-module-http","depth":3,"charIndex":1337},{"text":"异常类问题","id":"异常类问题","depth":2,"charIndex":1559},{"text":"Dynamic require of \"react\" is not supported","id":"dynamic-require-of-react-is-not-supported","depth":3,"charIndex":1568},{"text":"问题描述","id":"问题描述","depth":4,"charIndex":1614},{"text":"解决办法","id":"解决办法","depth":4,"charIndex":1714},{"text":"参考链接","id":"参考链接","depth":4,"charIndex":1916},{"text":"编译过程中，因为某个组件库的 less 文件报错：`'Operation on an invalid type'`","id":"编译过程中因为某个组件库的-less-文件报错operation-on-an-invalid-type","depth":3,"charIndex":-1},{"text":"Bundleless DTS failed","id":"bundleless-dts-failed","depth":3,"charIndex":2338},{"text":"Bundle DTS failed","id":"bundle-dts-failed","depth":3,"charIndex":2595},{"text":"`defineConfig` 函数类型报错：`如果没有引用 \"...\"，则无法命名 \"default\" 的推断类型`","id":"defineconfig-函数类型报错如果没有引用-则无法命名-default-的推断类型","depth":3,"charIndex":-1},{"text":"其他","id":"其他","depth":2,"charIndex":2940},{"text":"bundleless 如何跳过对 less / scss 文件的预处理","id":"bundleless-如何跳过对-less--scss-文件的预处理","depth":3,"charIndex":2946},{"text":"增加额外的编译能力","id":"增加额外的编译能力","depth":3,"charIndex":3184},{"text":"支持生成 CSS Modules 的 TypeScript 声明文件","id":"支持生成-css-modules-的-typescript-声明文件","depth":3,"charIndex":3492}],"domain":"","frontmatter":{},"version":""},{"id":76,"title":"常见问题","content":"#\n\n这里是 Modern.js Module 常见问题分类列表：\n\n * 通用类问题\n * 构建相关问题\n * Storybook 相关问题","routePath":"/module-tools/guide/faq/","lang":"zh","toc":[],"domain":"","frontmatter":{},"version":""},{"id":77,"title":"Storybook 相关问题","content":"#\n\n\n支持 Storybook v7#\n\nStorybook v7 目前已全面支持并已成为我们的推荐使用版本。\n\n\n使用 Storybook Addon 或者其他配置不生效#\n\nModern.js Module 目前使用的 Storybook 版本是 v6，如果使用了 v7 版本的 Addon 可能会出现插件不生效的情况。\n\n除了 Addon 以外，其他配置也可能会有区别。比如修改 preview.js 配置文件的话，Storybook v6 与 v7 的写法也不相同：\n\n * v6：文档链接\n * v7：文档链接\n\n\nCannot find module 'react-dom/package.json'#\n\n在执行 Storybook 调试的时候，出现下面的报错提示：\n\n\n\n解决办法：在项目中安装 react-dom 依赖。\n\n\n\n\n报错后，看不到具体报错信息#\n\n解决办法：\n\n 1. 找到 @storybook/core-server/dist/cjs/dev-server.js\n 2. 找到 var _await$Promise$all = await Promise.all([preview, manager 这附近的代码。\n 3. 修改成：\n\n\n\n\nCouldn't find any stories is your Storybook#\n\n\n\n当在预览区域看到类似这样的报错提示的时候，首先可以打开一下浏览器的控制台，应该会有些报错信息。可以先根据报错信息来推断是不是编写代码里出现的问题导致\nStorybook 无法正常运行。修复后，再次刷新查看是否正常。\n\n\nStorybook 添加 Proxy 功能#\n\nStorybook 没有提供相关方案，不过 Storybook Issue 中有找到相关的解决办法。在 Modern.js Module 中，你可以：\n\n 1. 添加 .storybook/middleware.js 文件，并初始化下面的内容：\n\n\n\n 2. 添加 http-proxy-middleware 依赖\n 3. 添加代理路由相关配置\n\n\n\n相关 issue 链接：#11551。\n\n\nTailwind CSS 在 Storybook 中不生效#\n\nModern.js Module 的 Storybook 构建能力由 Rsbuild 提供，由于 Rsbuild 的底层实现与 Modern.js Module\n并未打通，因此， Modern.js Module 插件无法在 Storybook (Rsbuild) 中生效。\n\n解决办法：需要在 storybook 中单独注册 tailwindcss 的 PostCSS 插件。\n\n参考链接：Rsbuild - tailwindcss。","routePath":"/module-tools/guide/faq/storybook","lang":"zh","toc":[{"text":"支持 Storybook v7","id":"支持-storybook-v7","depth":2,"charIndex":3},{"text":"使用 Storybook Addon 或者其他配置不生效","id":"使用-storybook-addon-或者其他配置不生效","depth":2,"charIndex":58},{"text":"Cannot find module 'react-dom/package.json'","id":"cannot-find-module-react-dompackagejson","depth":2,"charIndex":263},{"text":"报错后，看不到具体报错信息","id":"报错后看不到具体报错信息","depth":2,"charIndex":373},{"text":"Couldn't find any stories is your Storybook","id":"couldnt-find-any-stories-is-your-storybook","depth":2,"charIndex":538},{"text":"Storybook 添加 Proxy 功能","id":"storybook-添加-proxy-功能","depth":2,"charIndex":696},{"text":"Tailwind CSS 在 Storybook 中不生效","id":"tailwind-css-在-storybook-中不生效","depth":2,"charIndex":918}],"domain":"","frontmatter":{},"version":""},{"id":78,"title":"快速开始","content":"#\n\n\n三分钟快速上手#\n\n想要实际体验 Modern.js Module？首先你需要安装 Node.js LTS，并确保 Node 版本大于等于 16.0.0。我们推荐使用\nNode.js 18 的 LTS 版本。\n\n\n创建新项目#\n\n如果你想要创建一个完整的 Modern.js Module 项目，可以执行以下命令：\n\n\n\nINFO\n\n执行 npx @modern-js/create -h 查看更多命令行参数\n\n接着在问题交互中，按照如下选择：\n\n\n\n> 项目名称为 package.json 中的 \"name\" 字段值。\n\n接着就会开始初始化项目的流程。在项目目录和文件生成以及依赖安装完毕后，此时就创建了一个完整的 Modern.js Module 项目。\n\n我们可以直接执行 pnpm build 命令启动项目的构建，执行 pnpm build --watch 命令开启构建的观察模式。\n\n\n接入已有项目#\n\n在你的项目里安装以下依赖：\n\n * \"@modern-js/module-tools\"\n\n * \"typescript\"（如果不是 TypeScript 项目，则省略）\n\n> 对于使用 pnpm 或者 Yarn 包管理器的项目，只需要替换 npm 就可以了。推荐使用 pnpm。\n\n接着在项目的根目录下创建 modern.config.(t|j)s 文件：\n\n\n\n最后在项目的 package.json 文件里增加命令 \"build\": \"modern build\"：\n\n\n\n如果你的项目存在 src/index.(js|jsx) 文件或者同时存在 src/index.(ts|tsx) 和 tsconfig.json\n文件，那么恭喜你可以运行直接运行 npm run build 来使用 Modern.js Module 构建你的项目了。\n\n\n核心 npm 包#\n\n@modern-js/module-tools 是 Modern.js Module 的核心 npm 包，主要提供以下能力：\n\n * 提供 modern dev, modern build 等常用的 CLI 命令。\n * 集成 Modern.js Core，提供配置解析、插件加载等能力。\n * 集成 esbuild 和 SWC，提供构建能力。\n * 集成一些最为常用的插件，比如 plugin-lint、plugin-changeset 等。\n\n@modern-js/module-tools 是基于 Modern.js 的插件体系实现的，本质上是一个插件，因此你需要在配置文件的 plugins\n字段中注册 moduleTools：\n\n\n\n\n查看官方示例#\n\n如果你想要看看使用了 Modern.js Module 的完整项目，可以执行以下命令：\n\n\n\n\n让我们开始吧#\n\n选择适合你的教程：\n\n * 我是初学者，需要学习 Modern.js Module 的基础使用。\n * 我已经初步掌握了 Modern.js Module 的使用，可以学习 Modern.js Module 的进阶指南。\n * 我需要扩展项目能力，需要学习如何开发 Modern.js Module 的插件。","routePath":"/module-tools/guide/intro/getting-started","lang":"zh","toc":[{"text":"三分钟快速上手","id":"三分钟快速上手","depth":2,"charIndex":3},{"text":"创建新项目","id":"创建新项目","depth":3,"charIndex":110},{"text":"接入已有项目","id":"接入已有项目","depth":3,"charIndex":402},{"text":"核心 npm 包","id":"核心-npm-包","depth":3,"charIndex":784},{"text":"查看官方示例","id":"查看官方示例","depth":3,"charIndex":1118},{"text":"让我们开始吧","id":"让我们开始吧","depth":2,"charIndex":1175}],"domain":"","frontmatter":{"sidebar_position":3},"version":""},{"id":79,"title":"欢迎使用","content":"#\n\nModern.js Module 是 Modern.js\n的模块工程解决方案，同时也是核心依赖。它可以让开发者更轻松地构建、调试、发布模块类型的项目。模块类型的项目大多数情况可以认为是 npm\n包类型的项目，它可能是一个组件、组件库或者工具库项目。\n\n如果你正打算开发一个 npm 包类型的项目，那么你就来对地方了！Modern.js 提供了专业的模块工程解决方案。它带来了：\n\n * 简单的项目初始化：仅需执行 npx @modern-js/create project-dir\n   命令，然后进行几个交互问题，就可以创建一个完整的模块类型项目。创建的项目还支持选择 pnpm、Yarn 两种包管理器。\n * 全面的构建能力和更快的构建速度：Modern.js Module 基于 esbuild 和 SWC\n   提供了高性能的构建能力，并且为不同构建模块的场景提供了丰富的配置。\n * Storybook 调试工具：Modern.js Module 为调试模块项目提供了 Storybook 调试工具。在安装了 Modern.js\n   Module 的 Storybook 插件后，你可以使用 storybook dev 命令来启动它。你不仅可以使用 Storybook\n   对组件进行调试，也可以使用在其他类型的模块上。\n * 基于 Changesets 实现的版本管理：当需要对项目记录变更内容的时候，可以使用 modern change 命令生成包含变更内容的 Markdown\n   文件；当需要对项目进行版本升级的时候，可以使用 modern bump 命令通过 Markdown 文件分析并升级版本；当需要发布项目的时候，可以使用\n   modern release 命令对项目进行发布。Modern.js Module 基于 Changesets 实现了这些命令。\n * 可扩展性的插件机制：想要为项目集成其他的调试工具？又或者是想要在构建过程中做一些额外处理？Modern.js Module\n   提供了插件机制和插件钩子，插件钩子覆盖了 dev 命令和 build 命令两个流程。你可以通过它们为项目进行能力的扩展。\n * 还有更多：Modern.js Module\n   在未来还会不断地在构建、调试功能上进行优化。如果在模块项目构建上存在需要解决的重要问题，又或者是某个主流的模块项目调试工具、模式出现的时候，那么它们很可能\n   成为 Modern.js Module 将要支持功能。","routePath":"/module-tools/guide/intro/welcome","lang":"zh","toc":[],"domain":"","frontmatter":{"sidebar_position":1},"version":""},{"id":80,"title":"为什么需要 Modern.js Module","content":"#\n\n大家可能都经历过：从零开始开发一个组件库或者工具库的过程中，我们不仅要考虑项目本身的代码逻辑如何编写，还要考虑项目的构建、调试、测试、代码格式化等等和代码逻辑无\n关的事情。\n\n比如说，当我们考虑构建模块项目的代码是使用什么构建工具的时候，在之前我们可能会考虑使用 webpack 还是 Rollup，然而现在的话，也许还会考虑是使用\nesbuild 还是 SWC。\n\n无论选择哪个构建工具，这对于没有熟练掌握这些构建工具使用方式的开发者来说，是需要一定的成本去学习的。即使想要快速使用，也会需要花费大量的时间和精力。\n\n而除了构建这件事情以外，像为项目提供调试工具、支持测试能力、增加代码格式校验等等，对于一个新手来说都有可能需要花费很长的时间和精力了解或者掌握它们，并且真正的服\n务于当前的项目中。\n\n而为了保证代码质量以及项目的完整性，我们往往是需要做这些与代码逻辑实现无关的事情。然而这些事情很有可能会影响整体的项目开发进度，降低开发者的开发体验，会让开发者\n感觉模块项目的开发门槛很高。\n\n如果说每次开发一个模块类型的项目都需要经历一遍这些工作准备的话，那么基本上刚开始开发的时间会大部分花费在这些与代码实现无关的事情上。如果能够提供一个模块工程解决\n方案，它能够帮助开发者解决项目工程上的事情，让开发者可以更专注于代码的实现上，那么这将会大大提升模块类型项目的开发体验。\n\n\n\nModern.js 为了让开发模块类型的项目更简单、解决上述提到的问题，提供了模块工程解决方案，并且通过 Modern.js Module\n提供了主要的功能。Modern.js Module 可以理解为是一个专门用于模块类型项目开发的工具。","routePath":"/module-tools/guide/intro/why-module-engineering-solution","lang":"zh","toc":[],"domain":"","frontmatter":{"sidebar_position":2},"version":""},{"id":82,"title":"快速开始","content":"#\n\nModern.js Module 不仅提供了丰富的功能，同时也支持通过插件的方式为当前项目扩展能力。\n\n我们可以通过下面的例子来快速了解如何编写一个 Modern.js Module 插件：\n\n 1. 首先我们在初始化的项目下创建 ./plugins/example.ts 文件。\n\n\n\n 2. 接着在 example.ts 文件中增加插件的代码。\n\n\n\n 3. 然后我们通过 plugins API，将刚刚写好的插件进行注册。\n\n\n\n 4. 最后运行 modern build，就可以看到：\n\n\n\n通过上面这个例子，我们了解到了下面几件事：\n\n * 推荐的插件目录结构\n * 插件的初始化代码\n * 插件的注册\n\n除了以上内容以外，我们还需要了解：\n\n * 插件对象、类型定义与推荐配置项\n * setup 函数、api 对象参数、生命周期钩子","routePath":"/module-tools/plugins/guide/getting-started","lang":"zh","toc":[],"domain":"","frontmatter":{"sidebar_position":1},"version":""},{"id":83,"title":"插件对象","content":"#\n\nModern.js Module 的插件是一个对象，对象包含以下属性：\n\n * name：插件的名称，唯一标识符。\n * setup：插件初始化函数，只会执行一次。setup 函数可以返回一个 Hooks 对象，Modern.js Module 会在特定的时机执行 Hooks\n   对象上定义的 Hook 对应的函数。\n\n例如在下面的插件代码示例中，在项目开始执行构建任务之前会触发 beforeBuild 函数的执行，并打印 build start 的 log 内容。\n\n\n\n\n\n\n插件类型定义#\n\n使用 TypeScript 时，可以引入内置的 CliPlugin 和 ModuleTools 类型，为插件提供正确的类型推导：\n\n\n\n\n插件配置项#\n\n建议将插件写成函数的形式，使插件能通过函数入参来接收配置项：\n\n","routePath":"/module-tools/plugins/guide/plugin-object","lang":"zh","toc":[{"text":"插件类型定义","id":"插件类型定义","depth":2,"charIndex":245},{"text":"插件配置项","id":"插件配置项","depth":2,"charIndex":323}],"domain":"","frontmatter":{"sidebar_position":2},"version":""},{"id":84,"title":"Setup 函数","content":"#\n\n在「插件对象」 部分我们知道插件对象包含了一个 setup 函数，该函数不仅包含了一个 api 对象参数，同时还可以返回一个 Hooks 对象。\n\n\n插件 API 对象#\n\n插件的 setup 函数会提供一个 api 对象参数，你可以调用该对象上提供的一些方法来获取到配置、项目上下文等信息。\n\n\n\n\napi.useAppContext#\n\n用于获取项目上下文信息。\n\n\n\nINFO\n\n通过实际的类型文件，我们可以看到还存在一些其他字段，不过目前对于 Modern.js Module 有意义的字段只有以上内容，api 对象其他的方法也是如此。\n\n\napi.useResolvedConfigContext#\n\n用于获取解析之后的最终配置。\n\nINFO\n\n如果需要获取构建相关的最终配置，需要使用 beforeBuild Hook。\n\n\n\n\napi.useHookRunners#\n\n用于获取 Hooks 的执行器，并触发特定的 Hook 执行。\n\n\n\n\n异步 setup#\n\nCLI 插件的 setup 可以是一个异步函数，在初始化过程中执行异步逻辑。\n\n\n\n注意，只有当前插件的 setup 异步函数执行完毕，才会继续执行下一个插件的 setup 函数。因此，你需要避免在 setup\n函数中进行耗时过长的异步操作，防止影响 CLI 启动性能。\n\n\n生命周期钩子#\n\n我们知道 setup 函数会返回一个 Hooks 对象，所谓 Hooks 对象也可以理解是具有 Modern.js Module 生命周期钩子的对象。\n\n目前主要包含两类钩子：\n\n * 构建钩子：仅在执行 build 命令构建源码产物时触发。\n * buildPlatform 钩子：仅在执行 build --platform 命令生成其他构建产物时触发。\n * 调试钩子：运行 dev 命令时会触发的钩子。\n\n关于生命周期钩子的完整列表参考 API 文档。","routePath":"/module-tools/plugins/guide/setup-function","lang":"zh","toc":[{"text":"插件 API 对象","id":"插件-api-对象","depth":2,"charIndex":77},{"text":"`api.useAppContext`","id":"apiuseappcontext","depth":3,"charIndex":-1},{"text":"`api.useResolvedConfigContext`","id":"apiuseresolvedconfigcontext","depth":3,"charIndex":-1},{"text":"`api.useHookRunners`","id":"apiusehookrunners","depth":3,"charIndex":-1},{"text":"异步 setup","id":"异步-setup","depth":2,"charIndex":430},{"text":"生命周期钩子","id":"生命周期钩子","depth":2,"charIndex":579}],"domain":"","frontmatter":{"sidebar_position":3},"version":""},{"id":85,"title":"总览","content":"#\n\n\n官方插件#\n\n * @modern-js/plugin-module-import：使用 SWC 提供与 babel-plugin-import 一样的能力。\n * @modern-js/plugin-module-banner：为每个 JS 和 CSS 文件的顶部和底部添加自定义内容，例如版权信息。\n * @modern-js/plugin-module-node-polyfill：会自动注入 Node 核心模块在浏览器端的 polyfills。\n * @modern-js/plugin-module-polyfill：为你的代码中使用到的不支持的功能注入 polyfill。\n * @modern-js/plugin-module-babel：使用 Babel 转换你的代码。\n * @modern-js/plugin-module-vue：提供对 Vue 3 组件构建的支持。","routePath":"/module-tools/plugins/official-list/overview","lang":"zh","toc":[{"text":"官方插件","id":"官方插件","depth":2,"charIndex":3}],"domain":"","frontmatter":{},"version":""},{"id":86,"title":"Babel 插件","content":"#\n\nTIP\n\n通常情况下，我们无需使用 Babel 转换我们的代码，此插件仅作为一种降级方式。\n\n\n快速开始#\n\n\n安装#\n\n\n注册插件#\n\n在 Modern.js Module 中，你可以按照如下方式注册插件：\n\n\n\n你也可以通过 hooks 配置注册，例如你同时需要打包 A，B 两个文件，并只需要在打包 A 时使用 babel：\n\n\n\n\n配置#\n\nSee Babel options\n\n下面是一个配置了@babel/preset-env的例子：\n\n","routePath":"/module-tools/plugins/official-list/plugin-babel","lang":"zh","toc":[{"text":"快速开始","id":"快速开始","depth":2,"charIndex":50},{"text":"安装","id":"安装","depth":3,"charIndex":58},{"text":"注册插件","id":"注册插件","depth":3,"charIndex":64},{"text":"配置","id":"配置","depth":2,"charIndex":172}],"domain":"","frontmatter":{},"version":""},{"id":87,"title":"Banner 插件","content":"#\n\n提供为每个 JS 和 CSS 文件的顶部和底部注入内容的能力。\n\nTIP\n\n从 @modern-js/module-tools 2.36.0 版本开始，该插件功能内置在 Modern.js Module 中，由 banner 和\nfooter 配置提供。\n\n\n快速开始#\n\n\n安装#\n\n\n注册插件#\n\n在 Modern.js Module 中，你可以按照如下方式注册插件：\n\n\n\nTIP\n\n注意：CSS 的注释不支持 //comment 这样的写法。详见「CSS 注释」\n\n\n示例#\n\n\n在 JS 文件顶部增加版权信息#\n\n\n\n\n配置#\n\n * 类型：\n\n\n\n\nbanner#\n\n在顶部增加内容。\n\n * banner.js：在 JS 文件顶部增加内容。\n * banner.css：在 CSS 文件顶部增加内容。\n\n\nfooter#\n\n在底部增加内容。\n\n * footer.js：在 JS 文件底部增加内容。\n * footer.css：在 CSS 文件底部增加内容。","routePath":"/module-tools/plugins/official-list/plugin-banner","lang":"zh","toc":[{"text":"快速开始","id":"快速开始","depth":2,"charIndex":132},{"text":"安装","id":"安装","depth":3,"charIndex":140},{"text":"注册插件","id":"注册插件","depth":3,"charIndex":146},{"text":"示例","id":"示例","depth":2,"charIndex":240},{"text":"在 JS 文件顶部增加版权信息","id":"在-js-文件顶部增加版权信息","depth":3,"charIndex":246},{"text":"配置","id":"配置","depth":2,"charIndex":267},{"text":"banner","id":"banner","depth":3,"charIndex":283},{"text":"footer","id":"footer","depth":3,"charIndex":362}],"domain":"","frontmatter":{},"version":""},{"id":88,"title":"Import 插件","content":"#\n\n提供与 babel-plugin-import 等价的能力和配置，基于 SWC 实现。\n\nTIP\n\n从 @modern-js/module-tools 2.16.0 版本开始，该插件功能内置在 Modern.js Module 中，由\ntransformImport 配置提供。\n\n\n快速开始#\n\n\n安装#\n\n\n注册插件#\n\n在 Modern.js Module 中，你可以按照如下方式注册插件：\n\n\n\n这样我们就可以在 Modern.js Module 中使用自动导入的能力了。\n\n\n配置#\n\n * 类型：\n\n\n\n\npluginImport#\n\n * 类型：object[]\n\n其中数组元素为一个 babel-plugin-import 的配置对象。配置对象可以参考 options。\n\n使用示例：\n\n\n\n\n注意事项#\n\nSWC (Speedy Web Compiler) 是基于 Rust 语言编写的，而该插件是基于 SWC，移植自\nbabel-plugin-import，配置选项保持了一致。\n\n一些配置可以传入函数，例如 customName，customStyleName 等， 但在 Modern.js Module\n里，我们不建议在此配置项里使用函数。 因为我们会在 esbuild 的插件里调用 SWC，然后再当 Rust 通过 Node-API\n调用这些配置函数时，会出现死锁现象。\n\n简单的函数逻辑其实可以通过模版语言来代替，下面是一个 customName 使用模板的示例：\n\n\n\n添加以下配置：\n\n\n\n其中的 {{ member }} 会被替换为相应的引入成员，转换后:\n\n\n\n可以看出配置 customName: \"foo/es/{{ member }}\" 的效果等同于配置 customName: (member) =>\n`foo/es/${member}` 。\n\n这里使用到的模版是 handlebars，模版配置中还内置了一些有用的辅助工具，还是以上面的导入语句为例，配置成：\n\n\n\n会转换成下面的结果：\n\n\n\n除了 kebabCase 以外还有 camelCase，snakeCase，upperCase，lowerCase 可以使用。","routePath":"/module-tools/plugins/official-list/plugin-import","lang":"zh","toc":[{"text":"快速开始","id":"快速开始","depth":2,"charIndex":144},{"text":"安装","id":"安装","depth":3,"charIndex":152},{"text":"注册插件","id":"注册插件","depth":3,"charIndex":158},{"text":"配置","id":"配置","depth":2,"charIndex":245},{"text":"pluginImport","id":"pluginimport","depth":3,"charIndex":261},{"text":"注意事项","id":"注意事项","depth":2,"charIndex":357}],"domain":"","frontmatter":{},"version":""},{"id":89,"title":"Node Polyfill 插件","content":"#\n\nNode Polyfill 介绍\n\n通常情况下，我们不会在浏览器端使用 Node 模块。但在当前代码需要同时在 Node 端和浏览器端运行时，用到一些 Node 模块是有可能的。Node\nPolyfill 为这些 Node 模块提供了浏览器版本的 polyfills。\n\n通过使用 Node Polyfill 插件，会自动注入 Node 核心模块在浏览器端的 polyfills，让你可以在浏览器端放心使用这些模块。\n\n\n快速开始#\n\n\n安装#\n\n\n注册插件#\n\n在 Modern.js Module 中，你可以按照如下方式注册插件：\n\n\n\n\n配置#\n\n * 类型：\n\n\n\n\nexclude#\n\n排除要注入的 Node Polyfill。\n\n\n\n\noverrides#\n\n覆盖内置的 Node Polyfill。\n\n\n\n\nNode Polyfills#\n\n\nGlobals#\n\n * Buffer\n * process\n * console\n\n当你在代码中使用以上全局变量时，对应 polyfill 会被自动注入。\n\n\n\n\nModules#\n\n * assert\n * buffer\n * console\n * constants\n * crypto\n * domain\n * events\n * http\n * https\n * os\n * path\n * punycode\n * process\n * querystring\n * stream\n * _stream_duplex\n * _stream_passthrough\n * _stream_readable\n * _stream_transform\n * _stream_writable\n * string_decoder\n * sys\n * timers\n * tty\n * url\n * util\n * vm\n * zlib\n\n当你通过 require 或 import 等语法在代码中引用以上模块时，对应 polyfill 会被注入。\n\n\n\n\nFallbacks#\n\n * child_process\n * cluster\n * dgram\n * dns\n * fs\n * module\n * net\n * readline\n * repl\n * tls\n\n目前浏览器端没有以上模块的 polyfill，因此当你引用以上模块时，会自动 fallback 为一个空对象。\n\n","routePath":"/module-tools/plugins/official-list/plugin-node-polyfill","lang":"zh","toc":[{"text":"快速开始","id":"快速开始","depth":2,"charIndex":213},{"text":"安装","id":"安装","depth":3,"charIndex":221},{"text":"注册插件","id":"注册插件","depth":3,"charIndex":227},{"text":"配置","id":"配置","depth":2,"charIndex":274},{"text":"exclude","id":"exclude","depth":3,"charIndex":290},{"text":"overrides","id":"overrides","depth":3,"charIndex":326},{"text":"Node Polyfills","id":"node-polyfills","depth":2,"charIndex":363},{"text":"Globals","id":"globals","depth":3,"charIndex":381},{"text":"Modules","id":"modules","depth":3,"charIndex":464},{"text":"Fallbacks","id":"fallbacks","depth":3,"charIndex":860}],"domain":"","frontmatter":{},"version":""},{"id":90,"title":"Polyfill 插件","content":"#\n\nTIP\n\n通常情况下，我们不需要为 npm 包注入 polyfill，这一步应该在 Web\n应用的框架侧完成，但是在某些场景，为了让我们的库能够直接运行在低版本浏览器里，我们需要注入 polyfill。\n\n请注意，此插件并不会转化你的代码语法，只会为你的代码中使用到的不支持的功能注入 polyfill，把它们作为普通函数导入而不是污染全局。你需要安装\ncore-js-pure 依赖\n\n\n快速开始#\n\n\n安装#\n\n\n注册插件#\n\n在 Modern.js Module 中，你可以按照如下方式注册插件：\n\n\n\n你也可以通过 hooks 配置注册，例如你同时具有多份构建配置，并只需要在 bundle 构建时注入 polyfill：\n\n\n\n\n配置#\n\n * 类型：\n\n\n\n\ntargets#\n\n参考 Babel target.\n\n下面是一个例子：\n\n","routePath":"/module-tools/plugins/official-list/plugin-polyfill","lang":"zh","toc":[{"text":"快速开始","id":"快速开始","depth":2,"charIndex":197},{"text":"安装","id":"安装","depth":3,"charIndex":205},{"text":"注册插件","id":"注册插件","depth":3,"charIndex":211},{"text":"配置","id":"配置","depth":2,"charIndex":322},{"text":"targets","id":"targets","depth":3,"charIndex":338}],"domain":"","frontmatter":{},"version":""},{"id":91,"title":"Vue 插件","content":"#\n\nVue 插件提供了对 Vue 3 组件构建的支持，插件内部集成了 esbuild-plugin-vue3 和 @vue/babel-plugin-jsx。\n\nWARNING\n\n请注意，此插件仍有一些用法限制：\n\n 1. 目前此插件的实现是直接集成社区插件，因此不支持在 sfc 里写 jsx/tsx。\n 2. 如果要为组件生成 d.ts，请使用官方推荐方式 vue-tsc。\n 3. 仅支持打包场景，推荐将 input 设置为 ['src/**/*.vue'] 或者 ['src/index.ts']。\n\n\n快速开始#\n\n\n安装#\n\n\n注册插件#\n\n在 Modern.js Module 中，你可以按照如下方式注册插件：\n\n\n\n\n配置#\n\n\nvueJsxPluginOptions#\n\n * Type:\n\n\n\n * Default: {}\n\n传递给 @vue/babel-plugin-jsx 的选项，请查阅 @vue/babel-plugin-jsx 文档 来了解具体用法。","routePath":"/module-tools/plugins/official-list/plugin-vue","lang":"zh","toc":[{"text":"快速开始","id":"快速开始","depth":2,"charIndex":256},{"text":"安装","id":"安装","depth":3,"charIndex":264},{"text":"注册插件","id":"注册插件","depth":3,"charIndex":270},{"text":"配置","id":"配置","depth":2,"charIndex":317},{"text":"vueJsxPluginOptions","id":"vuejsxpluginoptions","depth":3,"charIndex":323}],"domain":"","frontmatter":{},"version":""}]

package/docs/en/api/config/dev.md

@@ -29,7 +29,7 @@ export default {
 };
 ```
 
-You can modify the webpack configuration of the Storybook Preview-iframe via `dev.storybook.webpack`. The usage can be found in the [`tools.webpack`](https://modernjs.dev/builder/en/api/config-tools.html#toolswebpack) configuration of Modern.js Builder.
+You can modify the webpack configuration of the Storybook Preview-iframe via `dev.storybook.webpack`. The usage can be found in the [`tools.webpack`](https://modernjs.dev/builder/en/api/config-tools.html#toolswebpack) configuration of Modern.js.
 
 ![Storybook](https://storybook.js.org/71522ac365feaf3338d7c242e53378f6/manager-preview.png)
 
@@ -66,4 +66,4 @@ export default {
 };
 ```
 
-You can modify the webpack configuration of the Storybook Preview-iframe via `dev.storybook.webpackChain`. You can refer to Modern.js Builder's [`tools.webpackChain`](https://modernjs.dev/builder/en/api/config-tools.html#toolswebpackchain) configuration for how to use it.
+You can modify the webpack configuration of the Storybook Preview-iframe via `dev.storybook.webpackChain`. You can refer to Modern.js's [`tools.webpackChain`](https://modernjs.dev/builder/en/api/config-tools.html#toolswebpackchain) configuration for how to use it.

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

@@ -69,22 +69,6 @@ The Modern.js Module provides the ability to use debugging tools, which can be s
 
 The officially supported debugging tool is [Rspress](https://rspress.dev/), so you can run `modern dev` or `modern dev doc` to execute it after you run `modern new` to enable it.
 
-## `modern lint`
-
-```bash
-Usage: modern lint [options] [. .files]
-
-lint and fix source files
-
-Options:
-  --no-fix disable auto fix source file
-  -h, --help display help for command
-```
-
-Run [ESLint](https://eslint.org/) to check the syntax of the code. Usually, we only need to check the part of the code that was changed in this commit with [lint-staged](https://github.com/okonet/lint-staged) during the `-git commit` phase.
-
-- The `-no-fix` argument turns off the ability to automatically fix lint error code.
-
 ## `modern change`
 
 ```bash

package/docs/en/guide/intro/welcome.md

@@ -9,7 +9,6 @@ Modern.js Module is a modules engineering solution for Modern.js, as well as a c
 If you are planning to develop a project of the npm package type, then you came to the right place! Modern.js provides a professional Modern.js Module. It gives you:
 
 - **Simple project initialization**: simply execute the `npx @modern-js/create project-dir` command, followed by a few interactive questions, to create a complete module type project. The created project also supports the choice of two package managers, [**pnpm**](https://pnpm.io/) and [**Yarn**](https://classic.yarnpkg.com/).
-- **Code formatting**: In Modern.js Module, you can execute `modern lint` to format the code. The initialized module project includes the [ESLint](https://eslint.org/docs/latest/user-guide/core-concepts#what-is-eslint) ruleset for Modern.js for most scenarios.
 - **Comprehensive build capabilities and faster builds**: Modern.js Module provides high-performance build capabilities based on [esbuild](https://esbuild.github.io/getting-started/) and [SWC](https://swc.rs/), and provides rich configurations for different build scenarios.
 - **Storybook debugging tools**: Modern.js Module provides [Storybook](https://storybook.js.org/) debugging tools for debugging module projects. After installing the Storybook plugin for Modern.js Module, you can start it with the `storybook dev` command. You can use Storybook not only for debugging components, but also for other types of modules.
 - **Versioning based on Changesets**: When you need to record changes to a project, you can use the `modern change` command to generate a Markdown file containing the changes; when you need to upgrade a project, you can use the `modern bump` command to analyze and upgrade the version through the Markdown file; when you need to release a project, you can use the `modern release` command to release the project; Modern.js Module implements these commands based on [Changesets](https://github.com/changesets/changesets).

package/docs/zh/api/config/dev.md

@@ -29,7 +29,7 @@ export default {
 };
 ```
 
-你可以通过 `dev.storybook.webpack` 来修改 Storybook Preview-iframe 的 webpack 配置。使用方式可以参考 Modern.js Builder 的 [`tools.webpack`](https://modernjs.dev/builder/api/config-tools.html#toolswebpack) 配置。
+你可以通过 `dev.storybook.webpack` 来修改 Storybook Preview-iframe 的 webpack 配置。使用方式可以参考 Modern.js 的 [`tools.webpack`](https://modernjs.dev/builder/api/config-tools.html#toolswebpack) 配置。
 
 ![Storybook](https://storybook.js.org/71522ac365feaf3338d7c242e53378f6/manager-preview.png)
 
@@ -66,4 +66,4 @@ export default {
 };
 ```
 
-你可以通过 `dev.storybook.webpackChain` 来修改 Storybook Preview-iframe 的 webpack 配置。使用方式可以参考 Modern.js Builder 的 [`tools.webpackChain`](https://modernjs.dev/builder/api/config-tools.html#toolswebpackchain) 配置。
+你可以通过 `dev.storybook.webpackChain` 来修改 Storybook Preview-iframe 的 webpack 配置。使用方式可以参考 Modern.js 的 [`tools.webpackChain`](https://modernjs.dev/builder/api/config-tools.html#toolswebpackchain) 配置。

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

@@ -69,22 +69,6 @@ Modern.js Module 提供了使用调试工具的能力，可以通过 `modern dev
 
 目前官方支持的调试工具有 [Rspress](https://rspress.dev/)，因此在你执行 `modern new` 命令开启它后，就可以执行 `modern dev` 或者 `modern dev doc` 执行它。
 
-## `modern lint`
-
-```bash
-Usage: modern lint [options] [...files]
-
-lint and fix source files
-
-Options:
-  --no-fix    disable auto fix source file
-  -h, --help  display help for command
-```
-
-运行 [ESLint](https://eslint.org/) 检查代码语法情况。通常情况下，我们只需要在 `git commit` 阶段通过 [lint-staged](https://github.com/okonet/lint-staged) 检查本次提交修改的部分代码。
-
-- `--no-fix` 参数设置后可以关闭自动修复 lint 错误代码的能力。
-
 ## `modern change`
 
 ```bash

package/docs/zh/guide/basic/using-storybook.mdx

@@ -168,7 +168,7 @@ export default config;
 
 ```typescript filename='modern.config.ts'
 import { defineConfig } from '@modern-js/storybook';
-import { pluginSwc } from '@rsbuild/plugin-swc';
+import { pluginSwc } from '@rsbuild/plugin-webpack-swc';
 
 const config = defineConfig({
   builderPlugins: [pluginSwc()],

package/docs/zh/guide/intro/welcome.md

@@ -9,7 +9,6 @@ Modern.js Module 是 Modern.js 的模块工程解决方案，同时也是核心
 如果你正打算开发一个 npm 包类型的项目，那么你就来对地方了！Modern.js 提供了专业的模块工程解决方案。它带来了：
 
 - **简单的项目初始化**：仅需执行 `npx @modern-js/create project-dir` 命令，然后进行几个交互问题，就可以创建一个完整的模块类型项目。创建的项目还支持选择 [**pnpm**](https://pnpm.io/)、[**Yarn**](https://classic.yarnpkg.com/) 两种包管理器。
-- **代码格式化**：在模块工程项目中，你可以执行 `modern lint` 来对代码进行格式化。同时初始化的模块工程项目里包含了 Modern.js 的 [ESLint](https://eslint.org/docs/latest/user-guide/core-concepts#what-is-eslint) 规则集，可以满足大部分场景下的需求。
 - **全面的构建能力和更快的构建速度**：Modern.js Module 基于 [esbuild](https://esbuild.github.io/getting-started/) 和 [SWC](https://swc.rs/) 提供了高性能的构建能力，并且为不同构建模块的场景提供了丰富的配置。
 - **Storybook 调试工具**：Modern.js Module 为调试模块项目提供了 [Storybook](https://storybook.js.org/) 调试工具。在安装了 Modern.js Module 的 Storybook 插件后，你可以使用 `storybook dev` 命令来启动它。你不仅可以使用 Storybook 对组件进行调试，也可以使用在其他类型的模块上。
 - **基于 Changesets 实现的版本管理**：当需要对项目记录变更内容的时候，可以使用 `modern change` 命令生成包含变更内容的 Markdown 文件；当需要对项目进行版本升级的时候，可以使用 `modern bump` 命令通过 Markdown 文件分析并升级版本；当需要发布项目的时候，可以使用 `modern release` 命令对项目进行发布。Modern.js Module 基于 [Changesets](https://github.com/changesets/changesets) 实现了这些命令。

package/package.json

@@ -9,18 +9,18 @@
     "directory": "packages/document/module-doc"
   },
   "license": "MIT",
-  "version": "2.59.0",
+  "version": "2.60.1",
   "main": "index.js",
   "devDependencies": {
     "@modern-js/doc-plugin-auto-sidebar": "2.58.1",
-    "@rspress/shared": "1.28.2",
+    "@rspress/shared": "1.31.0",
     "react": "^18.2.0",
     "react-dom": "^18.2.0",
-    "rspress": "1.28.2"
+    "rspress": "1.31.0"
   },
   "scripts": {
     "dev": "rspress dev",
-    "build:doc": "rspress build",
+    "build": "rspress build",
     "preview": "rspress preview"
   }
 }