@darksheep/eslint 5.3.0 → 5.3.1

package/src/plugins/jsdoc.js

@@ -9,64 +9,64 @@ import { getPackageJson } from '../utilities/package.js';
  * @returns {Promise<import('eslint').Linter.FlatConfig[]>}
  */
 export async function createEslintJSDocConfig(root) {
-    const tsPackage = await getPackageJson(root, 'typescript');
-    const typeChecks = tsPackage == null ? 'warn' : 'off';
+  const tsPackage = await getPackageJson(root, 'typescript');
+  const typeChecks = tsPackage == null ? 'warn' : 'off';
 
-    return [
-        {
-            name: 'jsdoc/javascript',
-            plugins: { jsdoc },
-            settings: {
-                jsdoc: {
-                    mode: 'typescript',
-                    // Prefer 'Object' over 'object'
-                    preferredTypes: { object: 'Object' },
-                },
-            },
-            rules: {
-                'jsdoc/check-access': 'warn',
-                'jsdoc/check-alignment': 'warn',
-                'jsdoc/check-param-names': 'warn',
-                'jsdoc/check-property-names': 'warn',
-                'jsdoc/check-tag-names': 'warn',
-                'jsdoc/check-values': 'warn',
-                'jsdoc/empty-tags': 'warn',
-                'jsdoc/implements-on-classes': 'error',
-                'jsdoc/informative-docs': 'warn',
-                'jsdoc/no-defaults': 'warn',
-                'jsdoc/no-multi-asterisks': 'warn',
-                'jsdoc/require-jsdoc': [ 1, { publicOnly: true } ],
-                'jsdoc/require-param': 'warn',
-                'jsdoc/require-param-description': 'warn',
-                'jsdoc/require-param-name': 'warn',
-                'jsdoc/require-param-type': 'warn',
-                'jsdoc/require-property': 'warn',
-                'jsdoc/require-property-description': 'warn',
-                'jsdoc/require-property-name': 'warn',
-                'jsdoc/require-property-type': 'warn',
-                'jsdoc/require-returns': 'warn',
-                'jsdoc/require-returns-check': 'warn',
-                'jsdoc/require-returns-type': 'warn',
-
-                'jsdoc/check-types': typeChecks,
-                'jsdoc/no-undefined-types': typeChecks,
-                'jsdoc/valid-types': typeChecks,
-            },
+  return [
+    {
+      name: 'jsdoc/javascript',
+      plugins: { jsdoc },
+      settings: {
+        jsdoc: {
+          mode: 'typescript',
+          // Prefer 'Object' over 'object'
+          preferredTypes: { object: 'Object' },
         },
-        {
-            name: 'jsdoc/typescript',
-            files: getTypescriptFiles(),
-            rules: {
-                'jsdoc/no-types': 'warn',
-                'jsdoc/check-types': 'off',
-                'jsdoc/no-undefined-types': 'off',
-                'jsdoc/valid-types': 'off',
-                'jsdoc/require-returns': 'off',
-                'jsdoc/require-param-type': 'off',
-                'jsdoc/require-property-type': 'off',
-                'jsdoc/require-returns-type': 'off',
+      },
+      rules: {
+        'jsdoc/check-access': 'warn',
+        'jsdoc/check-alignment': 'warn',
+        'jsdoc/check-param-names': 'warn',
+        'jsdoc/check-property-names': 'warn',
+        'jsdoc/check-tag-names': 'warn',
+        'jsdoc/check-values': 'warn',
+        'jsdoc/empty-tags': 'warn',
+        'jsdoc/implements-on-classes': 'error',
+        'jsdoc/informative-docs': 'warn',
+        'jsdoc/no-defaults': 'warn',
+        'jsdoc/no-multi-asterisks': 'warn',
+        'jsdoc/require-jsdoc': [ 1, { publicOnly: true } ],
+        'jsdoc/require-param': 'warn',
+        'jsdoc/require-param-description': 'warn',
+        'jsdoc/require-param-name': 'warn',
+        'jsdoc/require-param-type': 'warn',
+        'jsdoc/require-property': 'warn',
+        'jsdoc/require-property-description': 'warn',
+        'jsdoc/require-property-name': 'warn',
+        'jsdoc/require-property-type': 'warn',
+        'jsdoc/require-returns': 'warn',
+        'jsdoc/require-returns-check': 'warn',
+        'jsdoc/require-returns-type': 'warn',
 
-            },
-        },
-    ];
+        'jsdoc/check-types': typeChecks,
+        'jsdoc/no-undefined-types': typeChecks,
+        'jsdoc/valid-types': typeChecks,
+      },
+    },
+    {
+      name: 'jsdoc/typescript',
+      files: getTypescriptFiles(),
+      rules: {
+        'jsdoc/no-types': 'warn',
+        'jsdoc/check-types': 'off',
+        'jsdoc/no-undefined-types': 'off',
+        'jsdoc/valid-types': 'off',
+        'jsdoc/require-returns': 'off',
+        'jsdoc/require-param-type': 'off',
+        'jsdoc/require-property-type': 'off',
+        'jsdoc/require-returns-type': 'off',
+
+      },
+    },
+  ];
 }

package/src/plugins/json.js

@@ -6,47 +6,47 @@ import parser from 'jsonc-eslint-parser';
  * @returns {Promise<import('eslint').Linter.FlatConfig[]>}
  */
 export async function createEslintJsonConfig() {
-    return [
-        {
-            name: 'json/core',
-            files: [ '**/*.json', '**/*.jsonc', '**/*.json5' ],
-            languageOptions: { parser },
-            // @ts-expect-error jsonc does not match the plugin interface
-            plugins: { jsonc },
-            rules: {
-                'jsonc/array-bracket-newline': [ 'error', 'consistent' ],
-                'jsonc/array-bracket-spacing': [ 'error', 'always' ],
-                'jsonc/array-element-newline': [ 'error', 'consistent' ],
-                'jsonc/key-spacing': [ 'error' ],
-                'jsonc/object-curly-newline': [ 'error', { consistent: true } ],
-                'jsonc/object-curly-spacing': [ 'error', 'always' ],
-                'jsonc/object-property-newline': [ 'error', { allowAllPropertiesOnSameLine: true } ],
-                'max-lines': 'off',
-            },
-        },
-        {
-            name: 'json/.json',
-            files: [ '**/*.json' ],
-            // @ts-expect-error Record<string, string> vs Record<string, 'error'>
-            rules: jsonc.configs['recommended-with-json'].rules,
-        },
-        {
-            name: 'json/.jsonc',
-            files: [ '**/*.jsonc' ],
-            // @ts-expect-error Record<string, string> vs Record<string, 'error'>
-            rules: jsonc.configs['recommended-with-jsonc'].rules,
-        },
-        {
-            name: 'json/.json5',
-            files: [ '**/*.json5' ],
-            // @ts-expect-error Record<string, string> vs Record<string, 'error'>
-            rules: jsonc.configs['recommended-with-json5'].rules,
-        },
-        {
-            name: 'json/tsconfig.json',
-            files: [ '**/tsconfig.json' ],
-            rules: { 'jsonc/no-comments': 'off' },
-        },
-        { ignores: [ '.github/release-please/manifest.json' ] },
-    ];
+  return [
+    {
+      name: 'json/core',
+      files: [ '**/*.json', '**/*.jsonc', '**/*.json5' ],
+      languageOptions: { parser },
+      // @ts-expect-error jsonc does not match the plugin interface
+      plugins: { jsonc },
+      rules: {
+        'jsonc/array-bracket-newline': [ 'error', 'consistent' ],
+        'jsonc/array-bracket-spacing': [ 'error', 'always' ],
+        'jsonc/array-element-newline': [ 'error', 'consistent' ],
+        'jsonc/key-spacing': [ 'error' ],
+        'jsonc/object-curly-newline': [ 'error', { consistent: true } ],
+        'jsonc/object-curly-spacing': [ 'error', 'always' ],
+        'jsonc/object-property-newline': [ 'error', { allowAllPropertiesOnSameLine: true } ],
+        'max-lines': 'off',
+      },
+    },
+    {
+      name: 'json/.json',
+      files: [ '**/*.json' ],
+      // @ts-expect-error Record<string, string> vs Record<string, 'error'>
+      rules: jsonc.configs['recommended-with-json'].rules,
+    },
+    {
+      name: 'json/.jsonc',
+      files: [ '**/*.jsonc' ],
+      // @ts-expect-error Record<string, string> vs Record<string, 'error'>
+      rules: jsonc.configs['recommended-with-jsonc'].rules,
+    },
+    {
+      name: 'json/.json5',
+      files: [ '**/*.json5' ],
+      // @ts-expect-error Record<string, string> vs Record<string, 'error'>
+      rules: jsonc.configs['recommended-with-json5'].rules,
+    },
+    {
+      name: 'json/tsconfig.json',
+      files: [ '**/tsconfig.json' ],
+      rules: { 'jsonc/no-comments': 'off' },
+    },
+    { ignores: [ '.github/release-please/manifest.json' ] },
+  ];
 }

package/src/plugins/node.js

@@ -4,11 +4,11 @@ import { fileURLToPath } from 'node:url';
 import n from 'eslint-plugin-n';
 
 import {
-    getCommonFiles,
-    getExampleFiles,
-    getModuleFiles,
-    getTestFiles,
-    getTypescriptFiles,
+  getCommonFiles,
+  getExampleFiles,
+  getModuleFiles,
+  getTestFiles,
+  getTypescriptFiles,
 } from '../utilities/eslint-files.js';
 
 const script = n.configs['flat/recommended-script'];
@@ -16,44 +16,44 @@ const module = n.configs['flat/recommended-module'];
 
 /** @type {import('eslint').Linter.RulesRecord} */
 const commonRules = {
-    'n/no-new-require': 'error',
-    'n/no-mixed-requires': 'error',
-
-    'n/callback-return': 'error',
-    'n/handle-callback-err': 'error',
-    'n/no-process-exit': 'warn',
-    'n/no-process-env': 'warn',
-    'n/no-path-concat': 'error',
-
-    'n/no-callback-literal': 'off',
-    'n/no-exports-assign': 'off',
-
-    'n/global-require': [ 'error' ],
-    'n/no-unpublished-bin': 'error',
-    'n/no-unpublished-import': [ 'error', { ignoreTypeImport: true } ],
-    'n/no-unpublished-require': 'error',
-
-    'n/no-unsupported-features/es-builtins': 'error',
-    'n/no-unsupported-features/es-syntax': [ 'error', { ignores: [ 'modules' ] } ],
-    'n/no-unsupported-features/node-builtins': 'error',
-
-    'n/process-exit-as-throw': 'error',
-    'n/hashbang': 'error',
-
-    'n/no-deprecated-api': 'error',
-
-    'n/exports-style': [ 'error', 'module.exports' ],
-    'n/file-extension-in-import': [ 'error', 'always' ],
-
-    'n/prefer-global/buffer': [ 'warn', 'always' ],
-    'n/prefer-global/console': [ 'warn', 'always' ],
-    'n/prefer-global/process': [ 'warn', 'always' ],
-    'n/prefer-global/text-decoder': [ 'warn', 'never' ],
-    'n/prefer-global/text-encoder': [ 'warn', 'never' ],
-    'n/prefer-global/url-search-params': [ 'warn', 'never' ],
-    'n/prefer-global/url': [ 'warn', 'never' ],
-    'n/prefer-promises/dns': 'warn',
-    'n/prefer-promises/fs': 'warn',
+  'n/no-new-require': 'error',
+  'n/no-mixed-requires': 'error',
+
+  'n/callback-return': 'error',
+  'n/handle-callback-err': 'error',
+  'n/no-process-exit': 'warn',
+  'n/no-process-env': 'warn',
+  'n/no-path-concat': 'error',
+
+  'n/no-callback-literal': 'off',
+  'n/no-exports-assign': 'off',
+
+  'n/global-require': [ 'error' ],
+  'n/no-unpublished-bin': 'error',
+  'n/no-unpublished-import': [ 'error', { ignoreTypeImport: true } ],
+  'n/no-unpublished-require': 'error',
+
+  'n/no-unsupported-features/es-builtins': 'error',
+  'n/no-unsupported-features/es-syntax': [ 'error', { ignores: [ 'modules' ] } ],
+  'n/no-unsupported-features/node-builtins': 'error',
+
+  'n/process-exit-as-throw': 'error',
+  'n/hashbang': 'error',
+
+  'n/no-deprecated-api': 'error',
+
+  'n/exports-style': [ 'error', 'module.exports' ],
+  'n/file-extension-in-import': [ 'error', 'always' ],
+
+  'n/prefer-global/buffer': [ 'warn', 'always' ],
+  'n/prefer-global/console': [ 'warn', 'always' ],
+  'n/prefer-global/process': [ 'warn', 'always' ],
+  'n/prefer-global/text-decoder': [ 'warn', 'never' ],
+  'n/prefer-global/text-encoder': [ 'warn', 'never' ],
+  'n/prefer-global/url-search-params': [ 'warn', 'never' ],
+  'n/prefer-global/url': [ 'warn', 'never' ],
+  'n/prefer-promises/dns': 'warn',
+  'n/prefer-promises/fs': 'warn',
 };
 
 /**
@@ -61,7 +61,7 @@ const commonRules = {
  * @returns {string[]}
  */
 function toExt(globs) {
-    return globs.map((glob) => glob.slice(glob.lastIndexOf('.')));
+  return globs.map((glob) => glob.slice(glob.lastIndexOf('.')));
 }
 
 /**
@@ -70,71 +70,71 @@ function toExt(globs) {
  * @returns {Promise<import('eslint').Linter.FlatConfig[]>}
  */
 export async function createEslintNodeConfig(root) {
-    const commonFiles = await getCommonFiles(root);
-    const moduleFiles = await getModuleFiles(root);
-    const typescriptFiles = getTypescriptFiles();
-    const exampleFiles = getExampleFiles();
-    const rootDirectory = dirname(fileURLToPath(root));
-
-    return [
-        {
-            name: 'node/common',
-            files: commonFiles,
-            ignores: exampleFiles,
-            plugins: { n },
-            languageOptions: {
-                globals: script?.languageOptions?.globals,
-                parserOptions: {
-                    sourceType: 'script',
-                    ecmaVersion: 2022,
-                },
-            },
-            settings: {
-                node: {
-                    tryExtensions: toExt(commonFiles),
-                    resolvePaths: rootDirectory,
-                },
-            },
-            rules: {
-                ...commonRules,
-                'n/no-sync': [ 'error', { allowAtRootLevel: true } ],
-                'n/no-extraneous-require': 'error',
-                'n/no-missing-require': 'error',
-
-                'n/no-unsupported-features/es-syntax': [ 'error', { ignores: [] } ],
-            },
+  const commonFiles = await getCommonFiles(root);
+  const moduleFiles = await getModuleFiles(root);
+  const typescriptFiles = getTypescriptFiles();
+  const exampleFiles = getExampleFiles();
+  const rootDirectory = dirname(fileURLToPath(root));
+
+  return [
+    {
+      name: 'node/common',
+      files: commonFiles,
+      ignores: exampleFiles,
+      plugins: { n },
+      languageOptions: {
+        globals: script?.languageOptions?.globals,
+        parserOptions: {
+          sourceType: 'script',
+          ecmaVersion: 2022,
         },
-        {
-            name: 'node/module-and-typescript',
-            files: [ ...typescriptFiles, ...moduleFiles ],
-            ignores: exampleFiles,
-            plugins: { n },
-            languageOptions: {
-                globals: module?.languageOptions?.globals,
-                parserOptions: {
-                    sourceType: 'module',
-                    ecmaVersion: 2022,
-                },
-            },
-            settings: {
-                node: {
-                    tryExtensions: toExt([ ...typescriptFiles, ...moduleFiles ]),
-                    resolvePaths: rootDirectory,
-                },
-            },
-            rules: {
-                ...commonRules,
-                'n/no-extraneous-import': 'error',
-                'n/no-missing-import': 'error',
-                'n/no-sync': [ 'error', { allowAtRootLevel: false } ],
-                'n/no-unsupported-features/es-syntax': [ 'error', { ignores: [ 'modules' ] } ],
-            },
+      },
+      settings: {
+        node: {
+          tryExtensions: toExt(commonFiles),
+          resolvePaths: rootDirectory,
         },
-        {
-            name: 'node/test-files',
-            files: getTestFiles(),
-            plugins: { n },
-            rules: { 'n/no-sync': 'off' },
+      },
+      rules: {
+        ...commonRules,
+        'n/no-sync': [ 'error', { allowAtRootLevel: true } ],
+        'n/no-extraneous-require': 'error',
+        'n/no-missing-require': 'error',
+
+        'n/no-unsupported-features/es-syntax': [ 'error', { ignores: [] } ],
+      },
+    },
+    {
+      name: 'node/module-and-typescript',
+      files: [ ...typescriptFiles, ...moduleFiles ],
+      ignores: exampleFiles,
+      plugins: { n },
+      languageOptions: {
+        globals: module?.languageOptions?.globals,
+        parserOptions: {
+          sourceType: 'module',
+          ecmaVersion: 2022,
         },
-    ];
+      },
+      settings: {
+        node: {
+          tryExtensions: toExt([ ...typescriptFiles, ...moduleFiles ]),
+          resolvePaths: rootDirectory,
+        },
+      },
+      rules: {
+        ...commonRules,
+        'n/no-extraneous-import': 'error',
+        'n/no-missing-import': 'error',
+        'n/no-sync': [ 'error', { allowAtRootLevel: false } ],
+        'n/no-unsupported-features/es-syntax': [ 'error', { ignores: [ 'modules' ] } ],
+      },
+    },
+    {
+      name: 'node/test-files',
+      files: getTestFiles(),
+      plugins: { n },
+      rules: { 'n/no-sync': 'off' },
+    },
+  ];
 }

package/src/plugins/package-json.js

@@ -6,31 +6,31 @@ import jsoncParser from 'jsonc-eslint-parser';
  * @returns {Promise<import('eslint').Linter.FlatConfig[]>}
  */
 export async function createEslintPackageJsonConfig() {
-    return [
-        {
-            name: 'package-json/custom',
-            // @ts-expect-error
-            plugins: { 'package-json': plugin },
-            languageOptions: {
-                parser: jsoncParser,
-            },
-            files: [ 'package.json', '**/package.json' ],
-            rules: {
-                'package-json/order-properties': [ 'error', { order: 'sort-package-json' } ],
-                'package-json/sort-collections': 'error',
+  return [
+    {
+      name: 'package-json/custom',
+      // @ts-expect-error
+      plugins: { 'package-json': plugin },
+      languageOptions: {
+        parser: jsoncParser,
+      },
+      files: [ 'package.json', '**/package.json' ],
+      rules: {
+        'package-json/order-properties': [ 'error', { order: 'sort-package-json' } ],
+        'package-json/sort-collections': 'error',
 
-                // Seems to break renovate finding changelogs
-                'package-json/prefer-repository-shorthand': 'off',
-                // Breaks workspace dependency linking
-                // Invalid version range for dependency @darksheep/clone: workspace:~
-                'package-json/valid-package-def': 'warn',
+        // Seems to break renovate finding changelogs
+        'package-json/prefer-repository-shorthand': 'off',
+        // Breaks workspace dependency linking
+        // Invalid version range for dependency @darksheep/clone: workspace:~
+        'package-json/valid-package-def': 'warn',
 
-                'package-json/unique-dependencies': 'error',
-                'package-json/valid-local-dependency': 'error',
-                'package-json/valid-name': 'error',
-                'package-json/valid-repository-directory': 'error',
-                'package-json/valid-version': 'error',
-            },
-        },
-    ];
+        'package-json/unique-dependencies': 'error',
+        'package-json/valid-local-dependency': 'error',
+        'package-json/valid-name': 'error',
+        'package-json/valid-repository-directory': 'error',
+        'package-json/valid-version': 'error',
+      },
+    },
+  ];
 }