@clipboard-health/eslint-config 2.4.14 → 3.0.1

package/src/index.d.ts

@@ -1,216 +1,54 @@
+declare const _extends: string[];
+export { _extends as extends };
 export declare const parser: string;
 export declare namespace parserOptions {
     const project: string[];
     const tsconfigRootDir: string;
 }
 export declare const plugins: string[];
-declare const _extends: string[];
-export { _extends as extends };
-export declare const root: boolean;
-export declare namespace env {
-    const es2022: boolean;
-    const node: boolean;
-    const jest: boolean;
-}
-export declare const ignorePatterns: string[];
 export declare const rules: {
-    "no-only-tests/no-only-tests": string;
-    "prefer-const": (string | {
-        destructuring: string;
-    })[];
-    "func-style": (string | {
-        allowArrowFunctions: boolean;
-    })[];
-    "sort-imports": string;
-    "simple-import-sort/imports": string;
-    "simple-import-sort/exports": string;
-    "@typescript-eslint/consistent-indexed-object-style": string[];
-    "@typescript-eslint/consistent-type-assertions": (string | {
-        assertionStyle: string;
-    })[];
-    "@typescript-eslint/explicit-module-boundary-types": (string | {
-        allowArgumentsExplicitlyTypedAsAny: boolean;
-    })[];
-    "@typescript-eslint/no-invalid-void-type": string;
-    "@typescript-eslint/no-explicit-any": string;
-    "@typescript-eslint/no-floating-promises": string;
-    "@typescript-eslint/no-meaningless-void-operator": string;
-    "@typescript-eslint/no-require-imports": string;
-    "@typescript-eslint/no-unnecessary-boolean-literal-compare": string;
-    "@typescript-eslint/no-var-requires": string;
-    "@typescript-eslint/prefer-enum-initializers": string;
-    "@typescript-eslint/prefer-for-of": string;
-    "@typescript-eslint/prefer-includes": string;
-    "@typescript-eslint/prefer-literal-enum-member": string;
-    "@typescript-eslint/prefer-nullish-coalescing": string;
-    "@typescript-eslint/prefer-optional-chain": string;
-    "@typescript-eslint/prefer-return-this-type": string;
-    "@typescript-eslint/prefer-string-starts-ends-with": string;
-    "@typescript-eslint/prefer-ts-expect-error": string;
-    "@typescript-eslint/switch-exhaustiveness-check": string;
-    "@typescript-eslint/unified-signatures": string;
-    "@typescript-eslint/no-throw-literal": string;
+    "@typescript-eslint/consistent-type-definitions": string[];
+    "@typescript-eslint/naming-convention": string;
+    "security/detect-object-injection": string;
     "@typescript-eslint/no-unused-vars": (string | {
-        ignoreRestSiblings: boolean;
-        varsIgnorePattern: string;
-        args: string;
         argsIgnorePattern: string;
     })[];
-    "array-callback-return": (string | {
-        allowImplicit: boolean;
-        checkForEach: boolean;
-    })[];
-    "no-var": string;
-    "@typescript-eslint/naming-convention": (string | {
-        selector: string;
-        format: string[];
-        modifiers?: never;
-        leadingUnderscore?: never;
-    } | {
-        selector: string[];
-        modifiers: string[];
-        format: null;
-        leadingUnderscore?: never;
-    } | {
-        selector: string;
-        modifiers: string[];
-        format: string[];
-        leadingUnderscore?: never;
-    } | {
-        selector: string[];
-        format: string[];
-        leadingUnderscore: string;
-        modifiers?: never;
-    } | {
-        selector: string[];
-        format: string[];
-        modifiers?: never;
-        leadingUnderscore?: never;
-    } | {
-        selector: string;
-        format: null;
-        modifiers?: never;
-        leadingUnderscore?: never;
-    } | {
-        selector: string[];
-        modifiers: string[];
-        leadingUnderscore: string;
-        format: null;
-    })[];
-    "consistent-return": string;
-    "default-case-last": string;
-    "@typescript-eslint/default-param-last": string;
-    "@typescript-eslint/dot-notation": (string | {
-        allowKeywords: boolean;
-    })[];
-    eqeqeq: string[];
-    "grouped-accessor-pairs": string;
-    "@typescript-eslint/lines-between-class-members": (string | {
-        exceptAfterSingleLine: boolean;
-    })[];
+    "no-return-await": string;
+    "@typescript-eslint/return-await": string[];
+    "capitalized-comments": (string | {
+        ignorePattern: string;
+    })[];
+    curly: string;
+    "class-methods-use-this": string;
+    "import/extensions": string;
+    "n/no-missing-import": string;
+    "n/no-unpublished-import": string;
+    "unicorn/prefer-module": string;
+    "import/no-extraneous-dependencies": string;
+    "import/no-unresolved": string;
+    "import/prefer-default-export": string;
     "new-cap": (string | {
         newIsCap: boolean;
         capIsNew: boolean;
     })[];
-    "no-alert": string;
-    "no-console": string;
-    "no-bitwise": string;
-    "no-constructor-return": string;
-    "no-eval": string;
-    "@typescript-eslint/no-implied-eval": string;
-    "no-lone-blocks": string;
-    "@typescript-eslint/no-loop-func": string;
-    "no-multi-assign": string;
-    "no-multi-str": string;
-    "no-new": string;
-    "no-new-func": string;
-    "no-new-object": string;
-    "no-new-require": string;
-    "no-new-wrappers": string;
-    "no-octal-escape": string;
-    "no-param-reassign": (string | {
-        props: boolean;
-    })[];
-    "no-restricted-globals": (string | {
-        name: string;
-        message: string;
-    })[];
-    "no-proto": string;
-    "no-extend-native": string;
-    "no-extra-label": string;
-    "no-iterator": string;
-    "no-label-var": string;
-    "no-script-url": string;
-    "no-sequences": string;
-    "no-restricted-properties": (string | {
-        object: string;
-        property: string;
-        message: string;
-    } | {
-        property: string;
+    "no-only-tests/no-only-tests": string;
+    "no-restricted-syntax": (string | {
+        selector: string;
         message: string;
-        object?: never;
     })[];
-    "no-self-compare": string;
-    "@typescript-eslint/no-shadow": string[];
-    "no-template-curly-in-string": string;
-    "no-undef-init": string;
-    "no-unneeded-ternary": (string | {
-        defaultAssignment: boolean;
-    })[];
-    "no-unreachable-loop": string[];
-    "@typescript-eslint/no-unused-expressions": string[];
-    "no-useless-computed-key": string;
-    "no-useless-concat": string;
-    "@typescript-eslint/no-useless-constructor": string;
-    "no-useless-rename": string[];
-    "no-useless-return": string;
-    "no-void": string;
-    "object-shorthand": (string | {
-        avoidQuotes: boolean;
-    })[];
-    "operator-assignment": string[];
-    "prefer-arrow-callback": string[];
-    "prefer-destructuring": (string | {
-        VariableDeclarator: {
-            array: boolean;
-            object: boolean;
-        };
-    })[];
-    "prefer-exponentiation-operator": string;
-    "prefer-numeric-literals": string;
-    "prefer-object-spread": string;
-    "prefer-promise-reject-errors": (string | {
-        allowEmptyReject: boolean;
-    })[];
-    "prefer-regex-literals": (string | {
-        disallowRedundantWrapping: boolean;
-    })[];
-    "prefer-template": string;
-    "spaced-comment": (string | {
-        line: {
-            exceptions: string[];
-            markers: string[];
-        };
-        block: {
-            exceptions: string[];
-            markers: string[];
-            balanced: boolean;
-        };
+    "no-shadow": string;
+    "object-shorthand": string[];
+    "simple-import-sort/imports": string;
+    "simple-import-sort/exports": string;
+    "unicorn/no-array-for-each": string;
+    "unicorn/no-array-reduce": string;
+    "unicorn/prevent-abbreviations": (string | {
+        ignore: RegExp[];
     })[];
-    strict: string[];
-    "symbol-description": string;
-    yoda: string[];
 };
-export declare const overrides: {
-    /**
-     * Prisma calls with relations can result in complex return types, which
-     * may be cumbersome to define explicitly. This override allows type
-     * inference in repository files that interact with Prisma.
-     */
-    files: string[];
-    rules: {
-        "@typescript-eslint/explicit-module-boundary-types": string;
-    };
-}[];
+export declare namespace settings {
+    namespace node {
+        const version: string;
+    }
+}
 //# sourceMappingURL=index.d.ts.map

package/src/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../packages/eslint-config/src/index.js"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IA0TM;;;;OAIG"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../packages/eslint-config/src/index.js"],"names":[],"mappings":""}

package/src/index.js

@@ -1,325 +1,98 @@
 "use strict";
-const MESSAGES = {
-    isFinite: "Please use Number.isFinite instead.",
-    isNaN: "Please use Number.isNaN instead.",
-};
 module.exports = {
+    extends: [
+        "airbnb-base",
+        "plugin:eslint-comments/recommended",
+        "plugin:jest/recommended",
+        "plugin:jest/style",
+        "plugin:import/recommended",
+        "plugin:n/recommended",
+        "plugin:no-use-extend-native/recommended",
+        "plugin:security/recommended",
+        "plugin:sonarjs/recommended",
+        "plugin:unicorn/recommended",
+        "prettier",
+        "xo",
+        "xo-typescript/space",
+    ],
     parser: "@typescript-eslint/parser",
     parserOptions: {
         project: ["tsconfig.json"],
         tsconfigRootDir: __dirname,
     },
-    plugins: ["@typescript-eslint/eslint-plugin", "no-only-tests", "simple-import-sort"],
-    extends: ["eslint:recommended", "plugin:@typescript-eslint/recommended", "prettier"],
-    root: true,
-    env: {
-        es2022: true,
-        node: true,
-        jest: true,
-    },
-    ignorePatterns: [".eslintrc.js"],
+    plugins: ["jest", "no-only-tests", "simple-import-sort", "sonarjs"],
     rules: {
+        // See https://github.com/microsoft/TypeScript/wiki/Performance#preferring-interfaces-over-intersections
+        "@typescript-eslint/consistent-type-definitions": ["error", "interface"],
+        // Too many false positives
+        "@typescript-eslint/naming-convention": "off",
+        "security/detect-object-injection": "off",
+        // Prefer an escape hatch instead of an outright ban
+        "@typescript-eslint/no-unused-vars": ["warn", { argsIgnorePattern: "^_" }],
+        // Prefer debugging ease over an extra microtask by requiring `return await`.
+        // `no-return-await` states "This can make debugging more difficult."
+        "no-return-await": "off",
+        "@typescript-eslint/return-await": ["error", "always"],
+        // Ignore `sonar-disable`/`sonar-enable` comments
+        "capitalized-comments": ["error", "always", { ignorePattern: "sonar" }],
+        // Prevent bugs
+        curly: "error",
+        // Recommends using static fields instead of moving to a function
+        "class-methods-use-this": "off",
+        // Our libraries don't use ESM
+        "import/extensions": "off",
+        "n/no-missing-import": "off",
+        "n/no-unpublished-import": "off",
+        "unicorn/prefer-module": "off",
+        // Rely on `"n/no-extraneous-import"` instead
+        "import/no-extraneous-dependencies": "off",
+        // Doesn't play well with NX/monorepos
+        "import/no-unresolved": "off",
+        // Prefer named exports
+        "import/prefer-default-export": "off",
+        // Allow PascalCase for Decorators
+        "new-cap": ["warn", { newIsCap: true, capIsNew: false }],
+        /*
+         * Don't allow `.only` in tests to prevent it from making it
+         * into `main` and circumventing our tests.
+         */
         "no-only-tests/no-only-tests": "error",
-        "prefer-const": [
-            "warn",
-            {
-                destructuring: "all",
-            },
-        ],
-        "func-style": [
-            "warn",
-            "declaration",
-            {
-                allowArrowFunctions: true,
-            },
-        ],
-        "sort-imports": "off",
-        "simple-import-sort/imports": "warn",
-        "simple-import-sort/exports": "warn",
-        "@typescript-eslint/consistent-indexed-object-style": ["warn", "record"],
-        "@typescript-eslint/consistent-type-assertions": [
-            "warn",
-            {
-                assertionStyle: "never",
-            },
-        ],
-        // Enabled by default - you can and should override this in overrides below
-        "@typescript-eslint/explicit-module-boundary-types": [
-            "warn",
-            // We already have 'no-explicit-any' on - no need to enforce it again
-            { allowArgumentsExplicitlyTypedAsAny: true },
-        ],
-        "@typescript-eslint/no-invalid-void-type": "warn",
-        "@typescript-eslint/no-explicit-any": "warn",
-        "@typescript-eslint/no-floating-promises": "warn",
-        "@typescript-eslint/no-meaningless-void-operator": "warn",
-        "@typescript-eslint/no-require-imports": "warn",
-        "@typescript-eslint/no-unnecessary-boolean-literal-compare": "warn",
-        "@typescript-eslint/no-var-requires": "off",
-        "@typescript-eslint/prefer-enum-initializers": "warn",
-        "@typescript-eslint/prefer-for-of": "warn",
-        "@typescript-eslint/prefer-includes": "warn",
-        "@typescript-eslint/prefer-literal-enum-member": "warn",
-        "@typescript-eslint/prefer-nullish-coalescing": "warn",
-        "@typescript-eslint/prefer-optional-chain": "warn",
-        "@typescript-eslint/prefer-return-this-type": "error",
-        "@typescript-eslint/prefer-string-starts-ends-with": "warn",
-        "@typescript-eslint/prefer-ts-expect-error": "warn",
-        "@typescript-eslint/switch-exhaustiveness-check": "warn",
-        "@typescript-eslint/unified-signatures": "warn",
-        "@typescript-eslint/no-throw-literal": "warn",
-        "@typescript-eslint/no-unused-vars": [
-            "warn",
-            {
-                ignoreRestSiblings: true,
-                varsIgnorePattern: "(^_)",
-                args: "all",
-                argsIgnorePattern: "(^_)",
-            },
-        ],
-        "array-callback-return": [
+        // Adapter from Airbnb's config, but allows ForOfStatement.
+        // See https://github.com/airbnb/javascript/blob/0f3ca32323b8d5770de3301036e65511c6d18e00/packages/eslint-config-airbnb-base/rules/style.js#L340-L358
+        "no-restricted-syntax": [
             "error",
             {
-                allowImplicit: true,
-                checkForEach: false,
-            },
-        ],
-        "no-var": "warn",
-        "@typescript-eslint/naming-convention": [
-            "warn",
-            {
-                selector: "default",
-                format: ["camelCase"],
-            },
-            // Ignore destructured variables
-            {
-                selector: ["variable", "parameter"],
-                modifiers: ["destructured"],
-                format: null,
-            },
-            // Additional cases for constants, enums
-            {
-                selector: "variable",
-                modifiers: ["const"],
-                format: ["camelCase", "UPPER_CASE", "PascalCase"],
-            },
-            {
-                selector: "enum",
-                format: ["PascalCase", "UPPER_CASE"],
-            },
-            {
-                selector: ["enumMember", "typeProperty"],
-                format: ["camelCase", "PascalCase", "UPPER_CASE", "snake_case"],
-                //
-                leadingUnderscore: "allow",
-            },
-            // Classes/interfaces/types
-            {
-                selector: ["class", "interface", "typeAlias", "typeParameter"],
-                format: ["PascalCase"],
-            },
-            // Ignore object literal props, e.g. in prisma calls
-            {
-                selector: "objectLiteralProperty",
-                format: null,
+                selector: "ForInStatement",
+                message: "for..in loops iterate over the entire prototype chain, which is virtually never what you want. Use Object.{keys,values,entries}, and iterate over the resulting array.",
             },
-            // Support unused variables
             {
-                selector: ["variable", "parameter"],
-                modifiers: ["unused"],
-                leadingUnderscore: "allow",
-                format: null,
+                selector: "LabeledStatement",
+                message: "Labels are a form of GOTO; using them makes code confusing and hard to maintain and understand.",
             },
-        ],
-        "consistent-return": "warn",
-        "default-case-last": "warn",
-        "@typescript-eslint/default-param-last": "error",
-        "@typescript-eslint/dot-notation": [
-            "warn",
-            {
-                allowKeywords: true,
-            },
-        ],
-        eqeqeq: ["error", "always"],
-        "grouped-accessor-pairs": "warn",
-        "@typescript-eslint/lines-between-class-members": [
-            "warn",
-            "always",
             {
-                exceptAfterSingleLine: true,
+                selector: "WithStatement",
+                message: "`with` is disallowed in strict mode because it makes code impossible to predict and optimize.",
             },
         ],
-        "new-cap": [
-            "warn",
-            {
-                newIsCap: true,
-                capIsNew: false,
-            },
-        ],
-        "no-alert": "warn",
-        "no-console": "warn",
-        "no-bitwise": "warn",
-        "no-constructor-return": "error",
-        "no-eval": "error",
-        "@typescript-eslint/no-implied-eval": "error",
-        "no-lone-blocks": "warn",
-        "@typescript-eslint/no-loop-func": "warn",
-        "no-multi-assign": "warn",
-        "no-multi-str": "warn",
-        "no-new": "warn",
-        "no-new-func": "error",
-        "no-new-object": "error",
-        "no-new-require": "error",
-        "no-new-wrappers": "error",
-        "no-octal-escape": "error",
-        "no-param-reassign": [
-            "warn",
-            {
-                props: false,
-            },
-        ],
-        "no-restricted-globals": [
-            "warn",
-            {
-                name: "isFinite",
-                message: "Use Number.isFinite instead https://github.com/airbnb/javascript#standard-library--isfinite",
-            },
-            {
-                name: "isNaN",
-                message: "Use Number.isNaN instead https://github.com/airbnb/javascript#standard-library--isnan",
-            },
-        ],
-        "no-proto": "warn",
-        "no-extend-native": "warn",
-        "no-extra-label": "warn",
-        "no-iterator": "warn",
-        "no-label-var": "warn",
-        "no-script-url": "warn",
-        "no-sequences": "warn",
-        "no-restricted-properties": [
-            "warn",
-            {
-                object: "global",
-                property: "isFinite",
-                message: MESSAGES.isFinite,
-            },
-            {
-                object: "self",
-                property: "isFinite",
-                message: MESSAGES.isFinite,
-            },
-            {
-                object: "window",
-                property: "isFinite",
-                message: MESSAGES.isFinite,
-            },
-            {
-                object: "global",
-                property: "isNaN",
-                message: MESSAGES.isNaN,
-            },
-            {
-                object: "self",
-                property: "isNaN",
-                message: MESSAGES.isNaN,
-            },
-            {
-                object: "window",
-                property: "isNaN",
-                message: MESSAGES.isNaN,
-            },
-            {
-                property: "__defineGetter__",
-                message: "Please use Object.defineProperty instead.",
-            },
-            {
-                property: "__defineSetter__",
-                message: "Please use Object.defineProperty instead.",
-            },
-        ],
-        "no-self-compare": "error",
-        "@typescript-eslint/no-shadow": ["warn"],
-        "no-template-curly-in-string": "error",
-        "no-undef-init": "warn",
-        "no-unneeded-ternary": [
-            "warn",
-            {
-                defaultAssignment: false,
-            },
-        ],
-        "no-unreachable-loop": ["warn"],
-        "@typescript-eslint/no-unused-expressions": ["warn"],
-        "no-useless-computed-key": "warn",
-        "no-useless-concat": "warn",
-        "@typescript-eslint/no-useless-constructor": "warn",
-        "no-useless-rename": ["warn"],
-        "no-useless-return": "warn",
-        "no-void": "off",
-        "object-shorthand": [
-            "warn",
-            "always",
-            {
-                avoidQuotes: true,
-            },
-        ],
-        "operator-assignment": ["warn", "always"],
-        "prefer-arrow-callback": ["warn"],
-        "prefer-destructuring": [
-            "warn",
-            {
-                VariableDeclarator: {
-                    array: false,
-                    object: true,
-                },
-            },
-        ],
-        "prefer-exponentiation-operator": "warn",
-        "prefer-numeric-literals": "warn",
-        "prefer-object-spread": "error",
-        "prefer-promise-reject-errors": [
-            "warn",
-            {
-                allowEmptyReject: true,
-            },
-        ],
-        "prefer-regex-literals": [
-            "warn",
-            {
-                disallowRedundantWrapping: true,
-            },
-        ],
-        "prefer-template": "warn",
-        "spaced-comment": [
-            "warn",
-            "always",
-            {
-                line: {
-                    exceptions: ["-", "+"],
-                    markers: ["=", "!", "/"],
-                },
-                block: {
-                    exceptions: ["-", "+"],
-                    markers: ["=", "!", ":", "::"],
-                    balanced: true,
-                },
-            },
+        // False positive on `enum`s
+        "no-shadow": "off",
+        /*
+         * Only enable for properties. Favor arrow functions, they don’t have a `this` reference,
+         * preventing accidental usage.
+         */
+        "object-shorthand": ["error", "properties"],
+        // Sort imports and exports
+        "simple-import-sort/imports": "warn",
+        "simple-import-sort/exports": "warn",
+        // "Better readability" is subjective
+        "unicorn/no-array-for-each": "off",
+        "unicorn/no-array-reduce": "off",
+        // Allow common, well understood abbreviations
+        "unicorn/prevent-abbreviations": [
+            "error",
+            { ignore: [/config/i, /params/i, /props/i, /ref/i] },
         ],
-        strict: ["warn", "never"],
-        "symbol-description": "warn",
-        yoda: ["warn"],
     },
-    overrides: [
-        {
-            /**
-             * Prisma calls with relations can result in complex return types, which
-             * may be cumbersome to define explicitly. This override allows type
-             * inference in repository files that interact with Prisma.
-             */
-            files: ["*.repository.ts"],
-            rules: {
-                "@typescript-eslint/explicit-module-boundary-types": "off",
-            },
-        },
-    ],
+    settings: { node: { version: ">=18.15.0" } },
 };
 //# sourceMappingURL=index.js.map