@darksheep/eslint 5.2.1 → 5.3.1

package/src/plugins/typescript.js

@@ -7,7 +7,7 @@ import { getPackageJson } from '../utilities/package.js';
  * @returns {T}
  */
 function idef(target) {
-    return /** @type {{ default: T }} */ (target)?.default ?? target;
+  return /** @type {{ default: T }} */ (target)?.default ?? target;
 }
 
 /**
@@ -16,73 +16,73 @@ function idef(target) {
  * @returns {Promise<import('eslint').Linter.FlatConfig[]>}
  */
 export async function createEslintTypescriptConfig(root) {
-    const packageJson = await getPackageJson(root, 'typescript');
+  const packageJson = await getPackageJson(root, 'typescript');
 
-    // Typescript not installed
-    if (packageJson == null) {
-        return [];
-    }
+  // Typescript not installed
+  if (packageJson == null) {
+    return [];
+  }
 
-    const typescriptParser = idef(await import('@typescript-eslint/parser'));
-    const typescriptPlugin = idef(await import('@typescript-eslint/eslint-plugin'));
+  const typescriptParser = idef(await import('@typescript-eslint/parser'));
+  const typescriptPlugin = idef(await import('@typescript-eslint/eslint-plugin'));
 
-    return [ {
-        name: 'typescript/custom',
-        files: getTypescriptFiles(),
-        languageOptions: {
-            parser: typescriptParser,
-            sourceType: 'module',
-            parserOptions: {
-                warnOnUnsupportedTypeScriptVersion: false,
-            },
-        },
-        plugins: {
-            '@typescript-eslint': /** @type {*} */ (typescriptPlugin),
-        },
-        rules: {
-            // Rules that fight with typescript
-            'constructor-super': 'off',
-            'getter-return': 'off',
-            'no-const-assign': 'off',
-            'no-dupe-args': 'off',
-            'no-dupe-class-members': 'off',
-            'no-dupe-keys': 'off',
-            'no-func-assign': 'off',
-            'no-import-assign': 'off',
-            // 'no-new-symbol': 'off',
-            'no-obj-calls': 'off',
-            'no-redeclare': 'off',
-            'no-setter-return': 'off',
-            'no-this-before-super': 'off',
-            'no-undef': 'off',
-            'no-unreachable': 'off',
-            'no-unsafe-negation': 'off',
-            'no-array-constructor': 'off',
+  return [ {
+    name: 'typescript/custom',
+    files: getTypescriptFiles(),
+    languageOptions: {
+      parser: typescriptParser,
+      sourceType: 'module',
+      parserOptions: {
+        warnOnUnsupportedTypeScriptVersion: false,
+      },
+    },
+    plugins: {
+      '@typescript-eslint': /** @type {*} */ (typescriptPlugin),
+    },
+    rules: {
+      // Rules that fight with typescript
+      'constructor-super': 'off',
+      'getter-return': 'off',
+      'no-const-assign': 'off',
+      'no-dupe-args': 'off',
+      'no-dupe-class-members': 'off',
+      'no-dupe-keys': 'off',
+      'no-func-assign': 'off',
+      'no-import-assign': 'off',
+      // 'no-new-symbol': 'off',
+      'no-obj-calls': 'off',
+      'no-redeclare': 'off',
+      'no-setter-return': 'off',
+      'no-this-before-super': 'off',
+      'no-undef': 'off',
+      'no-unreachable': 'off',
+      'no-unsafe-negation': 'off',
+      'no-array-constructor': 'off',
 
-            // Rules that prevert some commmon ts issues
-            'no-var': 'error',
-            'prefer-const': 'error',
-            'prefer-rest-params': 'error',
-            'prefer-spread': 'error',
+      // Rules that prevert some commmon ts issues
+      'no-var': 'error',
+      'prefer-const': 'error',
+      'prefer-rest-params': 'error',
+      'prefer-spread': 'error',
 
-            // ts eslint recommended
-            '@typescript-eslint/ban-ts-comment': 'error',
-            '@typescript-eslint/no-empty-object-type': 'error',
-            '@typescript-eslint/no-unsafe-function-type': 'error',
-            '@typescript-eslint/no-wrapper-object-types': 'error',
-            '@typescript-eslint/no-array-constructor': 'error',
-            '@typescript-eslint/no-duplicate-enum-values': 'error',
-            '@typescript-eslint/no-explicit-any': 'error',
-            '@typescript-eslint/no-extra-non-null-assertion': 'error',
-            '@typescript-eslint/no-misused-new': 'error',
-            '@typescript-eslint/no-namespace': [ 'error', { allowDeclarations: true } ],
-            '@typescript-eslint/no-non-null-asserted-optional-chain': 'error',
-            '@typescript-eslint/no-this-alias': 'error',
-            '@typescript-eslint/no-unnecessary-type-constraint': 'error',
-            '@typescript-eslint/no-unsafe-declaration-merging': 'error',
-            '@typescript-eslint/no-require-imports': 'error',
-            '@typescript-eslint/prefer-as-const': 'error',
-            '@typescript-eslint/triple-slash-reference': 'error',
-        },
-    } ];
+      // ts eslint recommended
+      '@typescript-eslint/ban-ts-comment': 'error',
+      '@typescript-eslint/no-empty-object-type': 'error',
+      '@typescript-eslint/no-unsafe-function-type': 'error',
+      '@typescript-eslint/no-wrapper-object-types': 'error',
+      '@typescript-eslint/no-array-constructor': 'error',
+      '@typescript-eslint/no-duplicate-enum-values': 'error',
+      '@typescript-eslint/no-explicit-any': 'error',
+      '@typescript-eslint/no-extra-non-null-assertion': 'error',
+      '@typescript-eslint/no-misused-new': 'error',
+      '@typescript-eslint/no-namespace': [ 'error', { allowDeclarations: true } ],
+      '@typescript-eslint/no-non-null-asserted-optional-chain': 'error',
+      '@typescript-eslint/no-this-alias': 'error',
+      '@typescript-eslint/no-unnecessary-type-constraint': 'error',
+      '@typescript-eslint/no-unsafe-declaration-merging': 'error',
+      '@typescript-eslint/no-require-imports': 'error',
+      '@typescript-eslint/prefer-as-const': 'error',
+      '@typescript-eslint/triple-slash-reference': 'error',
+    },
+  } ];
 }

package/src/plugins/unicorn.js

@@ -5,53 +5,53 @@ import unicorn from 'eslint-plugin-unicorn';
  * @returns {Promise<import('eslint').Linter.FlatConfig[]>}
  */
 export async function createEslintUnicornConfig() {
-    return [ {
-        name: 'unicorn/custom',
-        plugins: { unicorn },
-        rules: {
-            /*
+  return [ {
+    name: 'unicorn/custom',
+    plugins: { unicorn },
+    rules: {
+      /*
              * Sanity checks
             */
-            'unicorn/better-regex': 'off',
-            'unicorn/no-empty-file': 'warn',
-            'unicorn/no-zero-fractions': 'error',
-            'unicorn/no-unreadable-array-destructuring': 'error',
-            'unicorn/no-useless-undefined': 'error',
-            'unicorn/no-abusive-eslint-disable': 'warn',
+      'unicorn/better-regex': 'off',
+      'unicorn/no-empty-file': 'warn',
+      'unicorn/no-zero-fractions': 'error',
+      'unicorn/no-unreadable-array-destructuring': 'error',
+      'unicorn/no-useless-undefined': 'error',
+      'unicorn/no-abusive-eslint-disable': 'warn',
 
-            /*
+      /*
              *  Error management
              */
-            'unicorn/catch-error-name': 'error',
-            'unicorn/custom-error-definition': 'off',
-            'unicorn/throw-new-error': 'error',
-            'unicorn/error-message': 'error',
-            'unicorn/prefer-type-error': 'error',
+      'unicorn/catch-error-name': 'error',
+      'unicorn/custom-error-definition': 'off',
+      'unicorn/throw-new-error': 'error',
+      'unicorn/error-message': 'error',
+      'unicorn/prefer-type-error': 'error',
 
-            // This breaks babel
-            'unicorn/prefer-optional-catch-binding': 'off',
+      // This breaks babel
+      'unicorn/prefer-optional-catch-binding': 'off',
 
-            /*
+      /*
              *  Best practice
              */
-            'unicorn/consistent-destructuring': 'off',
-            'unicorn/escape-case': 'error',
-            'unicorn/filename-case': 'off',
-            'unicorn/no-console-spaces': 'error',
-            'unicorn/no-keyword-prefix': 'warn',
-            'unicorn/no-nested-ternary': 'warn',
-            'unicorn/no-new-array': 'error',
-            'unicorn/no-useless-promise-resolve-reject': 'error',
-            'unicorn/no-useless-switch-case': 'error',
-            'unicorn/prefer-add-event-listener': 'error',
-            'unicorn/prefer-default-parameters': 'error',
-            'unicorn/prefer-export-from': 'warn',
-            'unicorn/prefer-native-coercion-functions': 'error',
-            'unicorn/prefer-node-protocol': 'warn',
-            'unicorn/prefer-reflect-apply': 'warn',
-            'unicorn/prefer-regexp-test': 'warn',
-            'unicorn/require-array-join-separator': 'error',
-            'unicorn/text-encoding-identifier-case': 'error',
-        },
-    } ];
+      'unicorn/consistent-destructuring': 'off',
+      'unicorn/escape-case': 'error',
+      'unicorn/filename-case': 'off',
+      'unicorn/no-console-spaces': 'error',
+      'unicorn/no-keyword-prefix': 'warn',
+      'unicorn/no-nested-ternary': 'warn',
+      'unicorn/no-new-array': 'error',
+      'unicorn/no-useless-promise-resolve-reject': 'error',
+      'unicorn/no-useless-switch-case': 'error',
+      'unicorn/prefer-add-event-listener': 'error',
+      'unicorn/prefer-default-parameters': 'error',
+      'unicorn/prefer-export-from': 'warn',
+      'unicorn/prefer-native-coercion-functions': 'error',
+      'unicorn/prefer-node-protocol': 'warn',
+      'unicorn/prefer-reflect-apply': 'warn',
+      'unicorn/prefer-regexp-test': 'warn',
+      'unicorn/require-array-join-separator': 'error',
+      'unicorn/text-encoding-identifier-case': 'error',
+    },
+  } ];
 }

package/src/plugins/unused-imports.js

@@ -1,8 +1,8 @@
 import unused from 'eslint-plugin-unused-imports';
 
 import {
-    getModuleFiles,
-    getTypescriptFiles,
+  getModuleFiles,
+  getTypescriptFiles,
 } from '../utilities/eslint-files.js';
 
 /**
@@ -11,28 +11,28 @@ import {
  * @returns {Promise<import('eslint').Linter.FlatConfig[]>}
  */
 export async function createEslintUnusedImportsConfig(root) {
-    return [
-        {
-            name: 'no-unused-imports/custom',
-            files: [
-                ...await getModuleFiles(root),
-                ...getTypescriptFiles(),
-            ],
-            plugins: { 'unused-imports': unused },
-            rules: {
-                'no-unused-vars': 'off',
-                '@typescript-eslint/no-unused-vars': 'off',
+  return [
+    {
+      name: 'no-unused-imports/custom',
+      files: [
+        ...await getModuleFiles(root),
+        ...getTypescriptFiles(),
+      ],
+      plugins: { 'unused-imports': unused },
+      rules: {
+        'no-unused-vars': 'off',
+        '@typescript-eslint/no-unused-vars': 'off',
 
-                'unused-imports/no-unused-imports': 'error',
-                'unused-imports/no-unused-vars': [
-                    'error', {
-                        argsIgnorePattern: '^_',
-                        varsIgnorePattern: '^_',
-                        args: 'after-used',
-                        vars: 'local',
-                    },
-                ],
-            },
-        },
-    ];
+        'unused-imports/no-unused-imports': 'error',
+        'unused-imports/no-unused-vars': [
+          'error', {
+            argsIgnorePattern: '^_',
+            varsIgnorePattern: '^_',
+            args: 'after-used',
+            vars: 'local',
+          },
+        ],
+      },
+    },
+  ];
 }

package/src/plugins/yml.js

@@ -0,0 +1,41 @@
+import yml from 'eslint-plugin-yml';
+import parser from 'yaml-eslint-parser';
+
+/**
+ * Get ESLint config for yml check
+ * @returns {Promise<import('eslint').Linter.FlatConfig[]>}
+ */
+export async function createEslintYmlConfig() {
+  return [
+    {
+      name: 'yml/core',
+      files: [ '**/*.yaml', '**/*.yml' ],
+      languageOptions: { parser },
+      // @ts-expect-error jsonc does not match the plugin interface
+      plugins: { yml },
+      rules: {
+        'yml/block-mapping-colon-indicator-newline': 'error',
+        'yml/block-mapping-question-indicator-newline': 'error',
+        'yml/block-mapping': 'error',
+        'yml/block-sequence-hyphen-indicator-newline': [ 'error', 'never' ],
+        'yml/block-sequence': 'error',
+        'yml/flow-mapping-curly-newline': 'error',
+        'yml/flow-mapping-curly-spacing': [ 'error', 'always' ],
+        'yml/flow-sequence-bracket-newline': 'error',
+        'yml/flow-sequence-bracket-spacing': [ 'error', 'always' ],
+        'yml/key-spacing': 'error',
+        'yml/no-empty-document': 'error',
+        'yml/no-empty-key': 'error',
+        'yml/no-empty-sequence-entry': 'error',
+        'yml/no-irregular-whitespace': 'error',
+        'yml/no-multiple-empty-lines': [ 'error', { max: 1 } ],
+        'yml/no-tab-indent': 'error',
+        'yml/no-trailing-zeros': 'error',
+        'yml/plain-scalar': 'error',
+        'yml/quotes': [ 'error' ],
+        'yml/require-string-key': 'error',
+        'yml/spaced-comment': 'error',
+      },
+    },
+  ];
+}

package/src/types.d.ts

@@ -3,121 +3,121 @@
 type WithRequired<T, K extends keyof T> = T & { [P in K]-?: T[P] };
 
 declare module '@eslint-community/eslint-plugin-eslint-comments' {
-    import type { ESLint } from 'eslint';
-    export default {} as ESLint.Plugin;
+  import type { ESLint } from 'eslint';
+  export default {} as ESLint.Plugin;
 }
 
 declare module 'eslint-plugin-import' {
-    import type { ESLint, Linter } from 'eslint';
-    export default {} as {
-        configs: {
-            'electron': {
-                settings: Required<ESLint.ConfigData['settings']>;
-            };
-            'errors': {
-                plugins: Required<ESLint.ConfigData['plugins']>;
-                rules: Linter.RulesRecord;
-            };
-            'react': {
-                parserOptions: Required<ESLint.ConfigData['parserOptions']>;
-                settings: Required<ESLint.ConfigData['settings']>;
-            };
-            'react-native': {
-                settings: Required<ESLint.ConfigData['settings']>;
-            };
-            'recommended': {
-                parserOptions: Required<ESLint.ConfigData['parserOptions']>;
-                plugins: Required<ESLint.ConfigData['plugins']>;
-                rules: Linter.RulesRecord;
-            };
-            'stage-0': {
-                plugins: Required<ESLint.ConfigData['plugins']>;
-                rules: Linter.RulesRecord;
-            };
-            'typescript': {
-                rules: Linter.RulesRecord;
-                settings: Required<ESLint.ConfigData['settings']>;
-            };
-            'warnings': {
-                plugins: Required<ESLint.ConfigData['plugins']>;
-                rules: Linter.RulesRecord;
-            };
-        };
-        rules: Required<ESLint.Plugin['rules']>;
+  import type { ESLint, Linter } from 'eslint';
+  export default {} as {
+    configs: {
+      'electron': {
+        settings: Required<ESLint.ConfigData['settings']>;
+      };
+      'errors': {
+        plugins: Required<ESLint.ConfigData['plugins']>;
+        rules: Linter.RulesRecord;
+      };
+      'react': {
+        parserOptions: Required<ESLint.ConfigData['parserOptions']>;
+        settings: Required<ESLint.ConfigData['settings']>;
+      };
+      'react-native': {
+        settings: Required<ESLint.ConfigData['settings']>;
+      };
+      'recommended': {
+        parserOptions: Required<ESLint.ConfigData['parserOptions']>;
+        plugins: Required<ESLint.ConfigData['plugins']>;
+        rules: Linter.RulesRecord;
+      };
+      'stage-0': {
+        plugins: Required<ESLint.ConfigData['plugins']>;
+        rules: Linter.RulesRecord;
+      };
+      'typescript': {
+        rules: Linter.RulesRecord;
+        settings: Required<ESLint.ConfigData['settings']>;
+      };
+      'warnings': {
+        plugins: Required<ESLint.ConfigData['plugins']>;
+        rules: Linter.RulesRecord;
+      };
     };
+    rules: Required<ESLint.Plugin['rules']>;
+  };
 }
 
 declare module 'eslint-plugin-jest' {
-    import type { ESLint } from 'eslint';
-    export default {} as WithRequired<ESLint.Plugin, 'environments'>;
+  import type { ESLint } from 'eslint';
+  export default {} as WithRequired<ESLint.Plugin, 'environments'>;
 }
 
 declare module 'eslint-plugin-perfectionist' {
-    import type { ESLint } from 'eslint';
-    export default {} as WithRequired<ESLint.Plugin, 'environments'>;
+  import type { ESLint } from 'eslint';
+  export default {} as WithRequired<ESLint.Plugin, 'environments'>;
 }
 
 declare module 'eslint-plugin-jsdoc' {
-    import type { ESLint } from 'eslint';
-    export default {} as WithRequired<ESLint.Plugin, 'environments'>;
+  import type { ESLint } from 'eslint';
+  export default {} as WithRequired<ESLint.Plugin, 'environments'>;
 }
 
 declare module '@stylistic/eslint-plugin' {
-    import type { ESLint } from 'eslint';
-    export default {} as WithRequired<ESLint.Plugin, 'environments'>;
+  import type { ESLint } from 'eslint';
+  export default {} as WithRequired<ESLint.Plugin, 'environments'>;
 }
 
 declare module 'eslint-plugin-jsx-a11y' {
-    import type { ESLint } from 'eslint';
-    export default {} as ESLint.Plugin;
+  import type { ESLint } from 'eslint';
+  export default {} as ESLint.Plugin;
 }
 
 declare module 'eslint-plugin-promise' {
-    import type { ESLint } from 'eslint';
-    export default {} as {
-        configs: {
-            recommended: WithRequired<ESLint.ConfigData, 'plugins' | 'rules'>;
-        };
-        rules: Required<ESLint.Plugin['rules']>;
+  import type { ESLint } from 'eslint';
+  export default {} as {
+    configs: {
+      recommended: WithRequired<ESLint.ConfigData, 'plugins' | 'rules'>;
     };
+    rules: Required<ESLint.Plugin['rules']>;
+  };
 }
 
 declare module 'eslint-plugin-react' {
-    import type { ESLint } from 'eslint';
-    export default {} as ESLint.Plugin;
+  import type { ESLint } from 'eslint';
+  export default {} as ESLint.Plugin;
 }
 
 declare module 'eslint-plugin-security' {
-    import type { ESLint } from 'eslint';
-    export default {} as {
-        configs: {
-            recommended: WithRequired<ESLint.ConfigData, 'plugins' | 'rules'>;
-        };
-        rules: Required<ESLint.Plugin['rules']>;
+  import type { ESLint } from 'eslint';
+  export default {} as {
+    configs: {
+      recommended: WithRequired<ESLint.ConfigData, 'plugins' | 'rules'>;
     };
+    rules: Required<ESLint.Plugin['rules']>;
+  };
 }
 
 declare module 'eslint-plugin-unused-imports' {
-    import type { ESLint } from 'eslint';
-    export default {} as ESLint.Plugin;
+  import type { ESLint } from 'eslint';
+  export default {} as ESLint.Plugin;
 }
 
 declare module 'eslint-plugin-n' {
-    import type { ESLint, Linter } from 'eslint';
-    export default {} as {
-        configs: {
-            'flat/mixed-esm-and-cjs': Linter.FlatConfig;
-            'flat/recommended': Linter.FlatConfig;
-            'flat/recommended-module': Linter.FlatConfig;
-            'flat/recommended-script': Linter.FlatConfig;
-            'recommended': ESLint.ConfigData;
-            'recommended-module': ESLint.ConfigData;
-            'recommended-script': ESLint.ConfigData;
-        };
-        meta: {
-            name: string;
-            version: string;
-        };
-        rules: Required<ESLint.Plugin['rules']>;
+  import type { ESLint, Linter } from 'eslint';
+  export default {} as {
+    configs: {
+      'flat/mixed-esm-and-cjs': Linter.FlatConfig;
+      'flat/recommended': Linter.FlatConfig;
+      'flat/recommended-module': Linter.FlatConfig;
+      'flat/recommended-script': Linter.FlatConfig;
+      'recommended': ESLint.ConfigData;
+      'recommended-module': ESLint.ConfigData;
+      'recommended-script': ESLint.ConfigData;
     };
+    meta: {
+      name: string;
+      version: string;
+    };
+    rules: Required<ESLint.Plugin['rules']>;
+  };
 }