Skip to content

Commit 8f7e966

Browse files
committed
1 parent b48a04a commit 8f7e966

File tree

3 files changed

+15
-18
lines changed

3 files changed

+15
-18
lines changed

CHANGELOG.md

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,26 @@
11
# Changelog
22

3-
## 4.0.2
4-
5-
* Remove deprecated [`gulp-util`](https://github.com/gulpjs/gulp-util) dependency and use individual modules instead
6-
73
## 4.0.1
84

95
* Make `fix` option work even if `quiet` option is also enabled
6+
* Remove deprecated [`gulp-util`](https://github.com/gulpjs/gulp-util) dependency and use individual modules instead
107

118
## 4.0.0
129

1310
* Drop support for linting [`Stream`](https://nodejs.org/api/stream.html#stream_stream) [contents](https://github.com/gulpjs/vinyl#optionscontents)
1411
* Because almost all, at least widely used tools to handle JavaScript files don't support `Streams`. They only support either `String` or `Buffer`.
1512
* Use [`Buffer.from(<string>)`](https://nodejs.org/api/buffer.html#buffer_class_method_buffer_from_string_encoding) instead of the deprecated [`new Buffer(<string>)`](https://nodejs.org/dist/latest-v8.x/docs/api/buffer.html#buffer_new_buffer_string_encoding)
1613
* Note that `Buffer.from` is only available on Node.js >= [4.5.0](https://nodejs.org/en/blog/release/v4.5.0/).
17-
* Bump [`eslint`](https://github.com/eslint/eslint) dependency to [`^4.0.0`](http://eslint.org/blog/2017/06/eslint-v4.0.0-released)
18-
* Emit a [`PluginError`](https://github.com/gulpjs/gulp-util#new-pluginerrorpluginname-message-options) when it fails to load an [ESLint plugin](http://eslint.org/docs/user-guide/configuring#configuring-plugins)
14+
* Bump [`eslint`](https://github.com/eslint/eslint) dependency to [`^4.0.0`](https://eslint.org/blog/2017/06/eslint-v4.0.0-released)
15+
* Emit a [`PluginError`](https://github.com/gulpjs/gulp-util#new-pluginerrorpluginname-message-options) when it fails to load an [ESLint plugin](https://eslint.org/docs/user-guide/configuring#configuring-plugins)
1916

2017
## 3.0.1
2118

2219
* Remove unnecessary `object-assign` dependency
2320

2421
## 3.0.0
2522

26-
* Bump eslint dependency to ^3.0.0 <http://eslint.org/blog/2016/07/eslint-v3.0.0-released>
23+
* Bump eslint dependency to ^3.0.0 <https://eslint.org/blog/2016/07/eslint-v3.0.0-released>
2724
* Use ES2015 syntax
2825
* Remove these deprecated option aliases:
2926
* `global`

README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# gulp-eslint [![Build Status](https://travis-ci.org/adametry/gulp-eslint.svg)](https://travis-ci.org/adametry/gulp-eslint) [![Coverage Status](https://img.shields.io/coveralls/adametry/gulp-eslint.svg)](https://coveralls.io/r/adametry/gulp-eslint)
22

3-
> A [gulp](http://gulpjs.com/) plugin for [ESLint](http://eslint.org/).
3+
> A [gulp](https://gulpjs.com/) plugin for [ESLint](https://eslint.org/).
44
55
## Installation
66

@@ -67,13 +67,13 @@ For additional examples, look through the [example directory](https://github.com
6767
*No explicit configuration.* A `.eslintrc` file may be resolved relative to each linted file.
6868

6969
### eslint(options)
70-
See [ESlint CLIEngine options](http://eslint.org/docs/developer-guide/nodejs-api#cliengine).
70+
See [ESlint CLIEngine options](https://eslint.org/docs/developer-guide/nodejs-api#cliengine).
7171

7272
#### options.rules
7373

7474
Type: `Object`
7575

76-
Set [configuration](http://eslint.org/docs/user-guide/configuring#configuring-rules) of [rules](http://eslint.org/docs/rules/).
76+
Set [configuration](https://eslint.org/docs/user-guide/configuring#configuring-rules) of [rules](https://eslint.org/docs/rules/).
7777

7878
```javascript
7979
{
@@ -104,15 +104,15 @@ Specify global variables to declare.
104104

105105
Type: `Boolean`
106106

107-
This option instructs ESLint to try to fix as many issues as possible. The fixes are applied to the gulp stream. The fixed content can be saved to file using `gulp.dest` (See [example/fix.js](https://github.com/adametry/gulp-eslint/blob/master/example/fix.js)). Rules that are fixable can be found in ESLint's [rules list](http://eslint.org/docs/rules/).
107+
This option instructs ESLint to try to fix as many issues as possible. The fixes are applied to the gulp stream. The fixed content can be saved to file using `gulp.dest` (See [example/fix.js](https://github.com/adametry/gulp-eslint/blob/master/example/fix.js)). Rules that are fixable can be found in ESLint's [rules list](https://eslint.org/docs/rules/).
108108

109109
When fixes are applied, a "fixed" property is set to `true` on the fixed file's ESLint result.
110110

111111
#### options.quiet
112112

113113
Type: `Boolean`
114114

115-
When `true`, this option will filter warning messages from ESLint results. This mimics the ESLint CLI [quiet option](http://eslint.org/docs/user-guide/command-line-interface#quiet).
115+
When `true`, this option will filter warning messages from ESLint results. This mimics the ESLint CLI [quiet option](https://eslint.org/docs/user-guide/command-line-interface#quiet).
116116

117117
Type: `function (message, index, list) { return Boolean(); }`
118118

@@ -122,19 +122,19 @@ When provided a function, it will be used to filter ESLint result messages, remo
122122

123123
Type: `Array`
124124

125-
Specify a list of [environments](http://eslint.org/docs/user-guide/configuring#specifying-environments) to be applied.
125+
Specify a list of [environments](https://eslint.org/docs/user-guide/configuring#specifying-environments) to be applied.
126126

127127
#### options.rulePaths
128128

129129
Type: `Array`
130130

131-
This option allows you to specify additional directories from which to load rules files. This is useful when you have custom rules that aren't suitable for being bundled with ESLint. This option works much like the ESLint CLI's [rulesdir option](http://eslint.org/docs/user-guide/command-line-interface#rulesdir).
131+
This option allows you to specify additional directories from which to load rules files. This is useful when you have custom rules that aren't suitable for being bundled with ESLint. This option works much like the ESLint CLI's [rulesdir option](https://eslint.org/docs/user-guide/command-line-interface#rulesdir).
132132

133133
#### options.configFile
134134

135135
Type: `String`
136136

137-
Path to the ESLint rules configuration file. For more information, see the ESLint CLI [config option](http://eslint.org/docs/user-guide/command-line-interface#c-config) and [Using Configuration Files](http://eslint.org/docs/user-guide/configuring#using-configuration-files).
137+
Path to the ESLint rules configuration file. For more information, see the ESLint CLI [config option](https://eslint.org/docs/user-guide/command-line-interface#c-config) and [Using Configuration Files](https://eslint.org/docs/user-guide/configuring#using-configuration-files).
138138

139139
#### options.warnFileIgnored
140140

@@ -146,7 +146,7 @@ When `true`, add a result warning when ESLint ignores a file. This can be used t
146146

147147
Type: `Boolean`
148148

149-
When `false`, ESLint will not load [.eslintrc files](http://eslint.org/docs/user-guide/configuring#using-configuration-files).
149+
When `false`, ESLint will not load [.eslintrc files](https://eslint.org/docs/user-guide/configuring#using-configuration-files).
150150

151151
### eslint(configFilePath)
152152

@@ -265,7 +265,7 @@ ESLint may be configured explicity by using any of the following plugin options:
265265

266266
ESLint will ignore files that do not have a `.js` file extension at the point of linting ([some plugins](https://github.com/contra/gulp-coffee) may change file extensions mid-stream). This avoids unintentional linting of non-JavaScript files.
267267

268-
ESLint will also detect an `.eslintignore` file at the cwd or a parent directory. See the [ESLint docs](http://eslint.org/docs/user-guide/configuring#ignoring-files-and-directories) to learn how to construct this file.
268+
ESLint will also detect an `.eslintignore` file at the cwd or a parent directory. See the [ESLint docs](https://eslint.org/docs/user-guide/configuring#ignoring-files-and-directories) to learn how to construct this file.
269269

270270
## Extensions
271271

example/format.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ gulp.task('eslint-formatter', () => {
1313
// use eslint's default formatter by default
1414
.pipe(eslint.format())
1515
// Name a built-in formatter or path load.
16-
// http://eslint.org/docs/user-guide/command-line-interface#f-format
16+
// https://eslint.org/docs/user-guide/command-line-interface#-f---format
1717
.pipe(eslint.format('compact'));
1818
});
1919

0 commit comments

Comments
 (0)