gulp-eslint-new 1.4.2 → 1.4.3

package/README.md

@@ -27,17 +27,11 @@ const { src } = require('gulp');
 const gulpESLintNew = require('gulp-eslint-new');
 
 // Define the default gulp task.
-exports.default =
-    () => src(['scripts/*.js'])
-    // gulpESLintNew() attaches the lint output to the "eslint" property of the
-    // file object so it can be used by other modules.
-    .pipe(gulpESLintNew())
-    // gulpESLintNew.format() outputs the lint results to the console.
-    // Alternatively use gulpESLintNew.formatEach() (see docs).
-    .pipe(gulpESLintNew.format())
-    // To have the process exit with an error code (1) on lint error, return the
-    // stream and pipe to failAfterError last.
-    .pipe(gulpESLintNew.failAfterError());
+exports.default = () => src(['scripts/*.js'])   // Read files.
+    .pipe(gulpESLintNew({ fix: true }))         // Lint files, create fixes.
+    .pipe(gulpESLintNew.fix())                  // Fix files if necessary.
+    .pipe(gulpESLintNew.format())               // Outputs lint results to the console.
+    .pipe(gulpESLintNew.failAfterError());      // Exit with an error if problems are found.
 ```
 
 Or use the plugin API to do things like:
@@ -46,18 +40,18 @@ Or use the plugin API to do things like:
 gulp.src(['**/*.js', '!node_modules/**'])
     .pipe(gulpESLintNew({
         overrideConfig: {
-            plugins: ['json'],
-            extends: ['plugin:json/recommended'],
-            rules: {
-                'my-custom-rule': 1,
-                'strict': 2
+            env: {
+                browser: true,
+                commonjs: true,
+                jquery: true
             },
+            extends: ['eslint:recommended', 'plugin:jquery/slim'],
             globals: {
-                jQuery: 'readonly',
-                $: 'readonly'
+                chrome: 'readonly'
             },
-            env: {
-                'browser': true
+            plugins: ['jquery'],
+            rules: {
+                'strict': 'error'
             }
         },
         warnIgnored: true
@@ -138,7 +132,7 @@ When `gulpESLintNew` is passed any of these options, it will map them automatica
 | `ignorePattern`   | `overrideConfig.ignorePatterns` | New option name. |
 | `parser`          | `overrideConfig.parser`         | |
 | `parserOptions`   | `overrideConfig.parserOptions`  | |
-| `plugins`         | `overrideConfig.plugins`        | `plugins` as an array of strings is migrated to `overrideConfig.plugins`. In contrast, `plugins` as an object that maps strings to plugin implementations has different semantics and is not migrated. |
+| `plugins`         | `overrideConfig.plugins`        | `plugins` as an array of strings is migrated to `overrideConfig.plugins`. By contrast, `plugins` as an object that maps strings to plugin implementations has different semantics and is not migrated. |
 | `rules`           | `overrideConfig.rules`          | |
 | `warnFileIgnored` | `warnIgnored`                   | New option name. |
 

package/index.d.ts

@@ -2,171 +2,177 @@ import { ESLint, Linter }    from 'eslint';
 import                            'node';
 import { TransformCallback } from 'stream';
 
-type FormatterFunction =
-	(results: ESLint.LintResult[], data?: ESLint.LintResultData) => string | Promise<string>;
+type FormatterFunction
+= (results: ESLint.LintResult[], data?: ESLint.LintResultData) => string | Promise<string>;
 
 type LintResultStreamFunction<Type>
-	= ((action: (value: Type, callback: TransformCallback) => void) => NodeJS.ReadWriteStream)
-	& ((action: (value: Type) => unknown | Promise<unknown>) => NodeJS.ReadWriteStream);
-
-export type GulpESLintOptions =
-	Omit<
-	ESLint.Options,
-	| 'cache'
-	| 'cacheLocation'
-	| 'cacheStrategy'
-	| 'errorOnUnmatchedPattern'
-	| 'extensions'
-	| 'globInputPaths'
-	| 'plugins'
-	>
-	& {
-		/** @deprecated Use `overrideConfigFile` instead. */
-		configFile?: ESLint.Options['overrideConfigFile'];
-
-		/**
-		 * @deprecated
-		 * Use `overrideConfig.env` or `baseConfig.env` instead.
-		 * Note the different option name and format.
-		 */
-		envs?: string[] | undefined;
-
-		/** @deprecated Use `overrideConfig.extends` or `baseConfig.extends` instead. */
-		extends?: Linter.Config['extends'];
-
-		/**
-		 * @deprecated
-		 * Use `overrideConfig.globals` or `baseConfig.globals` instead. Note the different format.
-		 */
-		globals?: string[] | undefined;
-
-		/**
-		 * @deprecated
-		 * Use `overrideConfig.ignorePatterns` or `baseConfig.ignorePatterns` instead.
-		 * Note the different option name.
-		 */
-		ignorePattern?: Linter.Config['ignorePatterns'];
-
-		/** @deprecated Use `overrideConfig.parser` or `baseConfig.parser` instead. */
-		parser?: Linter.Config['parser'];
-
-		/** @deprecated Use `overrideConfig.parserOptions` or `baseConfig.parserOptions` instead. */
-		parserOptions?: Linter.ParserOptions | undefined;
-
-		plugins?: ESLint.Options['plugins'] | Linter.Config['plugins'];
-
-		quiet?:
-		| boolean
-		| ((message: Linter.LintMessage, index: number, list: Linter.LintMessage[]) => unknown)
-		| undefined;
-
-		/** @deprecated Use `overrideConfig.rules` or `baseConfig.rules` instead. */
-		rules?: Linter.Config['rules'];
-
-		/** @deprecated Use `warnIgnored` instead. */
-		warnFileIgnored?: boolean | undefined;
-
-		warnIgnored?: boolean | undefined;
-	};
+= ((action: (value: Type, callback: TransformCallback) => void) => NodeJS.ReadWriteStream)
+& ((action: (value: Type) => unknown | Promise<unknown>) => NodeJS.ReadWriteStream);
+
+interface LoadedFormatter {
+    format(results: ESLint.LintResult[]): string | Promise<string>;
+}
+
+export type GulpESLintOptions
+=
+Omit<
+ESLint.Options,
+| 'cache'
+| 'cacheLocation'
+| 'cacheStrategy'
+| 'errorOnUnmatchedPattern'
+| 'extensions'
+| 'globInputPaths'
+| 'plugins'
+>
+& {
+    /** @deprecated Use `overrideConfigFile` instead. */
+    configFile?: ESLint.Options['overrideConfigFile'];
+
+    /**
+     * @deprecated
+     * Use `overrideConfig.env` or `baseConfig.env` instead.
+     * Note the different option name and format.
+     */
+    envs?: string[] | undefined;
+
+    /** @deprecated Use `overrideConfig.extends` or `baseConfig.extends` instead. */
+    extends?: Linter.Config['extends'];
+
+    /**
+     * @deprecated
+     * Use `overrideConfig.globals` or `baseConfig.globals` instead. Note the different format.
+     */
+    globals?: string[] | undefined;
+
+    /**
+     * @deprecated
+     * Use `overrideConfig.ignorePatterns` or `baseConfig.ignorePatterns` instead.
+     * Note the different option name.
+     */
+    ignorePattern?: Linter.Config['ignorePatterns'];
+
+    /** @deprecated Use `overrideConfig.parser` or `baseConfig.parser` instead. */
+    parser?: Linter.Config['parser'];
+
+    /** @deprecated Use `overrideConfig.parserOptions` or `baseConfig.parserOptions` instead. */
+    parserOptions?: Linter.ParserOptions | undefined;
+
+    plugins?: ESLint.Options['plugins'] | Linter.Config['plugins'];
+
+    quiet?:
+    | boolean
+    | ((message: Linter.LintMessage, index: number, list: Linter.LintMessage[]) => unknown)
+    | undefined;
+
+    /** @deprecated Use `overrideConfig.rules` or `baseConfig.rules` instead. */
+    rules?: Linter.Config['rules'];
+
+    /** @deprecated Use `warnIgnored` instead. */
+    warnFileIgnored?: boolean | undefined;
+
+    warnIgnored?: boolean | undefined;
+};
 
 export type GulpESLintResult = ESLint.LintResult;
 
-export type GulpESLintResults =
-	GulpESLintResult[] &
-	{
-		errorCount:          number;
-		fatalErrorCount:     number;
-		warningCount:        number;
-		fixableErrorCount:   number;
-		fixableWarningCount: number;
-	};
+export type GulpESLintResults
+=
+GulpESLintResult[] &
+{
+    errorCount:          number;
+    fatalErrorCount:     number;
+    warningCount:        number;
+    fixableErrorCount:   number;
+    fixableWarningCount: number;
+};
 
 export type GulpESLintWriter = (str: string) => unknown | Promise<unknown>;
 
 declare const gulpESLintNew: {
-	/**
-	 * Append ESLint result to each file.
-	 *
-	 * @param options - Options for gulp-eslint-new.
-	 * @returns gulp file stream.
-	 */
-	(options?: GulpESLintOptions): NodeJS.ReadWriteStream;
-
-	/**
-	 * Append ESLint result to each file.
-	 *
-	 * @param overrideConfigFile - The path to a configuration file.
-	 * @returns gulp file stream.
-	 */
-	(overrideConfigFile?: string): NodeJS.ReadWriteStream;
-
-	/**
-	 * Handle each ESLint result as it passes through the stream.
-	 *
-	 * @param action - A function to handle each ESLint result.
-	 * @returns gulp file stream.
-	 */
-	result: LintResultStreamFunction<GulpESLintResult>;
-
-	/**
-	 * Handle all ESLint results at the end of the stream.
-	 *
-	 * @param action - A function to handle all ESLint results.
-	 * @returns gulp file stream.
-	 */
-	results: LintResultStreamFunction<GulpESLintResults>;
-
-	/**
-	 * Fail when an ESLint error is found in an ESLint result.
-	 *
-	 * @returns gulp file stream.
-	 */
-	failOnError(): NodeJS.ReadWriteStream;
-
-	/**
-	 * Fail when the stream ends if any ESLint error(s) occurred.
-	 *
-	 * @returns gulp file stream.
-	 */
-	failAfterError(): NodeJS.ReadWriteStream;
-
-	/**
-	 * Format the results of each file individually.
-	 *
-	 * @param formatter -
-	 * A name or path of a formatter, a formatter object or a formatter function.
-	 * Defaults to the [stylish](https://eslint.org/docs/user-guide/formatters/#stylish) formatter.
-	 * @param writer -
-	 * A funtion or stream to write the formatted ESLint results.
-	 * Defaults to gulp's [fancy-log](https://github.com/gulpjs/fancy-log#readme).
-	 * @returns gulp file stream.
-	 */
-	formatEach(
-		formatter?: string | ESLint.Formatter | FormatterFunction,
-		writer?: GulpESLintWriter | NodeJS.WritableStream
-	): NodeJS.ReadWriteStream;
-
-	/**
-	 * Wait until all files have been linted and format all results at once.
-	 *
-	 * @param formatter -
-	 * A name or path of a formatter, a formatter object or a formatter function.
-	 * Defaults to the [stylish](https://eslint.org/docs/user-guide/formatters/#stylish) formatter.
-	 * @param writer -
-	 * A funtion or stream to write the formatted ESLint results.
-	 * Defaults to gulp's [fancy-log](https://github.com/gulpjs/fancy-log#readme).
-	 * @returns gulp file stream.
-	 */
-	format(
-		formatter?: string | ESLint.Formatter | FormatterFunction,
-		writer?: GulpESLintWriter | NodeJS.WritableStream
-	): NodeJS.ReadWriteStream;
-
-	/**
-	 * Overwrite source files with the fixed content provided by ESLint if present.
-	 *
-	 * @returns gulp file stream.
-	 */
-	fix(): NodeJS.ReadWriteStream;
+    /**
+     * Append ESLint result to each file.
+     *
+     * @param options - Options for gulp-eslint-new.
+     * @returns gulp file stream.
+     */
+    (options?: GulpESLintOptions): NodeJS.ReadWriteStream;
+
+    /**
+     * Append ESLint result to each file.
+     *
+     * @param overrideConfigFile - The path to a configuration file.
+     * @returns gulp file stream.
+     */
+    (overrideConfigFile?: string): NodeJS.ReadWriteStream;
+
+    /**
+     * Handle each ESLint result as it passes through the stream.
+     *
+     * @param action - A function to handle each ESLint result.
+     * @returns gulp file stream.
+     */
+    result: LintResultStreamFunction<GulpESLintResult>;
+
+    /**
+     * Handle all ESLint results at the end of the stream.
+     *
+     * @param action - A function to handle all ESLint results.
+     * @returns gulp file stream.
+     */
+    results: LintResultStreamFunction<GulpESLintResults>;
+
+    /**
+     * Fail when an ESLint error is found in an ESLint result.
+     *
+     * @returns gulp file stream.
+     */
+    failOnError(): NodeJS.ReadWriteStream;
+
+    /**
+     * Fail when the stream ends if any ESLint error(s) occurred.
+     *
+     * @returns gulp file stream.
+     */
+    failAfterError(): NodeJS.ReadWriteStream;
+
+    /**
+     * Format the results of each file individually.
+     *
+     * @param formatter -
+     * A name or path of a formatter, a formatter object or a formatter function.
+     * Defaults to the [stylish](https://eslint.org/docs/user-guide/formatters/#stylish) formatter.
+     * @param writer -
+     * A funtion or stream to write the formatted ESLint results.
+     * Defaults to gulp's [fancy-log](https://github.com/gulpjs/fancy-log#readme).
+     * @returns gulp file stream.
+     */
+    formatEach(
+        formatter?: string | LoadedFormatter | FormatterFunction,
+        writer?: GulpESLintWriter | NodeJS.WritableStream
+    ): NodeJS.ReadWriteStream;
+
+    /**
+     * Wait until all files have been linted and format all results at once.
+     *
+     * @param formatter -
+     * A name or path of a formatter, a formatter object or a formatter function.
+     * Defaults to the [stylish](https://eslint.org/docs/user-guide/formatters/#stylish) formatter.
+     * @param writer -
+     * A funtion or stream to write the formatted ESLint results.
+     * Defaults to gulp's [fancy-log](https://github.com/gulpjs/fancy-log#readme).
+     * @returns gulp file stream.
+     */
+    format(
+        formatter?: string | LoadedFormatter | FormatterFunction,
+        writer?: GulpESLintWriter | NodeJS.WritableStream
+    ): NodeJS.ReadWriteStream;
+
+    /**
+     * Overwrite source files with the fixed content provided by ESLint if present.
+     *
+     * @returns gulp file stream.
+     */
+    fix(): NodeJS.ReadWriteStream;
 };
 export default gulpESLintNew;