gulp-eslint-new 2.0.0 → 2.2.0

package/README.md

@@ -5,7 +5,7 @@
 ## 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/latest/use/getting-started#prerequisites).
+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).
 For TypeScript support, you need TypeScript 4.6 or later.
 
 To install gulp-eslint-new, [use](https://docs.npmjs.com/cli/install) [npm](https://docs.npmjs.com/about-npm):
@@ -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`
@@ -363,11 +386,11 @@ If this argument is `undefined`, a modified version of the ESLint "stylish" form
 // Use the default gulp-eslint-new formatter.
 gulpESLintNew.format()
 
-// Use the "checkstyle" ESLint formatter.
-gulpESLintNew.format('checkstyle')
+// Use the "html" ESLint formatter.
+gulpESLintNew.format('html')
 
 // Use "eslint-formatter-pretty" as a formatter (must be installed with `npm`).
-// See https://github.com/sindresorhus/eslint-formatter-pretty.
+// See https://www.npmjs.com/package/eslint-formatter-pretty.
 gulpESLintNew.format('pretty')
 ```
 
@@ -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

@@ -16,6 +16,7 @@ Omit<
 {
     baseConfig?:                    Linter.Config | null | undefined;
     fixTypes?:                      Rule.RuleMetaData['type'][] | null | undefined;
+    flags?:                         string[] | undefined;
     overrideConfig?:                Linter.Config | null | undefined;
     overrideConfigFile?:            string | null | undefined;
     plugins?:                       Record<string, ESLint.Plugin> | null | undefined;

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

@@ -1,6 +1,6 @@
+import type { TransformCallback }   from 'node:stream';
 import type * as eslint             from './eslint';
 import 'node';
-import type { TransformCallback }   from 'stream';
 
 type Awaitable<T = unknown> = T | Promise<T>;
 
@@ -113,8 +113,9 @@ declare namespace gulpESLintNew
     }
 
     type GulpESLintOptions =
-    (GulpESLintrcOptions & { configType?: 'eslintrc' | null | undefined; }) |
-    (GulpFlatESLintOptions & { configType: 'flat'; });
+    | ((GulpESLintrcOptions | GulpFlatESLintOptions) & { configType?: null | undefined; })
+    | (GulpESLintrcOptions & { configType: 'eslintrc'; })
+    | (GulpFlatESLintOptions & { configType: 'flat'; });
 
     type GulpESLintResult = eslint.LintResult;
 
@@ -159,6 +160,7 @@ declare namespace gulpESLintNew
         | 'cwd'
         | 'fix'
         | 'fixTypes'
+        | 'flags'
         | 'ignore'
         | 'plugins'
     > &

package/lib/util.js

@@ -122,29 +122,44 @@ exports.createIgnoreResult =
 {
     const { ltr } = require('semver');
     let message;
-    const useEslintrcConfig = isEslintrcESLintConstructor(eslintConstructor);
     const relativePath = relative(baseDir, filePath);
-    const eslintVersion = eslintConstructor.version;
-    if (useEslintrcConfig && isHiddenRegExp.test(relativePath))
+    if (isEslintrcESLintConstructor(eslintConstructor))
     {
-        message =
-        'File ignored by default. Use a negated ignore pattern (like ' +
-        '"!<relative/path/to/filename>") to override.';
-    }
-    else if (isInNodeModulesRegExp.test(relativePath))
-    {
-        message =
-        useEslintrcConfig || ltr(eslintVersion, '8.41') ?
-        'File ignored by default. Use a negated ignore pattern like "!node_modules/*" to ' +
-        'override.' :
-        'File ignored by default because it is located under the node_modules directory. Use ' +
-        'ignore pattern "!**/node_modules/" to override.';
+        if (isHiddenRegExp.test(relativePath))
+        {
+            message =
+            'File ignored by default. Use a negated ignore pattern (like ' +
+            '"!<relative/path/to/filename>") to override.';
+        }
+        else if (isInNodeModulesRegExp.test(relativePath))
+        {
+            message =
+            'File ignored by default. Use a negated ignore pattern like "!**/node_modules/*" to ' +
+            'override.';
+        }
+        else
+        {
+            message =
+            'File ignored because of a matching ignore pattern. Set "ignore" option to false to ' +
+            'override.';
+        }
     }
     else
     {
-        message =
-        'File ignored because of a matching ignore pattern. Set "ignore" option to false to ' +
-        'override.';
+        if (relativePath.startsWith('..'))
+            message = 'File ignored because outside of base path.';
+        else if (isInNodeModulesRegExp.test(relativePath))
+        {
+            message =
+            'File ignored by default because it is located under the node_modules directory. Use ' +
+            'ignore pattern "!**/node_modules/**" to override.';
+        }
+        else
+        {
+            message =
+            'File ignored. If this file is matched by a global ignore pattern, it can be ' +
+            'unignored by setting the "ignore" option to false.';
+        }
     }
     const result =
     {
@@ -156,7 +171,7 @@ exports.createIgnoreResult =
         fixableWarningCount:    0,
         fatalErrorCount:        0,
     };
-    if (!ltr(eslintVersion, '8.8'))
+    if (!ltr(eslintConstructor.version, '8.8'))
         result.suppressedMessages = [];
     return result;
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "gulp-eslint-new",
-  "version": "2.0.0",
+  "version": "2.2.0",
   "description": "A gulp plugin to lint code with ESLint 8 and 9.",
   "keywords": [
     "gulpplugin",
@@ -36,35 +36,36 @@
     "build": "npm install && gulp",
     "coverage": "gulp test",
     "lint": "eslint . --format compact",
+    "release": "git add CHANGELOG.md && npm version -f",
     "test": "mocha --check-leaks test/*.spec.js",
-    "ts-test": "tsc --project test/tsconfig.json",
-    "version": "git add CHANGELOG.md"
+    "ts-test": "tsc --project test/tsconfig.json"
   },
   "dependencies": {
-    "@types/eslint": "^8.56.7",
+    "@types/eslint": "^8.56.10",
     "@types/node": ">=12",
     "eslint": "8 || 9",
     "fancy-log": "^2.0.0",
     "plugin-error": "^2.0.1",
-    "semver": "^7.6.0",
+    "semver": "^7.6.2",
     "ternary-stream": "^3.0.0",
     "vinyl-fs": "^4.0.0"
   },
   "devDependencies": {
     "@eslint/js": "^8.57.0",
-    "@origin-1/eslint-config": "^0.23.0",
-    "c8js": "^0.6.2",
+    "@origin-1/eslint-config": "^1.4.0",
+    "c8js": "^0.7.0",
     "eslint-8.0": "npm:eslint@8.0",
     "eslint-8.21": "npm:eslint@8.21",
     "eslint-8.x": "npm:eslint@8.x",
     "eslint-9.x": "npm:eslint@9.x",
     "eslint-config-~shareable": "file:test/config",
     "eslint-formatter-~formatter": "file:test/formatter",
-    "eslint-plugin-tsdoc": "^0.2.17",
-    "globals": "^15.0.0",
+    "eslint-formatter-compact": "^8.40.0",
+    "eslint-plugin-tsdoc": "^0.3.0",
+    "globals": "^15.8.0",
     "gulp": "^5.0.0",
     "mocha": "^9.2.2",
-    "typescript": "~5.4.4",
+    "typescript": "~5.5.3",
     "typescript_4.6": "npm:typescript@4.6",
     "typescript_5": "npm:typescript@5",
     "vinyl": "^3.0.0"