简介
@sewing-kit/plugin-package-commonjs 是一个使用 Sewing Kit 打包 CommonJS 模块的插件。通过使用这个插件,开发者可以打包出 CommonJS 模块,使其适用于 Node.js 等使用 CommonJS 规范的环境。
安装
使用 npm 安装 @sewing-kit/plugin-package-commonjs:
npm install @sewing-kit/plugin-package-commonjs --save-dev
使用
在你的项目中使用这个插件,需要在 Sewing Kit 的配置文件中引入并添加到插件列表中。
-- -------------------- ---- ------- -- -------------------- ------ --------------- ---- --------------------- ------ ---------------- ---- -------------------------------------- ------ ------- ------------------- -- - ---------------- ------------------- -------------------------- ---
通过 commonJSOutput
函数创建一个输出插件,并将其添加到 pkg.plugins
中。最终导出 pkg
。
现在,在执行 sewing-kit build
命令时,@sewing-kit/plugin-package-commonjs 会自动执行,并输出 CommonJS 模块。
配置项
@sewing-kit/plugin-package-commonjs 可以使用以下配置项:
outputDirectory
类型: string
默认值: 'cjs'
指定输出 CommonJS 模块的文件夹路径。例如,设置为 'lib'
会将所有输出文件放在 ./lib
目录下。
import {commonJSOutput} from '@sewing-kit/plugin-package-commonjs'; commonJSOutput({outputDirectory: 'lib'});
include
类型: string | RegExp | Array<string | RegExp>
默认值: '**/*.js'
指定要包含的文件。可以使用字符串或正则表达式,或者是字符串或正则表达式的数组。
import {commonJSOutput} from '@sewing-kit/plugin-package-commonjs'; commonJSOutput({include: '**/*.cjs'});
exclude
类型: string | RegExp | Array<string | RegExp>
默认值: ''
指定要排除的文件。可以使用字符串或正则表达式,或者是字符串或正则表达式的数组。
import {commonJSOutput} from '@sewing-kit/plugin-package-commonjs'; commonJSOutput({exclude: /__tests__/});
示例
下面是一个使用 @sewing-kit/plugin-package-commonjs 打包 CommonJS 模块的示例:
// src/index.js export function sum(a, b) { return a + b; }
-- -------------------- ---- ------- -- -------------------- ------ --------------- ---- --------------------- ------ ---------------- ---- -------------------------------------- ------ ------- ------------------- -- - ---------------- ------------------- -------------------------- ---
执行 sewing-kit build
命令后,会在项目根目录下生成一个文件夹 cjs
,其中包含打包好的 CommonJS 模块。
// cjs/index.js export function sum(a, b) { return a + b; }
总结
综上所述,@sewing-kit/plugin-package-commonjs 是一个帮助使用 Sewing Kit 打包 CommonJS 模块的插件。通过本文的介绍,你已经学会了如何使用该插件,并且了解了其常用配置项和示例。希望本文对你在前端开发中遇到的问题有所帮助。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/5f3cf94edbf7be33b25670f2