jshint-loader
Install
npm i jshint-loader --save
用法
在 webpack 配置中启用 jshint loader:
module.exports = {
module: {
rules: [
{
test: /\.js$/, // 涵盖 .js 文件
enforce: "pre", // 预先加载好 jshint loader
exclude: /node_modules/, // 排除掉 node_modules 文件夹下的所有文件
use: [
{
loader: "jshint-loader"
}
]
}
]
},
// 更多jslint的配置项
jshint: {
// 查询jslint配置项,请参考 http://www.jshint.com/docs/options/
// 例如
camelcase: true,
//jslint的错误信息在默认情况下会显示为warning(警告)类信息
//将emitErrors参数设置为true可使错误显示为error(错误)类信息
emitErrors: false,
//jshint默认情况下不会打断webpack编译
//如果你想在jshint出现错误时,立刻停止编译
//请设置failOnHint参数为true
failOnHint: false,
// 自定义报告函数
reporter: function(errors) { }
}
}
自定义报告函数
在默认情况下,jshint-loader
会提供一个默认的报告方法。
然而,如果你想自定义报告函数,你可以在jshint
配置下 key 为report
下的配置项里传入自定义的函数。(参考上文的用法)
然后,jshint将会生成与以下示例结构一致的错误/警告信息(数组)给报告函数。
[
{
id: [字符串, 通常是 '(error)'],
code: [字符串, 错误/警告(error/warning)编码],
reason: [字符串, 错误/警告(error/warning)信息],
evidence: [字符串, 对应生成此错误的编码]
line: [数字]
character: [数字]
scope: [字符串, 消息作用域;
通常是 '(main)' 除非代码被解析(eval)了]
[+ 还有一些旧有的参数,一般用户不必了解]
},
// ...
// 更多的错误/警告
]
报告函数会将loader的上下文信息保存在this
后执行。你可以使用this.emitWarning(...)
或者this.emitError(...)
方法,手动触发信息的报告。请参考关于loader上下文的webpack文档.
注意: jshint reporters
是与 jshint-loader
不兼容的!
这是因为reporter的输入来源,只能从一个文件,而不能同时从多个文件读取。在这种方式下的错误报告,是与jshint的传统 reporters 不一样的,因为loader插件(例如 jshint-loader)是会在每一个源文件上执行的,因此它们的报告函数也会分别对应每一个源文件上执行。 webpack控制台输出的格式大致如下:
...
WARNING in ./path/to/file.js
<reporter outpu>
...
`
Maintainers
Juho Vepsäläinen |
Joshua Wiens |
Kees Kluskens |
Sean Larkin |