@the-stranger/eslint-plugin 2.0.0

package/src/lib/configs/perfectionist.js

@@ -0,0 +1,129 @@
+import perfectionist from 'eslint-plugin-perfectionist';
+import { namer, objectNamer } from '../namer.js';
+import { FilePatterns, getFilePatterns } from '../patterns.js';
+import { setRuleLevel } from '../severity.js';
+const configNatural = setRuleLevel('warn', perfectionist.configs['recommended-natural']);
+export default [
+    objectNamer(configNatural, 'perfectionist-recommended-natural'),
+    {
+        files: getFilePatterns(FilePatterns.source),
+        name: namer('perfectionist'),
+        rules: {
+            'perfectionist/sort-classes': [
+                'warn',
+                {
+                    groups: [
+                        'constructor',
+                        'index-signature',
+                        'static-block',
+                        'accessor-property',
+                        ['get-method', 'set-method'],
+                        'method',
+                        'override-method',
+                        'static-method',
+                        'protected-method',
+                        'private-method',
+                        'protected-accessor-property',
+                        'private-accessor-property',
+                        ['private-get-method', 'private-set-method'],
+                    ],
+                },
+            ],
+            'perfectionist/sort-enums': [
+                'warn',
+                {
+                    forceNumericSort: true,
+                },
+            ],
+            'perfectionist/sort-exports': [
+                'warn',
+                {
+                    type: 'natural',
+                },
+            ],
+            'perfectionist/sort-imports': [
+                'warn',
+                {
+                    groups: [
+                        ['side-effect', 'side-effect-style'],
+                        'builtin',
+                        'external',
+                        'type',
+                        'internal-type',
+                        'internal',
+                        ['parent-type', 'sibling-type', 'index-type'],
+                        ['parent', 'sibling', 'index'],
+                        'object',
+                        'unknown',
+                    ],
+                    newlinesBetween: 'always',
+                    type: 'natural',
+                },
+            ],
+            'perfectionist/sort-interfaces': 'off',
+            'perfectionist/sort-modules': [
+                'warn',
+                {
+                    groups: [
+                        'unknown',
+                        'export-class',
+                        'export-function',
+                        'export-enum',
+                        ['export-interface', 'export-type'],
+                        'class',
+                        'function',
+                        'enum',
+                        ['interface', 'type'],
+                        [
+                            'export-default-class',
+                            'export-default-function',
+                            'export-default-enum',
+                            'export-default-type',
+                            'export-default-interface',
+                        ],
+                    ],
+                },
+            ],
+            'perfectionist/sort-named-exports': [
+                'warn',
+                {
+                    groupKind: 'values-first',
+                    type: 'natural',
+                },
+            ],
+            'perfectionist/sort-named-imports': [
+                'warn',
+                {
+                    type: 'natural',
+                },
+            ],
+            'perfectionist/sort-union-types': [
+                'warn',
+                {
+                    groups: [
+                        'conditional',
+                        'function',
+                        'operator',
+                        'literal',
+                        'keyword',
+                        'named',
+                        'import',
+                        'tuple',
+                        'object',
+                        ['intersection', 'union'],
+                        'nullish',
+                        'unknown',
+                    ],
+                    ignoreCase: false,
+                },
+            ],
+        },
+    },
+    {
+        files: ['eslint.config.*', 'prettier.config.*', 'yarn.config.cjs'],
+        name: namer('disable sort for configuration files'),
+        rules: {
+            'perfectionist/sort-objects': 'off',
+        },
+    },
+];

package/src/lib/configs/promise.d.ts

@@ -0,0 +1,4 @@
+import type { Linter } from 'eslint';
+declare const _default: Linter.Config[];
+export default _default;
+//# sourceMappingURL=promise.d.ts.map

package/src/lib/configs/promise.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"promise.d.ts","sourceRoot":"","sources":["../../../../../../packages/eslint-plugin/src/lib/configs/promise.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAA;wBAkB/B,MAAM,CAAC,MAAM,EAAE;AAbpB,wBAaoB"}

package/src/lib/configs/promise.js

@@ -0,0 +1,16 @@
+import promise from 'eslint-plugin-promise';
+import { namer } from '../namer.js';
+import { FilePatterns, getFilePatterns } from '../patterns.js';
+export default [
+    promise.configs['flat/recommended'],
+    {
+        files: getFilePatterns(FilePatterns.source),
+        name: namer('promise'),
+        rules: {
+            'promise/no-multiple-resolved': 'warn',
+            'promise/prefer-await-to-callbacks': 'warn',
+            'promise/prefer-await-to-then': 'warn',
+            'promise/spec-only': 'error',
+        },
+    },
+];

package/src/lib/configs/regexp.d.ts

@@ -0,0 +1,4 @@
+import type { Linter } from 'eslint';
+declare const _default: Linter.Config[];
+export default _default;
+//# sourceMappingURL=regexp.d.ts.map

package/src/lib/configs/regexp.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"regexp.d.ts","sourceRoot":"","sources":["../../../../../../packages/eslint-plugin/src/lib/configs/regexp.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAA;wBAM/B,MAAM,CAAC,MAAM,EAAE;AAFpB,wBAEoB"}

package/src/lib/configs/regexp.js

@@ -0,0 +1,5 @@
+import re from 'eslint-plugin-regexp';
+import { objectNamer } from '../namer.js';
+export default [
+    objectNamer(re.configs['flat/recommended'], 're-recommended'),
+];

package/src/lib/configs/toml.d.ts

@@ -0,0 +1,4 @@
+import type { Linter } from 'eslint';
+declare const _default: Linter.Config[];
+export default _default;
+//# sourceMappingURL=toml.d.ts.map

package/src/lib/configs/toml.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"toml.d.ts","sourceRoot":"","sources":["../../../../../../packages/eslint-plugin/src/lib/configs/toml.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAA;wBAqC/B,MAAM,CAAC,MAAM,EAAE;AAjCpB,wBAiCoB"}

package/src/lib/configs/toml.js

@@ -0,0 +1,35 @@
+import toml from 'eslint-plugin-toml';
+import { namer } from '../namer.js';
+export default [
+    toml.configs['flat/recommended'],
+    {
+        files: ['**/*.toml'],
+        name: namer('toml'),
+        rules: {
+            'toml/array-bracket-newline': ['warn', 'consistent'],
+            'toml/array-bracket-spacing': [
+                'warn',
+                'always',
+                {
+                    arraysInArrays: false,
+                    objectsInArrays: false,
+                    singleValue: true,
+                },
+            ],
+            'toml/array-element-newline': ['warn', 'consistent'],
+            'toml/comma-style': 'warn',
+            'toml/indent': ['warn', 2],
+            'toml/inline-table-curly-spacing': 'warn',
+            'toml/key-spacing': [
+                'warn',
+                { afterEqual: true, beforeEqual: true, mode: 'strict' },
+            ],
+            'toml/no-space-dots': 'warn',
+            'toml/no-unreadable-number-separator': 'warn',
+            'toml/precision-of-fractional-seconds': ['warn', { max: 3 }],
+            'toml/precision-of-integer': ['warn', { maxBit: 64 }],
+            'toml/spaced-comment': 'warn',
+            'toml/table-bracket-spacing': 'warn',
+        },
+    },
+];

package/src/lib/configs/typescript-eslint.d.ts

@@ -0,0 +1,4 @@
+import type { Linter } from 'eslint';
+declare const config: Linter.Config[];
+export default config;
+//# sourceMappingURL=typescript-eslint.d.ts.map

package/src/lib/configs/typescript-eslint.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"typescript-eslint.d.ts","sourceRoot":"","sources":["../../../../../../packages/eslint-plugin/src/lib/configs/typescript-eslint.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAA;AAKpC,QAAA,MAAM,MAAM,EAAE,MAAM,CAAC,MAAM,EAgB1B,CAAA;AAQD,eAAe,MAAM,CAAA"}

package/src/lib/configs/typescript-eslint.js

@@ -0,0 +1,26 @@
+import tseslint from 'typescript-eslint';
+import { namer } from '../namer.js';
+import { FilePatterns, getFilePatterns } from '../patterns.js';
+const config = [
+    {
+        files: getFilePatterns(FilePatterns.source),
+        name: namer('unnecessary ts rules'),
+        rules: {
+            // I do what I want ¯\_(ツ)_/¯
+            '@typescript-eslint/no-explicit-any': 'off',
+            '@typescript-eslint/no-unused-vars': 'warn',
+        },
+    },
+    {
+        files: getFilePatterns(FilePatterns.test),
+        name: namer('disable no-non-null in tests'),
+        rules: { '@typescript-eslint/no-non-null-assertion': 'off' },
+    },
+];
+try {
+    await import('@nx/eslint-plugin');
+}
+catch {
+    config.unshift(...tseslint.configs.recommended);
+}
+export default config;

package/src/lib/configs/unicorn.d.ts

@@ -0,0 +1,4 @@
+import type { Linter } from 'eslint';
+declare const _default: Linter.Config[];
+export default _default;
+//# sourceMappingURL=unicorn.d.ts.map

package/src/lib/configs/unicorn.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"unicorn.d.ts","sourceRoot":"","sources":["../../../../../../packages/eslint-plugin/src/lib/configs/unicorn.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAA;wBAgF/B,MAAM,CAAC,MAAM,EAAE;AA3EpB,wBA2EoB"}

package/src/lib/configs/unicorn.js

@@ -0,0 +1,66 @@
+import unicorn from 'eslint-plugin-unicorn';
+import { defineConfig } from 'eslint/config';
+import { namer } from '../namer.js';
+import { FilePatterns, getFilePatterns } from '../patterns.js';
+export default defineConfig(unicorn.configs['recommended'], {
+    files: ['**/*'],
+    name: namer('unicorn/allow abbreviations'),
+    rules: {
+        'unicorn/prevent-abbreviations': 'off',
+    },
+}, {
+    files: [getFilePatterns(FilePatterns.source)],
+    name: namer('unicorn/base'),
+    rules: {
+        'unicorn/custom-error-definition': 'warn',
+        'unicorn/import-style': 'off',
+        'unicorn/no-array-callback-reference': 'off',
+        'unicorn/no-array-reduce': 'off',
+        'unicorn/no-array-reverse': 'off',
+        'unicorn/no-array-sort': 'off',
+        'unicorn/no-keyword-prefix': 'error',
+        'unicorn/no-useless-undefined': ['error', { checkArrowFunctionBody: false }],
+        'unicorn/numeric-separators-style': ['warn', { number: { minimumDigits: 12 } }],
+        'unicorn/prefer-import-meta-properties': 'warn',
+        'unicorn/prefer-math-trunc': 'off',
+        'unicorn/prefer-node-protocol': 'off',
+    },
+}, {
+    files: getFilePatterns(FilePatterns.cjs),
+    name: namer("unicorn/CJS files don't have to be modules"),
+    rules: {
+        'unicorn/prefer-module': 'off',
+    },
+}, {
+    files: getFilePatterns(FilePatterns.react, FilePatterns.astro),
+    name: namer('unicorn/allow pascal case for react files'),
+    rules: {
+        'unicorn/filename-case': [
+            'error',
+            {
+                cases: {
+                    kebabCase: true,
+                    pascalCase: true,
+                },
+            },
+        ],
+    },
+}, {
+    files: getFilePatterns(FilePatterns.test),
+    name: namer('unicorn/test files'),
+    rules: {
+        'unicorn/consistent-function-scoping': 'off',
+        'unicorn/no-nested-ternary': 'off',
+        'unicorn/no-null': 'off',
+        'unicorn/no-useless-undefined': [
+            'error',
+            { checkArguments: false, checkArrowFunctionBody: false },
+        ],
+    },
+}, {
+    files: getFilePatterns(FilePatterns.astroScript),
+    name: 'ignore filename case for virtual files',
+    rules: {
+        'unicorn/filename-case': 'off',
+    },
+});

package/src/lib/configs/vitest.d.ts

@@ -0,0 +1,4 @@
+import type { Linter } from 'eslint';
+declare const _default: Linter.Config[];
+export default _default;
+//# sourceMappingURL=vitest.d.ts.map

package/src/lib/configs/vitest.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"vitest.d.ts","sourceRoot":"","sources":["../../../../../../packages/eslint-plugin/src/lib/configs/vitest.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAA;wBAiB/B,MAAM,CAAC,MAAM,EAAE;AAZpB,wBAYoB"}

package/src/lib/configs/vitest.js

@@ -0,0 +1,15 @@
+import vitest from '@vitest/eslint-plugin';
+import { namer } from '../namer.js';
+import { FilePatterns, getFilePatterns } from '../patterns.js';
+export default [
+    vitest.configs['recommended'],
+    {
+        files: getFilePatterns(FilePatterns.test),
+        name: namer('vitest'),
+        rules: {
+            'vitest/consistent-test-it': ['error', { fn: 'it' }],
+            'vitest/prefer-hooks-in-order': 'warn',
+            'vitest/valid-title': ['warn', { disallowedWords: ['should'] }],
+        },
+    },
+];

package/src/lib/configs/yml.d.ts

@@ -0,0 +1,4 @@
+import type { Linter } from 'eslint';
+declare const _default: Linter.Config[];
+export default _default;
+//# sourceMappingURL=yml.d.ts.map

package/src/lib/configs/yml.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"yml.d.ts","sourceRoot":"","sources":["../../../../../../packages/eslint-plugin/src/lib/configs/yml.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAA;wBAwI/B,MAAM,CAAC,MAAM,EAAE;AAtGpB,wBAsGoB"}

package/src/lib/configs/yml.js

@@ -0,0 +1,127 @@
+import yml from 'eslint-plugin-yml';
+import { namer } from '../namer.js';
+const topLevelKeyOrder = [
+    'name',
+    'on',
+    'permissions',
+    'env',
+    'defaults',
+    'concurrency',
+    'jobs',
+];
+const jobKeyOrder = [
+    'strategy',
+    'name',
+    'if',
+    'needs',
+    'runs-on',
+    'permissions',
+    'environment',
+    'env',
+    'concurrency',
+    'timeout-minutes',
+    'outputs',
+    'defaults',
+    'steps',
+];
+const stepKeyOrder = ['id', 'name', 'if', 'run', 'uses', 'with', 'env'];
+const topLevelAscKeys = ['on', 'permissions', 'defaults'].join('|');
+export default [
+    yml.configs['flat/standard'],
+    {
+        files: ['cspell.config.yaml', '**/cspell.config.yaml'],
+        name: namer('cspell-config'),
+        rules: {
+            'yml/sort-keys': [
+                'error',
+                {
+                    order: [
+                        'version',
+                        'language',
+                        'import',
+                        'ignorePaths',
+                        'dictionaries',
+                        'ignoreWords',
+                        'words',
+                        'languageSettings',
+                        { order: { type: 'asc' } },
+                    ],
+                    pathPattern: '^$',
+                },
+                {
+                    order: ['languageId', 'dictionaries', { order: { type: 'asc' } }],
+                    pathPattern: 'languageSettings$',
+                },
+            ],
+            'yml/sort-sequence-values': [
+                'error',
+                {
+                    order: { type: 'asc' },
+                    pathPattern: 'dictionaries|import|ignorePaths|ignoreWords|words$',
+                },
+            ],
+        },
+    },
+    {
+        files: ['.github/workflows/*.yml'],
+        name: namer('github-actions'),
+        rules: {
+            'yml/no-empty-mapping-values': 'off',
+            'yml/sort-keys': [
+                'error',
+                {
+                    order: [topLevelKeyOrder, { order: { type: 'asc' } }],
+                    pathPattern: '^$',
+                },
+                {
+                    order: { type: 'asc' },
+                    pathPattern: `^${topLevelAscKeys}`,
+                },
+                {
+                    order: [stepKeyOrder, { order: { type: 'asc' } }],
+                    pathPattern: String.raw `^jobs\..+steps`,
+                },
+                {
+                    order: [jobKeyOrder, { order: { type: 'asc' } }],
+                    pathPattern: '^jobs',
+                },
+            ],
+            'yml/sort-sequence-values': [
+                'error',
+                {
+                    order: { type: 'asc' },
+                    pathPattern: `^${topLevelAscKeys}`,
+                },
+            ],
+        },
+    },
+    {
+        files: ['.markdownlint-cli2.yaml'],
+        name: namer('markdownlint-config'),
+        rules: {
+            'yml/sort-keys': [
+                'error',
+                { order: ['ignores', { order: { type: 'asc' } }], pathPattern: '^$' },
+                { order: { type: 'asc' }, pathPattern: '^configs' },
+            ],
+            'yml/sort-sequence-values': [
+                'error',
+                { order: { type: 'asc' }, pathPattern: '^ignores' },
+            ],
+        },
+    },
+    {
+        files: ['.yarnrc.yml'],
+        name: namer('yarnrc'),
+        rules: {
+            'yml/sort-keys': ['error', { order: { type: 'asc' }, pathPattern: '^$' }],
+            'yml/sort-sequence-values': [
+                'error',
+                {
+                    order: ['.env?', { order: { type: 'asc' } }],
+                    pathPattern: '^injectEnvironmentFiles',
+                },
+            ],
+        },
+    },
+];

package/src/lib/extend-config.d.ts

@@ -0,0 +1,3 @@
+import type { Linter } from 'eslint';
+export declare function extendConfig(...configs: (Linter.Config | Linter.Config[])[]): Linter.Config[];
+//# sourceMappingURL=extend-config.d.ts.map

package/src/lib/extend-config.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"extend-config.d.ts","sourceRoot":"","sources":["../../../../../packages/eslint-plugin/src/lib/extend-config.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAA;AAEpC,wBAAgB,YAAY,CAAC,GAAG,OAAO,EAAE,CAAC,MAAM,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,CAAC,EAAE,GAqBpC,MAAM,CAAC,MAAM,EAAE,CACtD"}

package/src/lib/extend-config.js

@@ -0,0 +1,22 @@
+import { defineConfig } from 'eslint/config';
+export function extendConfig(...configs) {
+    const base = [
+        {
+            ignores: [
+                '.cache',
+                '.github',
+                '.nx',
+                '.pnp.*',
+                '.yarn',
+                'coverage',
+                'dist',
+                'node_modules',
+                'pnpm-lock.yaml',
+                'pnpm-workspace.yaml',
+                'tmp',
+            ],
+        },
+        { linterOptions: { reportUnusedDisableDirectives: 'error' } },
+    ];
+    return defineConfig(configs, base);
+}

package/src/lib/meta.d.ts

@@ -0,0 +1,3 @@
+import type { ESLint } from 'eslint';
+export declare const meta: ESLint.Plugin['meta'];
+//# sourceMappingURL=meta.d.ts.map

package/src/lib/meta.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"meta.d.ts","sourceRoot":"","sources":["../../../../../packages/eslint-plugin/src/lib/meta.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAA;AAKpC,eAAO,MAAM,IAAI,EAAE,MAAM,CAAC,MAAM,CAAC,MAAM,CAAqB,CAAA"}

package/src/lib/meta.js

@@ -0,0 +1,3 @@
+import pkg from '../../package.json' with { type: 'json' };
+const { name, version } = pkg;
+export const meta = { name, version };

package/src/lib/namer.d.ts

@@ -0,0 +1,24 @@
+import type { Linter } from 'eslint';
+/**
+ * Prepend the workspace's namespace or full name to a string. Useful for naming eslint configuration objects.
+ * @param value the value to add to the name
+ * @returns prefixed value
+ */
+export declare function namer(value?: string): string;
+/**
+ * Set the `name` property of an ESLint config.
+ * @param config the object
+ * @param defaultName override the default behavior of this function
+ * @returns the named config(s)
+ */
+export declare function objectNamer(config: Config, defaultName?: string): Named<Config>;
+/**
+ * Make the name property of an object required. Preserves JSDoc comments for objects that already have a name property.
+ */
+export type Named<T extends object> = Required<T extends N ? Pick<T, 'name'> : N> & T;
+type Config = Linter.Config;
+type N = {
+    name?: string;
+};
+export {};
+//# sourceMappingURL=namer.d.ts.map

package/src/lib/namer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"namer.d.ts","sourceRoot":"","sources":["../../../../../packages/eslint-plugin/src/lib/namer.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAA;AAIpC;;;;GAIG;AACH,wBAAgB,KAAK,CAAC,KAAK,CAAC,EAAE,MAAM,UAMnC;AAED;;;;;GAKG;AACH,wBAAgB,WAAW,CAAC,MAAM,EAAE,MAAM,EAAE,WAAW,CAAC,EAAE,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC,CAa/E;AAED;;GAEG;AACH,MAAM,MAAM,KAAK,CAAC,CAAC,SAAS,MAAM,IAAI,QAAQ,CAAC,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC,CAAC,EAAE,MAAM,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAA;AAErF,KAAK,MAAM,GAAG,MAAM,CAAC,MAAM,CAAA;AAE3B,KAAK,CAAC,GAAG;IAAE,IAAI,CAAC,EAAE,MAAM,CAAA;CAAE,CAAA"}

package/src/lib/namer.js

@@ -0,0 +1,36 @@
+import pkg from '../../package.json' with { type: 'json' };
+/**
+ * Prepend the workspace's namespace or full name to a string. Useful for naming eslint configuration objects.
+ * @param value the value to add to the name
+ * @returns prefixed value
+ */
+export function namer(value) {
+    const ws = /@[a-z-]+\/.+/i.exec(pkg.name)?.[0] ?? pkg.name;
+    if (value) {
+        return value.startsWith(ws) ? value : `${ws}/${value}`;
+    }
+    return ws;
+}
+/**
+ * Set the `name` property of an ESLint config.
+ * @param config the object
+ * @param defaultName override the default behavior of this function
+ * @returns the named config(s)
+ */
+export function objectNamer(config, defaultName) {
+    if (defaultName) {
+        return { ...config, name: defaultName };
+    }
+    else if (config.name) {
+        return config;
+    }
+    else if (config.plugins) {
+        const plugins = Object.keys(config.plugins);
+        return { ...config, name: namer(plugins[0]) };
+    }
+    else {
+        const rules = Object.keys(config.rules ?? {}).map(e => e.split('/')[0]);
+        const name = [...new Set(rules)].join('/');
+        return { ...config, name };
+    }
+}