gulp常用插件之gulp-eslint使用
更多gulp常用插件使用请访问:gulp常用插件汇总
** gulp-eslint**这是一个用于识别和报告在ECMAScript/JavaScript代码中找到的模式的Gulp插件。。
安装
一键安装不多解释
npm install --save-dev gulp-eslint
使用
基础使用:
const {src, task} = require('gulp');
const eslint = require('gulp-eslint');
task('default', () => {
return src(['scripts/*.js'])
// eslint()将lint输出附加到“eslint”属性 以供其它模块使用
.pipe(eslint())
// format()将lint结果输出到控制台。
// 或者使用eslint.formatEach()(参见文档)。
.pipe(eslint.format())
// 使进程退出时具有错误代码(1)
// lint错误,最后将流和管道返回failAfterError。
.pipe(eslint.failAfterError());
});
或使用插件API进行以下操作:
gulp.src(['**/*.js','!node_modules/**'])
.pipe(eslint({
rules: {
'my-custom-rule': 1,
'strict': 2
},
globals: [
'jQuery',
'$'
],
envs: [
'browser'
]
}))
.pipe(eslint.formatEach('compact', process.stderr));
有关其他示例,请浏览example目录。
API
eslint()
没有明确的配置。可以相对于每个linted文件解析.eslintrc
文件。
eslint(options)
请参阅ESlint CLIEngine选项。
options.rules
类型: Object
默认值:null
一套配置的规则。
{
"rules":{
"camelcase": 1,
"comma-dangle": 2,
"quotes": 0
}
}
options.globals
类型: Array
默认值:[]
指定要声明的全局变量。
{
"globals":[
"jQuery",
"$"
]
}
options.fix
类型: Boolean
默认值:false
此选项指示ESLint尝试修复尽可能多的问题。修正被应用到gulp流。固定内容可以使用gulp.dest
保存到文件中(参见example/fix.js)。可修复的规则可以在ESLint的规则列表中找到。
应用修复程序时,在修复文件的ESLint结果中将“fixed
”属性设置为true
。
options.quiet
类型: Boolean
如果为true
,则此选项将从ESLint结果中过滤警告消息。这模仿了ESLint CLI 安静选项。
类型: function (message, index, list) { return Boolean(); }
当提供一个函数时,它将用于筛选ESLint结果消息,删除任何不返回true
(或真实)值的消息。
options.envs
类型:Array
默认值:[]
指定要应用的环境列表。
options.rulePaths
类型: Array
默认值:[]
此选项允许您指定从中加载规则文件的其他目录。当您有不适合与ESLint捆绑在一起的自定义规则时,这非常有用。此选项的工作方式与ESLint CLI的rulesdir选项非常类似。
options.configFile
类型:String
默认值:null
ESLint规则配置文件的路径。有关更多信息,请参阅ESLint CLI 配置选项和使用配置文件。
options.warnFileIgnored
类型: Boolean
如果为true
,则在ESLint忽略文件时添加结果警告。这可用于归档gulp.src
不必要加载的文件。例如,由于ESLint会自动忽略“node_modules
”文件路径,而gulp.src
则不会,因此一个gulp任务仅从“node_modules
”目录读取文件可能需要几秒钟的时间。
options.useEslintrc
类型: Boolean
默认值:true
false
启用时,ESLint将不加载.eslintrc文件。
eslint(configFilePath)
类型:String
定义的简写options.configFile
。
eslint.result(action)
类型: function (result) {}
为每个ESLint文件结果调用一个函数。不需要返回值。如果抛出一个错误,它将被包装在一个Gulp PluginError
中并从流中发出。
gulp.src(['**/*.js','!node_modules/**'])
.pipe(eslint())
.pipe(eslint.result(result => {
// 为每个ESLint结果调用。
console.log(`ESLint result: ${result.filePath}`);
console.log(`# Messages: ${result.messages.length}`);
console.log(`# Warnings: ${result.warningCount}`);
console.log(`# Errors: ${result.errorCount}`);
}));
类型: function (result, callback) { callback(error); }
为每个ESLint文件结果调用异步函数。必须调用回调才能完成流。如果一个值被传递给回调,它将被包装在一个Gulp PluginError
中并从流中发出。
eslint.results(action)
类型: function (results) {}
在流完成之前,对所有ESLint文件结果调用一次函数。不需要返回值。如果抛出一个错误,它将被包装在一个Gulp PluginError中并从流中发出。
结果列表有一个“warningCount”属性,它是所有结果中警告的总和;同样,“errorCount”属性设置为所有结果中错误的总和。
gulp.src(['**/*.js','!node_modules/**'])
.pipe(eslint())
.pipe(eslint.results(results => {
// 调用一次对所有ESLint结果。
console.log(`Total Results: ${results.length}`);
console.log(`Total Warnings: ${results.warningCount}`);
console.log(`Total Errors: ${results.errorCount}`);
}));
类型: function (results, callback) { callback(error); }
在流完成之前,对所有ESLint文件结果调用一次异步函数。必须调用回调才能完成流。如果一个值被传递给回调,它将被包装在一个Gulp PluginError中并从流中发出。
eslint.failOnError()
如果已报告任何文件的ESLint错误,请停止任务/流。
// 在将无效的JS文件复制到输出目录之前,导致流停止(/fail)
gulp.src(['**/*.js','!node_modules/**'])
.pipe(eslint())
.pipe(eslint.failOnError());
eslint.failAfterError()
如果已报告任何文件的ESLint错误,请停止任务/流,但请先处理所有文件。
// 如果发生任何ESLint错误,请在流结束时使流停止(/fail)。
gulp.src(['**/*.js','!node_modules/**'])
.pipe(eslint())
.pipe(eslint.failAfterError());
eslint.format(formatter, output)
格式化所有文件一次。这应该在通过eslint
进行管道传输后在流中使用;否则,将找不到要格式化的eslint结果。
formatter
参数可以是String
、Function
或undefined
。作为String
,具有该名称或路径的格式化程序模块将被解析为相对于process.cwd()
的模块,或作为ESLint提供的格式化程序之一的模块。如果undefined
,则将解析ESLint“stylish
”格式化程序。将调用一个Function
,其中包含要格式化的文件linting结果数组(Array
)。
// 使用默认的“`stylish`”ESLint格式化程序
eslint.format()
// 使用“ checkstyle” ESLint格式化程序
eslint.format('checkstyle')
// 使用“ eslint-path-formatter”模块格式化程序
// (@see https://github.com/Bartvds/eslint-path-formatter)
eslint.format('node_modules/eslint-path-formatter')
output
参数可以是一个WritableStream
,Function
或undefined
。作为WritableStream
,格式化程序结果将写入流。如果undefined
,格式化程序结果将写入gulp的log。Function
将使用格式化程序结果作为唯一参数来调用。
// 写入gulp的日志(默认)
eslint.format();
// 向stdout写入消息
eslint.format('junit', process.stdout)
eslint.formatEach(formatter, output)
分别格式化每个文件。这应该在通过eslint进行管道传输后在流中使用;否则,将找不到要格式化的eslint结果。
formatEach
的参数与的参数相同format
。
Configuration(配置)
ESLint可以使用以下任何插件选项进行显式配置:config
、rules
、globals
或env
。如果useEslintrc选项未设置为false
,则ESLint将尝试在要linted的文件所在的目录中解析名为.eslintrc
的文件。如果在那里找不到,将搜索父目录,直到找到.eslintrc
或到达目录根目录。
Ignore Files(忽略文件)
ESLint将忽略在linting点没有.js
文件扩展名的文件(有些插件可能会在流中更改文件扩展名)。这样可以避免无意中对非JavaScript文件进行linting操作。
ESLint还将在cwd或父目录中检测到.eslintignore
文件。请参阅ESLint文档以了解如何构造此文件。
Extensions (扩展名)
ESLint结果作为“ESLint”属性附加到通过Gulp.js流管道的乙烯基文件。这可用于跟随初始eslint
流的流。eslint.result和eslint.results方法可用于支持对eslint
结果的扩展和自定义处理。
原文地址:https://www.cnblogs.com/jiaoshou/p/12209597.html
- Centos 使用YUM安装MariaDB
- Div Scroll Bar (用层模拟滚动条)
- WordPress免插件仅代码实现文章浏览次数的方法(3)
- 定义新智慧,这AI很“远景X3”
- WordPress删除头部wp_head()多余代码
- 域名fde.com在国内平台以11万元被秒
- 微信小程序助力实体店对接互联网市场
- PostgreSQL 与 MySQL 相比,优势何在?
- Setting Up KeePass For Centos 6
- 拼音米大热!快视”、“冰冰”等多个域名结拍
- 入门必读:Hadoop新手学习指导
- 使用密码记录工具keepass来保存密码
- 机器人带着VR学习,最后学会了人工智能
- 超经典的JBOSS入门文章
- JavaScript 教程
- JavaScript 编辑工具
- JavaScript 与HTML
- JavaScript 与Java
- JavaScript 数据结构
- JavaScript 基本数据类型
- JavaScript 特殊数据类型
- JavaScript 运算符
- JavaScript typeof 运算符
- JavaScript 表达式
- JavaScript 类型转换
- JavaScript 基本语法
- JavaScript 注释
- Javascript 基本处理流程
- Javascript 选择结构
- Javascript if 语句
- Javascript if 语句的嵌套
- Javascript switch 语句
- Javascript 循环结构
- Javascript 循环结构实例
- Javascript 跳转语句
- Javascript 控制语句总结
- Javascript 函数介绍
- Javascript 函数的定义
- Javascript 函数调用
- Javascript 几种特殊的函数
- JavaScript 内置函数简介
- Javascript eval() 函数
- Javascript isFinite() 函数
- Javascript isNaN() 函数
- parseInt() 与 parseFloat()
- escape() 与 unescape()
- Javascript 字符串介绍
- Javascript length属性
- javascript 字符串函数
- Javascript 日期对象简介
- Javascript 日期对象用途
- Date 对象属性和方法
- Javascript 数组是什么
- Javascript 创建数组
- Javascript 数组赋值与取值
- Javascript 数组属性和方法
- 地表最强的MySQL安装一键式安装,信不信你下完我就给你装好!附各种Mysql安装失败的解决办法(什么你安装失败了?快来看这个)
- The Preliminary Contest for ICPC Asia Xuzhou 2019 徐州网络赛 C Buy Watermelon
- The Preliminary Contest for ICPC Asia Xuzhou 2019 徐州网络赛 B so easy
- 萌新不看会后悔的C++基本类型总结(二)
- The Preliminary Contest for ICPC Asia Xuzhou 2019 徐州网络赛 A Who is better?
- 树的重心
- PostgreSQL 13:索引并行vacuum
- 『数据库』震惊,某博主为吸引眼球拿出压箱底SQL总结,如果你没看那就吃亏了!(超级详细的SQL基础,你还不会的话就别学数据库了)
- 萌新不看会后悔的C++基本类型总结(一)
- 2019 ICPC 银川网络赛 D. Take Your Seat (疯子坐飞机问题)
- 2019 ICPC 银川网络赛 H. Fight Against Monsters
- 状态压缩DP(大佬写的很好,转来看)
- 2019 ICPC 银川网络赛 F-Moving On (卡Cache)
- 树形结构--二叉树的遍历算法应用(十九)
- POJ1088 滑雪题解+HDU 1078(记忆化搜索DP)