gulp-eslint-new 2.5.0 → 2.6.1

package/README.md

@@ -1,11 +1,11 @@
 # gulp-eslint-new · [![npm version][npm badge]][npm URL]
 
-> A [gulp](https://gulpjs.com/) plugin to lint code with [ESLint](https://eslint.org/) 8 and 9.
+> A [gulp](https://gulpjs.com/) plugin to lint code with [ESLint](https://eslint.org/) 8, 9, and 10.
 
 ## Installation
 
 Make sure that you are using a version of Node.js supported by your version of ESLint.
-See prerequisites for [ESLint 8](https://eslint.org/docs/v8.x/use/getting-started#prerequisites) and [ESLint 9](https://eslint.org/docs/v9.x/use/getting-started#prerequisites).
+See prerequisites for [ESLint 8](https://eslint.org/docs/v8.x/use/getting-started#prerequisites), [ESLint 9](https://eslint.org/docs/v9.x/use/getting-started#prerequisites), or [ESLint 10](https://eslint.org/docs/v10.x/use/getting-started#prerequisites).
 For TypeScript support, you need TypeScript 4.8 or later.
 
 To install gulp-eslint-new, [use](https://docs.npmjs.com/cli/install) [npm](https://docs.npmjs.com/about-npm):
@@ -14,12 +14,12 @@ To install gulp-eslint-new, [use](https://docs.npmjs.com/cli/install) [npm](http
 npm i -D gulp-eslint-new
 ```
 
-gulp-eslint-new will also install the latest version of ESLint 9, unless another one is found.
+gulp-eslint-new will also install the latest version of ESLint 10, unless another one is found.
 To use a particular version of ESLint, install it by yourself.
-For example, to use ESLint 8.8.0:
+For example, to use ESLint 8.57.1:
 
 ```console
-npm i -D gulp-eslint-new eslint@8.8.0
+npm i -D gulp-eslint-new eslint@8.57.1
 ```
 
 ## Migrating
@@ -27,11 +27,12 @@ npm i -D gulp-eslint-new eslint@8.8.0
 If you are migrating from [gulp-eslint][gulp-eslint], you probably won't need to make any substantial changes to your gulp task, as the API is widely compatible.
 Note though that many options have changed: the current options are documented in the [`gulpESLintNew(options)`](#gulpeslintnewoptions) section.
 
-Also note that gulp-eslint-new is designed to work with ESLint 8 or 9, whereas the latest release of gulp-eslint only supports ESLint 6: you will need to update your project to address breaking changes in ESLint.
+Also note that gulp-eslint-new is designed to work with ESLint 8, 9 or 10, whereas the latest release of gulp-eslint only supports ESLint 6: you will need to update your project to address breaking changes in ESLint.
 You can follow the links below for more information.
 * [Breaking changes for users from ESLint 6 to ESLint 7](https://eslint.org/docs/user-guide/migrating-to-7.0.0#breaking-changes-for-users)
 * [Breaking changes for users from ESLint 7 to ESLint 8](https://eslint.org/docs/user-guide/migrate-to-8.0.0#breaking-changes-for-users)
 * [Breaking changes for users from ESLint 8 to ESLint 9](https://eslint.org/docs/user-guide/migrate-to-9.0.0#breaking-changes-for-users)
+* [Breaking changes for users from ESLint 9 to ESLint 10](https://eslint.org/docs/user-guide/migrate-to-10.0.0#breaking-changes-for-users)
 
 
 ## Usage
@@ -149,15 +150,13 @@ See the linked content for details about each option.
 
 Type: `"eslintrc" | "flat" | null`
 
-ESLint supports two types of configuration: a [new config](https://eslint.org/docs/user-guide/configure/configuration-files) type, aka flat config, based on file `eslint.config.*`, and a [legacy config](https://eslint.org/docs/user-guide/configure/configuration-files-deprecated) type, or eslintrc config, based on file `.eslintrc`.
+ESLint supports two configuration formats: a [new config](https://eslint.org/docs/user-guide/configure/configuration-files) type, aka flat config, based on file `eslint.config.*`, and a [legacy config](https://eslint.org/docs/v9.x/use/configure/configuration-files-deprecated) type, or eslintrc config, based on file `.eslintrc`.
 
-In ESLint 8, the default config type is the legacy config, and the new config is partly supported depending on the version of ESLint used.
-To use the the new config with ESLint 8 in gulp-eslint-new, set the option `configType` to `"flat"`.
+* **ESLint 8**: Uses the legacy config by default. Flat config is partially supported depending on the version. In gulp-eslint-new, set `configType: "flat"` to enable flat config.
+* **ESLint 9**: Uses flat config by default. To use legacy config in gulp-eslint-new, set `configType: "eslintrc"`.  
+* **ESLint 10**: Only supports flat config. Setting `configType: "eslintrc"` in gulp-eslint-new will result in an error.
 
-ESLint 9 uses the new config type by default.
-To use the legacy config with ESLint 9 in gulp-eslint-new, set the option `configType` to `"eslintrc"`.
-
-The new and legacy config types differ significantly in the available options and their usage.
+The new and legacy config formats differ significantly in the available options and their usage.
 Refer to the respective documentation in ESLint for the specifics of each options.
 
 ##### `options.cwd`

package/lib/eslint.d.ts

@@ -1,6 +1,40 @@
 import type { ESLint, Linter } from 'eslint';
 
-type ESLintrcOptions    = ESLint.LegacyOptions;
+interface ESLintrcOptions
+{
+    // File enumeration
+    cwd?:                           string | undefined;
+    errorOnUnmatchedPattern?:       boolean | undefined;
+    extensions?:                    string[] | undefined;
+    globInputPaths?:                boolean | undefined;
+    ignore?:                        boolean | undefined;
+    ignorePath?:                    string | undefined;
+
+    // Linting
+    allowInlineConfig?:             boolean | undefined;
+    baseConfig?:                    Linter.LegacyConfig | undefined;
+    overrideConfig?:                Linter.LegacyConfig | undefined;
+    overrideConfigFile?:            string | undefined;
+    plugins?:                       Record<string, ESLint.Plugin> | undefined;
+    reportUnusedDisableDirectives?: Linter.StringSeverity | undefined;
+    resolvePluginsRelativeTo?:      string | undefined;
+    rulePaths?:                     string[] | undefined;
+    useEslintrc?:                   boolean | undefined;
+
+    // Autofix
+    fix?:
+    boolean | ((message: Linter.LintMessage) => boolean) | undefined;
+    fixTypes?:                      FixType[] | null | undefined;
+
+    // Caching
+    cache?:                         boolean | undefined;
+    cacheLocation?:                 string | undefined;
+    cacheStrategy?:                 ESLint.CacheStrategy | undefined;
+
+    // Unused
+    flags?:                         string[] | undefined;
+}
+
 type FlatESLintOptions  = ESLint.Options;
 type FormatterFunction  = ESLint.FormatterFunction;
 type LintMessage        = Linter.LintMessage;

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

@@ -92,7 +92,7 @@ declare namespace gulpESLintNew
         formatEach
         (
             formatter?: string | LoadedFormatter | FormatterFunction,
-            writer?:    Writer | NodeJS.WritableStream
+            writer?:    Writer | NodeJS.WritableStream,
         ):
         NodeJS.ReadWriteStream;
 
@@ -111,7 +111,7 @@ declare namespace gulpESLintNew
         format
         (
             formatter?: string | LoadedFormatter | FormatterFunction,
-            writer?:    Writer | NodeJS.WritableStream
+            writer?:    Writer | NodeJS.WritableStream,
         ):
         NodeJS.ReadWriteStream;
 

package/lib/util.js

@@ -259,6 +259,8 @@ exports.hasOwn = hasOwn;
 
 exports.isErrorMessage = isErrorMessage;
 
+exports.isEslintrcESLintConstructor = isEslintrcESLintConstructor;
+
 exports.isWarningMessage = isWarningMessage;
 
 const makeNPMLink =
@@ -286,21 +288,35 @@ const FORBIDDEN_OPTIONS =
 
 const requireESLint = eslintPkg => require(eslintPkg).ESLint;
 
+function requireEslintrcESLint(eslintPkg)
+{
+    const { LegacyESLint } = require(`${eslintPkg}/use-at-your-own-risk`);
+    if (LegacyESLint) return LegacyESLint;
+
+    const { satisfies } = require('semver');
+    const { ESLint } = require(eslintPkg);
+    if (satisfies(ESLint.version, '8')) return ESLint;
+
+    const message =
+    'The version of ESLint you are using does not support eslintrc config. ' +
+    'Eslintrc config is not available in ESLint 10.';
+    throw Error(message);
+}
+
 function requireFlatESLint(eslintPkg)
 {
     const { FlatESLint } = require(`${eslintPkg}/use-at-your-own-risk`);
-    if (FlatESLint == null)
-    {
-        const message =
-        'The version of ESLint you are using does not support flat config. ' +
-        'To use flat config, upgrade to ESLint 8.21 or later.';
-        throw Error(message);
-    }
-    return FlatESLint;
-}
+    if (FlatESLint) return FlatESLint;
 
-const requireEslintrcESLint =
-eslintPkg => require(`${eslintPkg}/use-at-your-own-risk`).LegacyESLint || require(eslintPkg).ESLint;
+    const { satisfies } = require('semver');
+    const { ESLint } = require(eslintPkg);
+    if (!satisfies(ESLint.version, '8')) return ESLint;
+
+    const message =
+    'The version of ESLint you are using does not support flat config. ' +
+    'Flat config is available in ESLint 8.21 or later.';
+    throw Error(message);
+}
 
 /**
  * Throws an error about invalid options passed to gulp-eslint-new.
@@ -402,15 +418,23 @@ async ({ cwd, eslint }, formatter) =>
     if (formatter === undefined)
     {
         const { format } = await eslint.loadFormatter();
-        return {
-            format: results =>
-            format(results)
-            .replace
-            (
-                / with the `--fix` option\.(?=(\u001b\[\d+m|\n)+$)/,
-                ` - see ${makeNPMLink('autofix')}`,
-            ),
+        const formatterObj =
+        {
+            format:
+            results =>
+            {
+                const stylishText = format(results);
+                const text =
+                stylishText
+                .replace
+                (
+                    / with the `--fix` option\.(?=(\u001b\[\d+m|\n)+$)/,
+                    ` - see ${makeNPMLink('autofix')}`,
+                );
+                return text;
+            },
         };
+        return formatterObj;
     }
     if (isObject(formatter) && typeof formatter.format === 'function')
         return formatter;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "gulp-eslint-new",
-  "version": "2.5.0",
-  "description": "A gulp plugin to lint code with ESLint 8 and 9.",
+  "version": "2.6.1",
+  "description": "A gulp plugin to lint code with ESLint 8, 9 and 10.",
   "keywords": [
     "gulpplugin",
     "eslint",
@@ -42,18 +42,19 @@
     "ts-test": "tsc --project test/tsconfig.json"
   },
   "dependencies": {
-    "eslint": "8 || 9",
+    "eslint": "8 || 9 || 10",
     "fancy-log": "^2.0.0",
     "plugin-error": "^2.0.1",
-    "semver": "^7.7.2",
+    "semver": "^7.7.3",
     "ternary-stream": "^3.0.0",
     "vinyl-fs": "^4.0.2"
   },
   "devDependencies": {
     "@eslint/js": "^8.57.1",
-    "@origin-1/eslint-config": "^1.12.1",
+    "@origin-1/eslint-config": "^1.14.0",
     "@types/eslint__js": "^8.42.3",
     "c8js": "^0.8.1",
+    "eslint-10.0": "npm:eslint@10.0.0",
     "eslint-8.0": "npm:eslint@8.0",
     "eslint-8.21": "npm:eslint@8.21",
     "eslint-8.x": "npm:eslint@8.x",
@@ -61,14 +62,14 @@
     "eslint-9.x": "npm:eslint@9.x",
     "eslint-config-~shareable": "file:test/config",
     "eslint-formatter-~formatter": "file:test/formatter",
-    "eslint-formatter-compact": "^8.40.0",
-    "eslint-plugin-tsdoc": "^0.4.0",
-    "globals": "^16.3.0",
+    "eslint-formatter-compact": "^9.0.1",
+    "eslint-plugin-tsdoc": "^0.5.0",
+    "globals": "^17.3.0",
     "gulp": "^5.0.1",
-    "jiti": "^2.5.1",
+    "jiti": "^2.6.1",
     "mocha": "^9.2.2",
-    "resolve": "^1.22.10",
-    "typescript": "~5.9.2",
+    "resolve": "^1.22.11",
+    "typescript": "~5.9.3",
     "typescript_4.8": "npm:typescript@4.8",
     "typescript_5": "npm:typescript@5",
     "vinyl": "^3.0.1"