介绍
fis3-deploy-checkup 是一个用于前端项目构建的 npm 包。它可以在每次构建时自动检查项目中的问题,如代码规范问题、安全性问题等,帮助你保证构建的代码质量和安全性。
安装
使用 npm 可以很容易地安装 fis3-deploy-checkup:
npm install fis3-deploy-checkup --save-dev
配置
在 fis-conf.js 中增加以下代码:
fis .media('prod') .match('*.js', { deploy: fis.plugin('checkup', { // 配置 }) });
你可以在 deploy 阶段的任何位置使用 fis3-deploy-checkup。通常,我们使用 fis3 的 prod 配置来进行构建,所以在上述代码中使用了 media('prod')。
配置选项
以下是 fis3-deploy-checkup 支持的配置选项的说明:
type
- 类型:Array
- 默认值:["jshint"]
要使用的检查器类型。当前 fis3-deploy-checkup 支持的检查器类型有:
- jshint:使用 JSHint 进行 JavaScript 代码的检查。
- csslint:使用 CSSLint 进行 CSS 代码的检查。
- htmlhint:使用 HTMLHint 进行 HTML 代码的检查。
- eslint:使用 ESLint 进行 JavaScript 代码的检查。
autoFix
- 类型:Boolean
- 默认值:false
是否对检查出的错误自动修复。如果设置为 true,则 fis3-deploy-checkup 会尝试自动修复能够自动修复的错误。
rules
- 类型:Object
- 默认值:{}
检查器配置。每个检查器都有自己的配置。你可以像下面这样配置 fis3-deploy-checkup:
-- -------------------- ---- ------- --- -------------- -------------- - ------- --------------------- - ----- ----------- -------- ----- ------ - ------- - -- ------ --- -- -------- - -- ------- --- -- -- --- -- -- -- ---
目录结构:
my-project/ ├── node_modules/ │ ├── fis3-deploy-checkup/ │ └── ... └── fis-conf.js
示例代码
下面是一个配置文件示例,它使用 JSHint 检查 JavaScript 代码,并对检查出的错误进行自动修复:
-- -------------------- ---- ------- --- -------------- -------------- - ------- --------------------- - ----- ----------- -------- ----- ------ - ------- - -------- ----- --------- ---- - - -- ---
结论
使用 fis3-deploy-checkup,可以帮助您在每次构建时保证代码质量和安全性。我们建议您在项目的构建配置中使用 fis3-deploy-checkup,并根据项目的需要进行相应的配置。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/6005554181e8991b448d2774