gulp-eslint-new 2.1.0 → 2.3.0

package/README.md

@@ -53,21 +53,41 @@ src(['scripts/*.js'])                   // Read files.
 Or use the plugin API to do things like:
 
 ```javascript
-gulp.src(['**/*.js', '!node_modules/**'])
+// gulpfile.mjs
+import js               from '@eslint/js';
+import jquery           from 'eslint-plugin-jquery';
+import globals          from 'globals';
+import gulp             from 'gulp';
+import gulpESLintNew    from 'gulp-eslint-new';
+
+export default
+() =>
+gulp.src(['**/*.{js,mjs}', '!node_modules/**'])
 .pipe
 (
     gulpESLintNew
     (
         {
+            configType:     'flat',
             overrideConfig:
-            {
-                env:        { browser: true, commonjs: true, jquery: true },
-                extends:    ['eslint:recommended', 'plugin:jquery/slim'],
-                globals:    { chrome: 'readonly' },
-                plugins:    ['jquery'],
-                rules:      { 'strict': 'error' },
-            },
-            warnIgnored: true,
+            [
+                js.configs.recommended,
+                jquery.configs.slim,
+                {
+                    languageOptions:
+                    {
+                        globals:
+                        {
+                            ...globals.browser,
+                            ...globals.jquery,
+                            chrome: 'readonly',
+                        },
+                    },
+                    rules:  { 'strict': 'error' },
+                },
+            ],
+            plugins:        { jquery },
+            warnIgnored:    true,
         },
     ),
 )
@@ -80,7 +100,7 @@ For additional examples, look through the [example directory](https://github.com
 
 ### `gulpESLintNew()`
 
-Run ESLint with default settings. A [configuration file](https://eslint.org/docs/user-guide/configure/configuration-files) may be resolved relative to each linted file.
+Run ESLint with default settings. A [configuration file](https://eslint.org/docs/user-guide/configure/configuration-files) will be resolved depending on the version of ESLint used.
 
 ### `gulpESLintNew(options)`
 
@@ -120,6 +140,9 @@ See the linked content for details about each option.
 * [`quiet`](#optionsquiet)
 * [`warnIgnored`](#optionswarnignored)
 
+**Other options**
+* [`flags`][other options]
+
 #### General Options
 
 ##### `options.configType`
@@ -431,5 +454,6 @@ The functions [`gulpESLintNew.result`](#gulpeslintnewresultaction) and [`gulpESL
 [gulp-eslint]: https://github.com/adametry/gulp-eslint
 [legacy linting options]: https://eslint.org/docs/v8.x/integrate/nodejs-api#linting
 [linting options]: https://eslint.org/docs/latest/integrate/nodejs-api#linting
-[npm badge]: https://img.shields.io/npm/v/gulp-eslint-new?logo=npm
 [npm URL]: https://www.npmjs.com/package/gulp-eslint-new
+[npm badge]: https://img.shields.io/npm/v/gulp-eslint-new?logo=npm
+[other options]: https://eslint.org/docs/latest/integrate/nodejs-api#other-options

package/lib/eslint.d.ts

@@ -1,51 +1,14 @@
-import type { ESLint, Linter, Rule } from 'eslint';
+import type { ESLint, Linter } from 'eslint';
 
-type ConfigData = Linter.Config;
+type ESLintrcOptions = ESLint.LegacyOptions;
 
-type ESLintOptions =
-Omit<
-    ESLint.Options,
-    | 'baseConfig'
-    | 'fixTypes'
-    | 'overrideConfig'
-    | 'overrideConfigFile'
-    | 'plugins'
-    | 'reportUnusedDisableDirectives'
-    | 'resolvePluginsRelativeTo'
-> &
-{
-    baseConfig?:                    Linter.Config | null | undefined;
-    fixTypes?:                      Rule.RuleMetaData['type'][] | null | undefined;
-    overrideConfig?:                Linter.Config | null | undefined;
-    overrideConfigFile?:            string | null | undefined;
-    plugins?:                       Record<string, ESLint.Plugin> | null | undefined;
-    reportUnusedDisableDirectives?: Linter.StringSeverity | null | undefined;
-    resolvePluginsRelativeTo?:      string | null | undefined;
-};
-
-type FlatConfig =
-Omit<Linter.FlatConfig, 'languageOptions'> &
-{
-    languageOptions?:   LanguageOptions;
-    name?:              string;
-};
+type FlatESLintOptions = ESLint.Options;
 
 type FormatterContext = ESLint.LintResultData & ResultsMeta;
 
 type FormatterFunction =
 (results: ESLint.LintResult[], context?: FormatterContext) => string | Promise<string>;
 
-type GlobalConf = boolean | 'off' | 'readable' | 'readonly' | 'writable' | 'writeable';
-
-interface LanguageOptions
-{
-    ecmaVersion?:   number | 'latest';
-    globals?:       Record<string, GlobalConf>;
-    parser?:        Linter.ParserModule;
-    parserOptions?: Linter.ParserOptions;
-    sourceType?:    'script' | 'module' | 'commonjs';
-}
-
 type LintMessage = Linter.LintMessage;
 
 type LintResult = ESLint.LintResult;
@@ -61,5 +24,3 @@ interface ResultsMeta
         maxWarnings: number;
     };
 }
-
-type Severity = Linter.Severity;

package/lib/gulp-eslint-new.d.ts

@@ -4,9 +4,9 @@ import 'node';
 
 type Awaitable<T = unknown> = T | Promise<T>;
 
-type FlatConfig     = eslint.FlatConfig;
-type ESLintOptions  = eslint.ESLintOptions;
-type LintMessage    = eslint.LintMessage;
+type ESLintrcOptions    = eslint.ESLintrcOptions;
+type FlatESLintOptions  = eslint.FlatESLintOptions;
+type LintMessage        = eslint.LintMessage;
 
 type LintResultStreamFunction<Type> =
 ((action: (value: Type, callback: TransformCallback) => void) => NodeJS.ReadWriteStream) &
@@ -14,6 +14,16 @@ type LintResultStreamFunction<Type> =
 
 declare namespace gulpESLintNew
 {
+    interface AdditionalOptions
+    {
+        quiet?:
+        | boolean
+        | ((message: LintMessage, index: number, list: LintMessage[]) => unknown)
+        | undefined;
+
+        warnIgnored?: boolean | undefined;
+    }
+
     type FormatterContext = eslint.FormatterContext;
 
     type FormatterFunction = eslint.FormatterFunction;
@@ -26,7 +36,7 @@ declare namespace gulpESLintNew
          * @param options - Options for gulp-eslint-new.
          * @returns gulp file stream.
          */
-        (options?: GulpESLintOptions): NodeJS.ReadWriteStream;
+        (options?: GulpESLintNewOptions): NodeJS.ReadWriteStream;
 
         /**
          * Append ESLint result to each file.
@@ -42,7 +52,7 @@ declare namespace gulpESLintNew
          * @param action - A function to handle each ESLint result.
          * @returns gulp file stream.
          */
-        result: LintResultStreamFunction<GulpESLintResult>;
+        result: LintResultStreamFunction<LintResult>;
 
         /**
          * Handle all ESLint results at the end of the stream.
@@ -50,7 +60,7 @@ declare namespace gulpESLintNew
          * @param action - A function to handle all ESLint results.
          * @returns gulp file stream.
          */
-        results: LintResultStreamFunction<GulpESLintResults>;
+        results: LintResultStreamFunction<LintResults>;
 
         /**
          * Fail when an ESLint error is found in an ESLint result.
@@ -81,7 +91,7 @@ declare namespace gulpESLintNew
         formatEach
         (
             formatter?: string | LoadedFormatter | FormatterFunction,
-            writer?: GulpESLintWriter | NodeJS.WritableStream
+            writer?:    Writer | NodeJS.WritableStream
         ):
         NodeJS.ReadWriteStream;
 
@@ -100,7 +110,7 @@ declare namespace gulpESLintNew
         format
         (
             formatter?: string | LoadedFormatter | FormatterFunction,
-            writer?: GulpESLintWriter | NodeJS.WritableStream
+            writer?:    Writer | NodeJS.WritableStream
         ):
         NodeJS.ReadWriteStream;
 
@@ -112,82 +122,56 @@ declare namespace gulpESLintNew
         fix(): NodeJS.ReadWriteStream;
     }
 
-    type GulpESLintOptions =
-    (GulpESLintrcOptions & { configType?: 'eslintrc' | null | undefined; }) |
-    (GulpFlatESLintOptions & { configType: 'flat'; });
-
-    type GulpESLintResult = eslint.LintResult;
-
-    type GulpESLintResults
-    =
-    GulpESLintResult[] &
-    {
-        errorCount:          number;
-        fatalErrorCount:     number;
-        warningCount:        number;
-        fixableErrorCount:   number;
-        fixableWarningCount: number;
-    };
-
-    type GulpESLintWriter = (str: string) => Awaitable;
-
-    type GulpESLintrcOptions
+    type GulpESLintNewEslintrcOptions
     =
     Omit<
-        ESLintOptions,
+        ESLintrcOptions,
         | 'cache'
         | 'cacheLocation'
         | 'cacheStrategy'
         | 'errorOnUnmatchedPattern'
         | 'extensions'
         | 'globInputPaths'
-    > &
-    {
-        quiet?:
-        | boolean
-        | ((message: LintMessage, index: number, list: LintMessage[]) => unknown)
-        | undefined;
+    >
+    & AdditionalOptions;
 
-        warnIgnored?: boolean | undefined;
-    };
-
-    type GulpFlatESLintOptions
+    type GulpESLintNewFlatOptions
     =
-    Pick<
-        ESLintOptions,
-        | 'allowInlineConfig'
-        | 'cwd'
-        | 'fix'
-        | 'fixTypes'
-        | 'ignore'
-        | 'plugins'
-    > &
-    {
-        baseConfig?: FlatConfig | (string | FlatConfig)[] | null | undefined;
-
-        ignorePatterns?: string[] | null | undefined;
-
-        overrideConfig?: FlatConfig | (string | FlatConfig)[] | null | undefined;
-
-        overrideConfigFile?: string | true | null | undefined;
-
-        quiet?:
-        | boolean
-        | ((message: LintMessage, index: number, list: LintMessage[]) => unknown)
-        | undefined;
+    Omit<
+        FlatESLintOptions,
+        | 'cache'
+        | 'cacheLocation'
+        | 'cacheStrategy'
+        | 'errorOnUnmatchedPattern'
+        | 'globInputPaths'
+        | 'passOnNoPatterns'
+    >
+    & AdditionalOptions;
 
-        ruleFilter?: ((rule: { ruleId: string; severity: Severity; }) => unknown) | undefined;
+    type GulpESLintNewOptions =
+    |
+    ((GulpESLintNewEslintrcOptions | GulpESLintNewFlatOptions) & { configType?: null | undefined; })
+    | (GulpESLintNewEslintrcOptions & { configType: 'eslintrc'; })
+    | (GulpESLintNewFlatOptions & { configType: 'flat'; });
 
-        stats?: boolean | undefined;
+    type LintResult = eslint.LintResult;
 
-        warnIgnored?: boolean | undefined;
+    type LintResults
+    =
+    LintResult[] &
+    {
+        errorCount:          number;
+        fatalErrorCount:     number;
+        warningCount:        number;
+        fixableErrorCount:   number;
+        fixableWarningCount: number;
     };
 
     type LoadedFormatter = eslint.LoadedFormatter;
 
     type ResultsMeta = eslint.ResultsMeta;
 
-    type Severity = eslint.Severity;
+    type Writer = (str: string) => Awaitable;
 }
 
 declare const gulpESLintNew: gulpESLintNew.GulpESLintNew;

package/lib/util.js

@@ -1,19 +1,12 @@
 'use strict';
 
 /**
- * @typedef {import('eslint').ESLint}                       ESLint
- * @typedef {import('./gulp-eslint-new').GulpESLintWriter}  GulpESLintWriter
- * @typedef {import('./eslint').LintMessage}                LintMessage
- * @typedef {import('./eslint').LintResult}                 LintResult
- * @typedef {import('./eslint').LintResultData}             LintResultData
- * @typedef {import('./eslint').LoadedFormatter}            LoadedFormatter
- */
-
-/**
- * @callback FormatterFunction
- * @param {LintResult[]} results
- * @param {LintResultData} [data]
- * @returns {string | Promise<string>}
+ * @typedef {import('eslint').ESLint}               ESLint
+ * @typedef {import('./eslint').FormatterFunction}  FormatterFunction
+ * @typedef {import('./eslint').LintMessage}        LintMessage
+ * @typedef {import('./eslint').LintResult}         LintResult
+ * @typedef {import('./eslint').LoadedFormatter}    LoadedFormatter
+ * @typedef {import('./gulp-eslint-new').Writer}    Writer
  */
 
 const { normalize, relative }   = require('path');
@@ -449,9 +442,9 @@ async ({ cwd, eslint }, formatter) =>
 /**
  * Resolve a writer function used to write formatted ESLint messages.
  *
- * @param {GulpESLintWriter | NodeJS.WritableStream} [writer=require('fancy-log')]
+ * @param {Writer | NodeJS.WritableStream} [writer=require('fancy-log')]
  * A stream or function to resolve as a format writer.
- * @returns {GulpESLintWriter} A function that writes formatted messages.
+ * @returns {Writer} A function that writes formatted messages.
  */
 exports.resolveWriter =
 (writer = require('fancy-log')) =>
@@ -474,7 +467,7 @@ exports.resolveWriter =
  * @param {LoadedFormatter} formatterObj
  * A formatter object.
  *
- * @param {GulpESLintWriter} [writer]
+ * @param {Writer} [writer]
  * A function used to write formatted ESLint messages.
  */
 exports.writeResults =

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "gulp-eslint-new",
-  "version": "2.1.0",
+  "version": "2.3.0",
   "description": "A gulp plugin to lint code with ESLint 8 and 9.",
   "keywords": [
     "gulpplugin",
@@ -23,6 +23,7 @@
   "files": [
     "lib"
   ],
+  "main": "lib/gulp-eslint-new.js",
   "directories": {
     "example": "example",
     "lib": "lib",
@@ -41,19 +42,19 @@
     "ts-test": "tsc --project test/tsconfig.json"
   },
   "dependencies": {
-    "@types/eslint": "^8.56.10",
+    "@types/eslint": "^9.6.0",
     "@types/node": ">=12",
     "eslint": "8 || 9",
     "fancy-log": "^2.0.0",
     "plugin-error": "^2.0.1",
-    "semver": "^7.6.2",
+    "semver": "^7.6.3",
     "ternary-stream": "^3.0.0",
     "vinyl-fs": "^4.0.0"
   },
   "devDependencies": {
     "@eslint/js": "^8.57.0",
-    "@origin-1/eslint-config": "^1.3.0",
-    "c8js": "^0.7.0",
+    "@origin-1/eslint-config": "^1.6.1",
+    "c8js": "^0.8.0",
     "eslint-8.0": "npm:eslint@8.0",
     "eslint-8.21": "npm:eslint@8.21",
     "eslint-8.x": "npm:eslint@8.x",
@@ -62,10 +63,11 @@
     "eslint-formatter-~formatter": "file:test/formatter",
     "eslint-formatter-compact": "^8.40.0",
     "eslint-plugin-tsdoc": "^0.3.0",
-    "globals": "^15.4.0",
+    "globals": "^15.9.0",
     "gulp": "^5.0.0",
     "mocha": "^9.2.2",
-    "typescript": "~5.4.5",
+    "resolve": "^1.22.8",
+    "typescript": "~5.5.4",
     "typescript_4.6": "npm:typescript@4.6",
     "typescript_5": "npm:typescript@5",
     "vinyl": "^3.0.0"