common.js

import importPlugin from "eslint-plugin-import";
import jsdoc from "eslint-plugin-jsdoc";
import promise from "eslint-plugin-promise";
import unicorn from "eslint-plugin-unicorn";
import globals from "globals";
import ignores from "./ignores.js";

/** @type {import("eslint").Linter.FlatConfig[]} */
export default [
    {
        ignores: ignores[0].ignores,

        languageOptions: {
            ecmaVersion: "latest",
            globals: {
                ...globals.es2021
            },
            parserOptions: {
                ecmaFeatures: {
                    globalReturn: false,
                    impliedStrict: true
                }
            }
        },
        linterOptions: {
            reportUnusedDisableDirectives: "warn"
        },
        plugins: {
            import: importPlugin,
            jsdoc,
            unicorn,
            promise
        },
        rules: {
            // Possible Errors
            "array-callback-return": "error",
            "constructor-super": "error",
            "for-direction": "error",
            "getter-return": "error",
            "no-async-promise-executor": "error",
            "no-await-in-loop": "warn",
            "no-class-assign": "error",
            "no-compare-neg-zero": "error",
            "no-cond-assign": "error",
            "no-const-assign": "error",
            "no-constant-binary-expression": "error",
            "no-constant-condition": "error",
            "no-constructor-return": "error",
            "no-control-regex": "error",
            "no-debugger": "error",
            "no-dupe-args": "error",
            "no-dupe-class-members": "error",
            "no-dupe-else-if": "error",
            "no-dupe-keys": "error",
            "no-duplicate-case": "error",
            "no-duplicate-imports": "off", // Replaced by import/no-duplicates
            "no-empty-character-class": "error",
            "no-empty-pattern": "error",
            "no-ex-assign": "error",
            "no-fallthrough": "error",
            "no-func-assign": "error",
            "no-import-assign": "error",
            "no-inner-declarations": "error",
            "no-invalid-regexp": "error",
            "no-irregular-whitespace": "error",
            "no-loss-of-precision": "error",
            "no-misleading-character-class": "error",
            "no-new-native-nonconstructor": "error",
            "no-new-symbol": "error",
            "no-obj-calls": "error",
            "no-promise-executor-return": "error",
            "no-prototype-builtins": "error",
            "no-self-assign": "error",
            "no-self-compare": "error",
            "no-setter-return": "error",
            "no-sparse-arrays": "error",
            "no-template-curly-in-string": "error",
            "no-this-before-super": "error",
            "no-undef": "error",
            "no-unexpected-multiline": "error",
            "no-unmodified-loop-condition": "error",
            "no-unreachable": "error",
            "no-unreachable-loop": "error",
            "no-unsafe-finally": "error",
            "no-unsafe-negation": "error",
            "no-unsafe-optional-chaining": "error",
            "no-unused-private-class-members": "warn",
            "no-unused-vars": ["error", {
                caughtErrors: "all",
                destructuredArrayIgnorePattern: "^_"
            }],
            "no-use-before-define": [
                "error",
                {
                    classes: true,
                    functions: false,
                    variables: true
                }
            ],
            "no-useless-backreference": "error",
            "require-atomic-updates": "error",
            "use-isnan": "error",
            "valid-typeof": "error",

            // Suggestions
            "accessor-pairs": "warn",
            "arrow-body-style": ["warn", "as-needed"],
            "block-scoped-var": "error",
            camelcase: ["warn", {
                ignoreDestructuring: true,
                ignoreGlobals: true
            }],
            "consistent-return": "error",
            "consistent-this": ["warn", "self"],
            curly: ["error", "multi-line", "consistent"],
            "default-case": "warn",
            "default-case-last": "warn",
            "default-param-last": "warn",
            "dot-notation": "error",
            eqeqeq: ["error", "smart"],
            "func-name-matching": ["warn", "always"],
            "func-names": ["warn", "as-needed"],
            "func-style": ["warn", "declaration", { allowArrowFunctions: true }],
            "grouped-accessor-pairs": ["warn", "getBeforeSet"],
            "guard-for-in": "warn",
            "id-length": [
                "warn",
                {
                    exceptions: ["_", "$", "a", "b", "c", "x", "y", "z", "i"],
                    min: 2
                }
            ],
            "logical-assignment-operators": ["warn", "always"],
            "new-cap": "warn",
            "no-alert": "warn",
            "no-array-constructor": "warn",
            "no-caller": "error",
            "no-case-declarations": "error",
            "no-delete-var": "error",
            "no-div-regex": "error",
            "no-else-return": "warn", // To prefer guard clauses and early returns
            "no-empty": "error",
            "no-empty-function": "warn", // If it's empty, you should add a comment explaining why
            "no-empty-static-block": "warn",
            "no-eq-null": "error",
            "no-eval": "error",
            "no-extend-native": "error",
            "no-extra-bind": "error",
            "no-extra-boolean-cast": "error",
            "no-extra-label": "error",
            "no-global-assign": "error",
            "no-implicit-coercion": "error",
            "no-implicit-globals": "error",
            "no-implied-eval": "error",
            "no-invalid-this": "error",
            "no-iterator": "error",
            "no-label-var": "error",
            "no-labels": "error",
            "no-lone-blocks": "error",
            "no-lonely-if": "error",
            "no-loop-func": "error",
            "no-multi-assign": ["warn", { ignoreNonDeclaration: true }],
            "no-multi-str": "warn",
            "no-negated-condition": "off", // Replaced by unicorn/no-negated-condition
            "no-nested-ternary": "off",  // Replaced by unicorn/no-nested-ternary
            "no-new-func": "error",
            "no-new-wrappers": "error",
            "no-nonoctal-decimal-escape": "error",
            "no-object-constructor": "error",
            "no-octal": "error",
            "no-octal-escape": "error",
            "no-param-reassign": "error",
            "no-proto": "error",
            "no-redeclare": "error",
            "no-regex-spaces": "error",
            "no-return-assign": "error",
            "no-script-url": "error",
            "no-sequences": "error",
            "no-shadow": [
                "error",
                {
                    builtinGlobals: false,
                    hoist: "all"
                }
            ],
            "no-shadow-restricted-names": "error",
            "no-throw-literal": "error",
            "no-undef-init": "error",
            "no-unneeded-ternary": "error",
            "no-unused-expressions": "warn",
            "no-unused-labels": "error",
            "no-useless-call": "error",
            "no-useless-catch": "error",
            "no-useless-computed-key": "warn",
            "no-useless-concat": "warn",
            "no-useless-constructor": "warn",
            "no-useless-escape": "error",
            "no-useless-rename": [
                "warn",
                {
                    ignoreDestructuring: false,
                    ignoreExport: false,
                    ignoreImport: false
                }
            ],
            "no-useless-return": "warn",
            "no-var": "error",
            "no-warning-comments": "off", // The term TODO is handled by unicorn/expiring-todo-comments
            "no-with": "error",
            "object-shorthand": "warn",
            "one-var": ["warn", "never"],
            "operator-assignment": ["warn", "always"],
            "prefer-arrow-callback": "error",
            "prefer-const": "error",
            "prefer-exponentiation-operator": "warn",
            "prefer-named-capture-group": "warn",
            "prefer-numeric-literals": "error",
            "prefer-object-has-own": "error",
            "prefer-object-spread": "error",
            "prefer-promise-reject-errors": "error",
            "prefer-regex-literals": ["warn", { disallowRedundantWrapping: true }],
            "prefer-rest-params": "error",
            "prefer-spread": "error",
            "prefer-template": "error",
            radix: "warn",
            "require-await": "warn",
            "require-unicode-regexp": "warn",
            "require-yield": "error",
            "sort-vars": "warn",
            strict: ["error", "never"],
            "symbol-description": "error",
            "vars-on-top": "warn",
            yoda: ["error", "never"],

            // Layout and Formatting
            "unicode-bom": ["error", "never"],

            // Import Rules
            "import/consistent-type-specifier-style": ["warn", "prefer-top-level"],
            "import/export": "warn",
            "import/first": "error",
            "import/newline-after-import": "error",
            "import/no-absolute-path": "error",
            "import/no-amd": "error",
            "import/no-duplicates": "error",
            "import/no-dynamic-require": "error",
            "import/no-empty-named-blocks": "error",
            "import/no-extraneous-dependencies": [
                "error",
                {
                    devDependencies: true,
                    optionalDependencies: true,
                    peerDependencies: true
                }
            ],
            "import/no-mutable-exports": "error",
            "import/no-self-import": "error",
            "import/no-useless-path-segments": "error",
            "import/no-webpack-loader-syntax": "error",
            "import/order": [
                "error",
                {
                    alphabetize: {
                        caseInsensitive: false,
                        order: "asc"
                    },
                    groups: ["builtin", "external", "internal", "parent", "sibling", "index"],
                    "newlines-between": "ignore"
                }
            ],

            // JSDoc Rules
            "jsdoc/check-access": "error",
            "jsdoc/check-alignment": "error",
            "jsdoc/check-param-names": "error",
            "jsdoc/check-property-names": "error",
            "jsdoc/check-syntax": "error",
            "jsdoc/check-tag-names": "error",
            "jsdoc/check-types": "error",
            "jsdoc/check-values": "error",
            "jsdoc/empty-tags": "error",
            "jsdoc/implements-on-classes": "error",
            "jsdoc/multiline-blocks": [
                "error",
                {
                    noMultilineBlocks: false,
                    noSingleLineBlocks: true
                }
            ],
            "jsdoc/no-bad-blocks": "error",
            "jsdoc/no-blank-blocks": "error",
            "jsdoc/no-blank-block-descriptions": "error",
            "jsdoc/no-defaults": "error",
            "jsdoc/no-multi-asterisks": "error",
            "jsdoc/no-undefined-types": "error",
            "jsdoc/require-asterisk-prefix": "error",
            "jsdoc/require-param-name": "error",
            "jsdoc/require-property": "error",
            "jsdoc/require-property-description": "error",
            "jsdoc/require-property-name": "error",
            "jsdoc/require-property-type": "error",
            "jsdoc/tag-lines": [
                "error",
                "never",
                {
                    startLines: 1
                }
            ],
            "jsdoc/valid-types": "error",

            // Unicorn Rules
            "unicorn/better-regex": "warn",
            "unicorn/catch-error-name": ["warn", { name: "error" }],
            "unicorn/consistent-destructuring": "warn",
            "unicorn/consistent-function-scoping": "error",
            "unicorn/custom-error-definition": "error",
            "unicorn/empty-brace-spaces": "warn",
            "unicorn/error-message": "error",
            "unicorn/escape-case": "warn",
            "unicorn/expiring-todo-comments": ["warn", { allowWarningComments: false }],
            "unicorn/explicit-length-check": "warn",
            "unicorn/filename-case": ["warn", {
                cases: {
                    camelCase: true,
                    pascalCase: true
                }
            }],
            "unicorn/import-style": "warn",
            "unicorn/new-for-builtins": "error",
            "unicorn/no-abusive-eslint-disable": "error",
            "unicorn/no-array-callback-reference": "error",
            "unicorn/no-array-for-each": "warn",
            "unicorn/no-array-method-this-argument": "error",
            "unicorn/no-array-push-push": "warn",
            "unicorn/no-await-expression-member": "warn",
            "unicorn/no-console-spaces": "warn",
            "unicorn/no-document-cookie": "error",
            "unicorn/no-empty-file": "error",
            "unicorn/no-for-loop": "warn",
            "unicorn/no-hex-escape": "error",
            "unicorn/no-instanceof-array": "error",
            "unicorn/no-invalid-remove-event-listener": "error",
            "unicorn/no-lonely-if": "error", // Used together with no-lonely-if from eslint rules as it's recommended
            "unicorn/no-negated-condition": "error", // Replaces no-negated-condition from eslint rules
            "unicorn/no-nested-ternary": "error", // Replaces no-nested-ternary from eslint rules
            "unicorn/no-new-array": "error",
            "unicorn/no-new-buffer": "error",
            "unicorn/no-object-as-default-parameter": "error",
            "unicorn/no-static-only-class": "warn",
            "unicorn/no-thenable": "error",
            "unicorn/no-this-assignment": "error",
            "unicorn/no-typeof-undefined": "error",
            "unicorn/no-unnecessary-await": "error",
            "unicorn/no-unnecessary-polyfills": "error",
            "unicorn/no-unreadable-array-destructuring": "error",
            "unicorn/no-unreadable-iife": "error",
            "unicorn/no-unsafe-regex": "error",
            "unicorn/no-unused-properties": "warn",
            "unicorn/no-useless-fallback-in-spread": "error",
            "unicorn/no-useless-length-check": "error",
            "unicorn/no-useless-promise-resolve-reject": "error",
            "unicorn/no-useless-spread": "error",
            "unicorn/no-useless-switch-case": "error",
            "unicorn/no-useless-undefined": "warn",
            "unicorn/no-zero-fractions": "error",
            "unicorn/number-literal-case": "error",
            "unicorn/numeric-separators-style": [
                "error",
                {
                    hexadecimal: {
                        onlyIfContainsSeparator: true
                    },
                    binary: {
                        onlyIfContainsSeparator: true
                    },
                    octal: {
                        onlyIfContainsSeparator: true
                    },
                    number: {
                        groupLength: 3,
                        minimumDigits: 0
                    }
                }
            ],
            "unicorn/prefer-array-find": "error",
            "unicorn/prefer-array-flat": "error",
            "unicorn/prefer-array-flat-map": "error",
            "unicorn/prefer-array-index-of": "error",
            "unicorn/prefer-array-some": "error",
            "unicorn/prefer-at": "warn",
            "unicorn/prefer-blob-reading-methods": "warn",
            "unicorn/prefer-code-point": "error",
            "unicorn/prefer-date-now": "error",
            "unicorn/prefer-default-parameters": "warn",
            "unicorn/prefer-export-from": "error",
            "unicorn/prefer-includes": "error",
            "unicorn/prefer-keyboard-event-key": "error",
            "unicorn/prefer-logical-operator-over-ternary": "error",
            "unicorn/prefer-math-trunc": "error",
            "unicorn/prefer-modern-math-apis": "warn",
            "unicorn/prefer-module": "off", // Add @hazmi35/eslint-config/modules config
            "unicorn/prefer-native-coercion-functions": "error",
            "unicorn/prefer-negative-index": "warn",
            "unicorn/prefer-node-protocol": "off", // Add @hazmi35/eslint-config/node config
            "unicorn/prefer-number-properties": "error",
            "unicorn/prefer-object-from-entries": "error",
            "unicorn/prefer-optional-catch-binding": "warn",
            "unicorn/prefer-query-selector": "error",
            "unicorn/prefer-reflect-apply": "error",
            "unicorn/prefer-regexp-test": "error",
            "unicorn/prefer-set-has": "warn",
            "unicorn/prefer-set-size": "warn",
            "unicorn/prefer-spread": "error",
            "unicorn/prefer-string-replace-all": "error",
            "unicorn/prefer-string-slice": "error",
            "unicorn/prefer-string-starts-ends-with": "error",
            "unicorn/prefer-string-trim-start-end": "error",
            "unicorn/prefer-switch": "warn",
            "unicorn/prefer-ternary": "warn",
            "unicorn/prefer-top-level-await": "off", // Add @hazmi35/eslint-config/modules config
            "unicorn/prefer-type-error": "error",
            "unicorn/relative-url-style": ["error", "never"],
            "unicorn/require-array-join-separator": "error",
            "unicorn/require-number-to-fixed-digits-argument": "warn",
            "unicorn/require-post-message-target-origin": "warn",
            "unicorn/template-indent": "error",
            "unicorn/text-encoding-identifier-case": "warn",
            "unicorn/throw-new-error": "error",

            // Promise Rules
            "promise/always-return": "error",
            "promise/catch-or-return": "error",
            "promise/no-callback-in-promise": "warn",
            "promise/no-multiple-resolved": "error",
            "promise/no-nesting": "warn",
            "promise/no-new-statics": "error",
            "promise/no-promise-in-callback": "warn",
            "promise/no-return-in-finally": "off",
            "promise/no-return-wrap": "error",
            "promise/param-names": "warn",
            "promise/prefer-await-to-callbacks": "warn",
            "promise/prefer-await-to-then": "error",
            "promise/valid-params": "error"
        },

        settings: {
            "import/extensions": [".js"],
            "import/resolver": {
                node: {
                    extensions: [".js"]
                }
            }
        }
    }
];