Switch to flat config

origin-1 · Dec 30, 2023 · 5dc9f2d · 5dc9f2d
1 parent 93a4746
commit 5dc9f2d
Show file tree

Hide file tree

Showing 6 changed files with 54 additions and 40 deletions.
diff --git a/.eslintrc.js b/.eslintrc.js
diff --git a/eslint.config.js b/eslint.config.js
@@ -0,0 +1,43 @@
+'use strict';
+
+const { createFlatConfig }          = require('@origin-1/eslint-config');
+const eslintPluginEslintComments    = require('eslint-plugin-eslint-comments');
+const eslintPluginTsdoc             = require('eslint-plugin-tsdoc');
+const globals                       = require('globals');
+
+module.exports =
+createFlatConfig
+(
+    {
+        ignores: ['**/.*', 'coverage', 'example/demo'],
+    },
+    {
+        files:              ['**/*.js'],
+        jsVersion:          2020,
+        languageOptions:    { sourceType: 'script' },
+    },
+    {
+        files:              ['test/*.spec.js'],
+        languageOptions:    { globals: globals.mocha },
+    },
+    {
+        files:              ['**/*.ts'],
+        tsVersion:          '4.2.0',
+        languageOptions:    { parserOptions: { project: 'tsconfig.json' } },
+        plugins:            { 'tsdoc': eslintPluginTsdoc },
+        rules:              { 'tsdoc/syntax': 'error' },
+    },
+    {
+        languageOptions:    { globals: globals.node },
+        plugins:            { 'eslint-comments': eslintPluginEslintComments },
+        rules:
+        {
+            'no-throw-literal':                         'off',
+            'eslint-comments/disable-enable-pair':      'error',
+            'eslint-comments/no-aggregating-enable':    'error',
+            'eslint-comments/no-duplicate-disable':     'error',
+            'eslint-comments/no-unlimited-disable':     'error',
+            'eslint-comments/no-unused-enable':         'error',
+        },
+    },
+);
diff --git a/gulpfile.js b/gulpfile.js
@@ -22,8 +22,8 @@ task
         const gulpESLintNew = require('gulp-eslint-new');
 
         const stream =
-        src(['.eslintrc.js', '*.js', 'example/*.js', 'lib/*.{js,ts}', 'test/**/*.{js,ts}'])
-        .pipe(gulpESLintNew({ warnIgnored: true }))
+        src(['*.js', 'example/*.js', 'lib/*.{js,ts}', 'test/**/*.{js,ts}'])
+        .pipe(gulpESLintNew({ configType: 'flat', warnIgnored: true }))
         .pipe(gulpESLintNew.format('compact'))
         .pipe(gulpESLintNew.failAfterError());
         return stream;

diff --git a/test/fixtures/eslint.config.js b/test/fixtures/eslint.config.js
@@ -1 +1,3 @@
+'use strict';
+
 module.exports = { };
diff --git a/test/linting.spec.js b/test/linting.spec.js
@@ -12,7 +12,7 @@ const gulpESLintNew                 = require('gulp-eslint-new');
 const { join, resolve }             = require('path');
 const { satisfies }                 = require('semver');
 const { Readable }                  = require('stream');
-const File                          = require('vinyl');
+const VinylFile                     = require('vinyl');
 
 async function testConfig(options)
 {
@@ -788,13 +788,11 @@ describe
             'should emit an error when it takes a stream content',
             async () =>
             {
+                const file =
+                new VinylFile({ path: resolve('stream.js'), contents: Readable.from([]) });
                 await assert.rejects
                 (
-                    finished
-                    (
-                        gulpESLintNew({ useEslintrc: false })
-                        .end(new File({ path: resolve('stream.js'), contents: Readable.from([]) })),
-                    ),
+                    finished(gulpESLintNew({ useEslintrc: false }).end(file)),
                     {
                         message:
                         'gulp-eslint-new doesn\'t support Vinyl files with Stream contents.',

diff --git a/test/test-util.js b/test/test-util.js
@@ -3,19 +3,19 @@
 const { resolve }   = require('path');
 const { finished }  = require('stream');
 const { promisify } = require('util');
-const File          = require('vinyl');
+const VinylFile     = require('vinyl');
 
 exports.createVinylDirectory =
 () =>
 {
-    const directory = new File({ path: process.cwd(), contents: null, isDirectory: true });
+    const directory = new VinylFile({ path: process.cwd(), contents: null, isDirectory: true });
     return directory;
 };
 
 exports.createVinylFile =
 (path, contents) =>
 {
-    const file = new File({ path: resolve(path), contents: Buffer.from(contents) });
+    const file = new VinylFile({ path: resolve(path), contents: Buffer.from(contents) });
     return file;
 };