简介
在前端开发中,使用 npm
来管理依赖是非常常见的做法。而 rollup
是一个可以用来构建 JavaScript 库的工具。rollup
自身非常灵活,为了减少重复配置,我们通常使用一个 npm
包来管理 rollup
的配置文件。本文将介绍 @vericus/rollup-config 这个 npm
包的使用方法。
安装
安装 @vericus/rollup-config 可以通过以下命令完成:
npm install @vericus/rollup-config --save-dev
引入
在 rollup
的配置文件中,我们可以引入 @vericus/rollup-config 这个包,并将其导出:
// rollup.config.js import config from '@vericus/rollup-config'; export default config({ // your configuration });
配置
@vericus/rollup-config 提供了一些可配置的选项。
name
Type: string
Required: true
指定你的库的名称,会用于 UMD 和 IIFE 模块的命名。
entry
Type: string
Default: 'src/index.js'
指定入口文件路径。rollup
会从这个文件开始分析依赖,生成构建结果。
outputDir
Type: string
Default: 'dist'
指定构建结果输出目录。
format
Type: string
Default: 'esm'
指定构建库的格式,可选值有 'cjs'
、'esm'
、'umd'
、'iife'
。
modulePlugins
Type: Array<Rollup.Plugin>
Default: []
可选的插件数组,用于修改模块构建结果。
commonjsPlugins
Type: Array<Rollup.Plugin>
Default: []
可选的插件数组,用于转换 CommonJS 模块。
extraExternal
Type: Array<string>
Default: []
可选的外部库数组,用于指定哪些库是已安装的,不需要打包进构建结果。
例子
以下是一个基本的 rollup.config.js 文件,它使用了 @vericus/rollup-config:
// rollup.config.js import config from '@vericus/rollup-config'; export default config({ name: 'my-awesome-library', entry: 'src/index.js', outputDir: 'dist', format: 'umd', extraExternal: [], modulePlugins: [], commonjsPlugins: [ require('rollup-plugin-commonjs')(), require('rollup-plugin-node-resolve')(), ], });
结尾总结
@vericus/rollup-config 是一个提供了预设的 rollup 配置的 npm 包,它降低了构建一个 JavaScript 库的难度。在使用过程中,你可以通过传递 options 参数来修改其配置,并且它提供了一些可扩展的 hook,用于满足更特殊的需求。
来源:JavaScript中文网 ,转载请注明来源 本文地址:https://www.javascriptcn.com/post/600673e2fb81d47349e53d83