@msobiecki/eslint-config 8.38.2 → 8.39.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@msobiecki/eslint-config",
-  "version": "8.38.2",
+  "version": "8.39.0",
   "private": false,
   "description": "An ESLint shareable config for JavaScript/TypeScript ecosystem's.",
   "keywords": [
@@ -16,52 +16,51 @@
   },
   "license": "MIT",
   "author": "Michał Sobiecki <kontakt@codeshaker.pl>",
-  "main": "index.js",
+  "type": "module",
+  "main": "eslint.config.js",
   "scripts": {
+    "inspect": "npx eslint --inspect-config",
     "prepare": "husky",
-    "test": "jest",
+    "test": "NODE_OPTIONS='--experimental-vm-modules' jest",
     "test:watch": "jest --watch"
   },
   "dependencies": {
-    "eslint-config-airbnb": "^19.0.4",
-    "eslint-config-airbnb-typescript": "^18.0.0",
-    "eslint-config-next": "^15.0.3",
-    "eslint-config-prettier": "^9.1.0",
-    "eslint-plugin-compat": "^6.0.1",
-    "eslint-plugin-deprecation": "^3.0.0",
+    "@eslint/js": "^9.37.0",
+    "@next/eslint-plugin-next": "^15.5.6",
+    "eslint-plugin-compat": "^6.0.2",
     "eslint-plugin-eslint-comments": "^3.2.0",
-    "eslint-plugin-import": "^2.31.0",
-    "eslint-plugin-jest": "^28.9.0",
+    "eslint-plugin-import": "^2.32.0",
+    "eslint-plugin-jest": "^29.0.1",
     "eslint-plugin-jest-dom": "^5.5.0",
-    "eslint-plugin-jsdoc": "^50.5.0",
+    "eslint-plugin-jsdoc": "^61.1.4",
     "eslint-plugin-jsx-a11y": "^6.10.2",
-    "eslint-plugin-n": "^17.13.2",
-    "eslint-plugin-prettier": "^5.2.1",
-    "eslint-plugin-promise": "^7.1.0",
-    "eslint-plugin-react": "^7.37.2",
-    "eslint-plugin-react-hooks": "^5.2.0",
+    "eslint-plugin-n": "^17.23.1",
+    "eslint-plugin-prettier": "^5.5.4",
+    "eslint-plugin-promise": "^7.2.1",
+    "eslint-plugin-react": "^7.37.5",
+    "eslint-plugin-react-hooks": "^7.0.0",
     "eslint-plugin-security": "^3.0.1",
-    "eslint-plugin-storybook": "^0.11.0",
-    "eslint-plugin-testing-library": "^6.4.0",
-    "eslint-plugin-unicorn": "^56.0.0"
+    "eslint-plugin-storybook": "^9.1.12",
+    "eslint-plugin-testing-library": "^7.13.3",
+    "eslint-plugin-unicorn": "^61.0.2",
+    "typescript-eslint": "^8.46.1"
   },
   "devDependencies": {
-    "@commitlint/cli": "^19.5.0",
-    "@commitlint/config-conventional": "^19.5.0",
+    "@commitlint/cli": "^20.1.0",
+    "@commitlint/config-conventional": "^20.0.0",
     "@semantic-release/changelog": "^6.0.3",
     "@semantic-release/git": "^10.0.1",
-    "@swc/core": "^1.11.21",
-    "@swc/jest": "^0.2.37",
-    "@types/jest": "^29.5.14",
-    "eslint": "^8.57.1",
-    "husky": "^9.1.6",
-    "jest": "^29.7.0",
-    "lint-staged": "^15.2.10",
-    "prettier": "^3.3.3",
-    "semantic-release": "^24.2.7"
+    "@types/jest": "^30.0.0",
+    "eslint": "^9.37.0",
+    "husky": "^9.1.7",
+    "jest": "^30.2.0",
+    "lint-staged": "^16.2.4",
+    "prettier": "^3.6.2",
+    "semantic-release": "^25.0.0"
   },
   "peerDependencies": {
-    "eslint": "^8.0.0",
-    "prettier": "^3.0.0"
+    "eslint": "^9.0.0",
+    "prettier": "^3.0.0",
+    "typescript": "^5.0.0"
   }
 }

package/rules/base.js

@@ -0,0 +1,582 @@
+const baseRules = {
+  // enforce return statements in callbacks of array's methods
+  // https://eslint.org/docs/rules/array-callback-return
+  "array-callback-return": "error",
+
+  // treat var statements as if they were block scoped
+  // https://eslint.org/docs/rules/block-scoped-var
+  "block-scoped-var": "error",
+
+  // specify the maximum cyclomatic complexity allowed in a program
+  // https://eslint.org/docs/rules/complexity
+  complexity: ["off", 20],
+
+  // enforce that class methods use "this"
+  // https://eslint.org/docs/rules/class-methods-use-this
+  "class-methods-use-this": [
+    "error",
+    {
+      exceptMethods: [],
+    },
+  ],
+
+  // require return statements to either always or never specify values
+  // https://eslint.org/docs/rules/consistent-return
+  "consistent-return": "error",
+
+  // specify curly brace conventions for all control statements
+  // https://eslint.org/docs/rules/curly
+  curly: ["error", "multi-line"], // multiline
+
+  // require default case in switch statements
+  // https://eslint.org/docs/rules/default-case
+  "default-case": ["error", { commentPattern: "^no default$" }],
+
+  // Enforce default clauses in switch statements to be last
+  // https://eslint.org/docs/rules/default-case-last
+  "default-case-last": "error",
+
+  // https://eslint.org/docs/rules/default-param-last
+  "default-param-last": "error",
+
+  // encourages use of dot notation whenever possible
+  // https://eslint.org/docs/rules/dot-notation
+  "dot-notation": ["error", { allowKeywords: true }],
+
+  // require the use of === and !==
+  // https://eslint.org/docs/rules/eqeqeq
+  eqeqeq: ["error", "always", { null: "ignore" }],
+
+  // Require grouped accessor pairs in object literals and classes
+  // https://eslint.org/docs/rules/grouped-accessor-pairs
+  "grouped-accessor-pairs": "error",
+
+  // make sure for-in loops have an if statement
+  // https://eslint.org/docs/rules/guard-for-in
+  "guard-for-in": "error",
+
+  // enforce a maximum number of classes per file
+  // https://eslint.org/docs/rules/max-classes-per-file
+  "max-classes-per-file": ["error", 1],
+
+  // disallow the use of alert, confirm, and prompt
+  // https://eslint.org/docs/rules/no-alert
+  "no-alert": "warn",
+
+  // disallow use of arguments.caller or arguments.callee
+  // https://eslint.org/docs/rules/no-caller
+  "no-caller": "error",
+
+  // Disallow returning value in constructor
+  // https://eslint.org/docs/rules/no-constructor-return
+  "no-constructor-return": "error",
+
+  // disallow division operators explicitly at beginning of regular expression
+  // https://eslint.org/docs/rules/no-div-regex
+  "no-div-regex": "off",
+
+  // disallow else after a return in an if
+  // https://eslint.org/docs/rules/no-else-return
+  "no-else-return": ["error", { allowElseIf: false }],
+
+  // disallow empty functions, except for standalone funcs/arrows
+  // https://eslint.org/docs/rules/no-empty-function
+  "no-empty-function": [
+    "error",
+    {
+      allow: ["arrowFunctions", "functions", "methods"],
+    },
+  ],
+
+  // disallow comparisons to null without a type-checking operator
+  // https://eslint.org/docs/rules/no-eq-null
+  "no-eq-null": "off",
+
+  // disallow use of eval()
+  // https://eslint.org/docs/rules/no-eval
+  "no-eval": "error",
+
+  // disallow adding to native types
+  // https://eslint.org/docs/rules/no-extend-native
+  "no-extend-native": "error",
+
+  // disallow unnecessary function binding
+  // https://eslint.org/docs/rules/no-extra-bind
+  "no-extra-bind": "error",
+
+  // disallow Unnecessary Labels
+  // https://eslint.org/docs/rules/no-extra-label
+  "no-extra-label": "error",
+
+  // disallow implicit type conversions
+  // https://eslint.org/docs/rules/no-implicit-coercion
+  "no-implicit-coercion": [
+    "off",
+    {
+      boolean: false,
+      number: true,
+      string: true,
+      allow: [],
+    },
+  ],
+
+  // disallow use of eval()-like methods
+  // https://eslint.org/docs/rules/no-implied-eval
+  "no-implied-eval": "error",
+
+  // disallow usage of __iterator__ property
+  // https://eslint.org/docs/rules/no-iterator
+  "no-iterator": "error",
+
+  // disallow use of labels for anything other than loops and switches
+  // https://eslint.org/docs/rules/no-labels
+  "no-labels": ["error", { allowLoop: false, allowSwitch: false }],
+
+  // disallow unnecessary nested blocks
+  // https://eslint.org/docs/rules/no-lone-blocks
+  "no-lone-blocks": "error",
+
+  // disallow creation of functions within loops
+  // https://eslint.org/docs/rules/no-loop-func
+  "no-loop-func": "error",
+
+  // disallow use of multiline strings
+  // https://eslint.org/docs/rules/no-multi-str
+  "no-multi-str": "error",
+
+  // disallow use of new operator when not part of the assignment or comparison
+  // https://eslint.org/docs/rules/no-new
+  "no-new": "error",
+
+  // disallow use of new operator for Function object
+  // https://eslint.org/docs/rules/no-new-func
+  "no-new-func": "error",
+
+  // disallows creating new instances of String, Number, and Boolean
+  // https://eslint.org/docs/rules/no-new-wrappers
+  "no-new-wrappers": "error",
+
+  // disallow use of octal escape sequences in string literals, such as
+  // var foo = 'Copyright \251';
+  // https://eslint.org/docs/rules/no-octal-escape
+  "no-octal-escape": "error",
+
+  // disallow reassignment of function parameters
+  // disallow parameter object manipulation except for specific exclusions
+  // rule: https://eslint.org/docs/rules/no-param-reassign.html
+  "no-param-reassign": [
+    "error",
+    {
+      props: true,
+      ignorePropertyModificationsFor: [
+        "acc", // for reduce accumulators
+        "accumulator", // for reduce accumulators
+        "e", // for e.returnvalue
+        "ctx", // for Koa routing
+        "context", // for Koa routing
+        "req", // for Express requests
+        "request", // for Express requests
+        "res", // for Express responses
+        "response", // for Express responses
+        "$scope", // for Angular 1 scopes
+        "staticContext", // for ReactRouter context
+      ],
+    },
+  ],
+
+  // disallow usage of __proto__ property
+  // https://eslint.org/docs/rules/no-proto
+  "no-proto": "error",
+
+  // disallow certain object properties
+  // https://eslint.org/docs/rules/no-restricted-properties
+  "no-restricted-properties": [
+    "error",
+    {
+      object: "arguments",
+      property: "callee",
+      message: "arguments.callee is deprecated",
+    },
+    {
+      object: "global",
+      property: "isFinite",
+      message: "Please use Number.isFinite instead",
+    },
+    {
+      object: "self",
+      property: "isFinite",
+      message: "Please use Number.isFinite instead",
+    },
+    {
+      object: "window",
+      property: "isFinite",
+      message: "Please use Number.isFinite instead",
+    },
+    {
+      object: "global",
+      property: "isNaN",
+      message: "Please use Number.isNaN instead",
+    },
+    {
+      object: "self",
+      property: "isNaN",
+      message: "Please use Number.isNaN instead",
+    },
+    {
+      object: "window",
+      property: "isNaN",
+      message: "Please use Number.isNaN instead",
+    },
+    {
+      property: "__defineGetter__",
+      message: "Please use Object.defineProperty instead.",
+    },
+    {
+      property: "__defineSetter__",
+      message: "Please use Object.defineProperty instead.",
+    },
+    {
+      object: "Math",
+      property: "pow",
+      message: "Use the exponentiation operator (**) instead.",
+    },
+  ],
+
+  // disallow use of assignment in return statement
+  // https://eslint.org/docs/rules/no-return-assign
+  "no-return-assign": ["error", "always"],
+
+  // disallow use of `javascript:` urls.
+  // https://eslint.org/docs/rules/no-script-url
+  "no-script-url": "error",
+
+  // disallow comparisons where both sides are exactly the same
+  // https://eslint.org/docs/rules/no-self-compare
+  "no-self-compare": "error",
+
+  // disallow use of comma operator
+  // https://eslint.org/docs/rules/no-sequences
+  "no-sequences": "error",
+
+  // restrict what can be thrown as an exception
+  // https://eslint.org/docs/rules/no-throw-literal
+  "no-throw-literal": "error",
+
+  // disallow usage of expressions in statement position
+  // https://eslint.org/docs/rules/no-unused-expressions
+  "no-unused-expressions": [
+    "error",
+    {
+      allowShortCircuit: false,
+      allowTernary: false,
+      allowTaggedTemplates: false,
+    },
+  ],
+
+  // disallow useless string concatenation
+  // https://eslint.org/docs/rules/no-useless-concat
+  "no-useless-concat": "error",
+
+  // disallow use of void operator
+  // https://eslint.org/docs/rules/no-void
+  "no-void": "error",
+
+  // disallow usage of configurable warning terms in comments: e.g. todo
+  // https://eslint.org/docs/rules/no-warning-comments
+  "no-warning-comments": [
+    "off",
+    { terms: ["todo", "fixme", "xxx"], location: "start" },
+  ],
+
+  // require using Error objects as Promise rejection reasons
+  // https://eslint.org/docs/rules/prefer-promise-reject-errors
+  "prefer-promise-reject-errors": ["error", { allowEmptyReject: true }],
+
+  // https://eslint.org/docs/rules/prefer-regex-literals
+  "prefer-regex-literals": [
+    "error",
+    {
+      disallowRedundantWrapping: true,
+    },
+  ],
+
+  // require use of the second argument for parseInt()
+  // https://eslint.org/docs/rules/radix
+  radix: "error",
+
+  // requires to declare all vars on top of their containing scope
+  // https://eslint.org/docs/rules/vars-on-top
+  "vars-on-top": "error",
+
+  // require or disallow Yoda conditions
+  // https://eslint.org/docs/rules/yoda
+  yoda: "error",
+
+  // Disallow await inside of loops
+  // https://eslint.org/docs/rules/no-await-in-loop
+  "no-await-in-loop": "error",
+
+  // disallow use of console
+  "no-console": "warn",
+
+  // disallow function or variable declarations in nested blocks
+  "no-inner-declarations": "error",
+
+  // Disallow returning values from Promise executor functions
+  // https://eslint.org/docs/rules/no-promise-executor-return
+  "no-promise-executor-return": "error",
+
+  // Disallow template literal placeholder syntax in regular strings
+  // https://eslint.org/docs/rules/no-template-curly-in-string
+  "no-template-curly-in-string": "error",
+
+  // Disallow loops with a body that allows only one iteration
+  // https://eslint.org/docs/rules/no-unreachable-loop
+  "no-unreachable-loop": [
+    "error",
+    {
+      ignore: [], // WhileStatement, DoWhileStatement, ForStatement, ForInStatement, ForOfStatement
+    },
+  ],
+
+  // ensure that the results of typeof are compared against a valid string
+  // https://eslint.org/docs/rules/valid-typeof
+  "valid-typeof": ["error", { requireStringLiterals: true }],
+
+  // enforces no braces where they can be omitted
+  // https://eslint.org/docs/rules/arrow-body-style
+  // TODO: enable requireReturnForObjectLiteral?
+  "arrow-body-style": [
+    "error",
+    "as-needed",
+    {
+      requireReturnForObjectLiteral: false,
+    },
+  ],
+
+  // Disallow specified names in exports
+  // https://eslint.org/docs/rules/no-restricted-exports
+  "no-restricted-exports": [
+    "error",
+    {
+      restrictedNamedExports: [
+        "default", // use `export default` to provide a default export
+        "then", // this will cause tons of confusion when your module is dynamically `import()`ed, and will break in most node ESM versions
+      ],
+    },
+  ],
+
+  // disallow useless computed property keys
+  // https://eslint.org/docs/rules/no-useless-computed-key
+  "no-useless-computed-key": "error",
+
+  // disallow unnecessary constructor
+  // https://eslint.org/docs/rules/no-useless-constructor
+  "no-useless-constructor": "error",
+
+  // disallow renaming import, export, and destructured assignments to the same name
+  // https://eslint.org/docs/rules/no-useless-rename
+  "no-useless-rename": [
+    "error",
+    {
+      ignoreDestructuring: false,
+      ignoreImport: false,
+      ignoreExport: false,
+    },
+  ],
+
+  // require let or const instead of var
+  "no-var": "error",
+
+  // require method and property shorthand syntax for object literals
+  // https://eslint.org/docs/rules/object-shorthand
+  "object-shorthand": [
+    "error",
+    "always",
+    {
+      ignoreConstructors: false,
+      avoidQuotes: true,
+    },
+  ],
+
+  // suggest using arrow functions as callbacks
+  "prefer-arrow-callback": [
+    "error",
+    {
+      allowNamedFunctions: false,
+      allowUnboundThis: true,
+    },
+  ],
+
+  // suggest using of const declaration for variables that are never modified after declared
+  "prefer-const": [
+    "error",
+    {
+      destructuring: "any",
+      ignoreReadBeforeAssign: true,
+    },
+  ],
+
+  // Prefer destructuring from arrays and objects
+  // https://eslint.org/docs/rules/prefer-destructuring
+  "prefer-destructuring": [
+    "error",
+    {
+      VariableDeclarator: {
+        array: false,
+        object: true,
+      },
+      AssignmentExpression: {
+        array: true,
+        object: false,
+      },
+    },
+    {
+      enforceForRenamedProperties: false,
+    },
+  ],
+
+  // disallow parseInt() in favor of binary, octal, and hexadecimal literals
+  // https://eslint.org/docs/rules/prefer-numeric-literals
+  "prefer-numeric-literals": "error",
+
+  // use rest parameters instead of arguments
+  // https://eslint.org/docs/rules/prefer-rest-params
+  "prefer-rest-params": "error",
+
+  // suggest using the spread syntax instead of .apply()
+  // https://eslint.org/docs/rules/prefer-spread
+  "prefer-spread": "error",
+
+  // suggest using template literals instead of string concatenation
+  // https://eslint.org/docs/rules/prefer-template
+  "prefer-template": "error",
+
+  // require a Symbol description
+  // https://eslint.org/docs/rules/symbol-description
+  "symbol-description": "error",
+
+  // require camel case names
+  camelcase: ["error", { properties: "never", ignoreDestructuring: false }],
+
+  // enforce or disallow capitalization of the first letter of a comment
+  // https://eslint.org/docs/rules/capitalized-comments
+  "capitalized-comments": [
+    "off",
+    "never",
+    {
+      line: {
+        ignorePattern: ".*",
+        ignoreInlineComments: true,
+        ignoreConsecutiveComments: true,
+      },
+      block: {
+        ignorePattern: ".*",
+        ignoreInlineComments: true,
+        ignoreConsecutiveComments: true,
+      },
+    },
+  ],
+
+  // require function expressions to have a name
+  // https://eslint.org/docs/rules/func-names
+  "func-names": "warn",
+
+  // require a capital letter for constructors
+  "new-cap": [
+    "error",
+    {
+      newIsCap: true,
+      newIsCapExceptions: [],
+      capIsNew: false,
+      capIsNewExceptions: ["Immutable.Map", "Immutable.Set", "Immutable.List"],
+    },
+  ],
+
+  // disallow use of the Array constructor
+  "no-array-constructor": "error",
+
+  // disallow use of bitwise operators
+  // https://eslint.org/docs/rules/no-bitwise
+  "no-bitwise": "error",
+
+  // disallow use of the continue statement
+  // https://eslint.org/docs/rules/no-continue
+  "no-continue": "error",
+
+  // disallow if as the only statement in an else block
+  // https://eslint.org/docs/rules/no-lonely-if
+  "no-lonely-if": "error",
+
+  // disallow use of chained assignment expressions
+  // https://eslint.org/docs/rules/no-multi-assign
+  "no-multi-assign": ["error"],
+
+  // disallow use of unary operators, ++ and --
+  // https://eslint.org/docs/rules/no-plusplus
+  "no-plusplus": "error",
+
+  // disallow certain syntax forms
+  // https://eslint.org/docs/rules/no-restricted-syntax
+  "no-restricted-syntax": [
+    "error",
+    {
+      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.",
+    },
+    {
+      selector: "ForOfStatement",
+      message:
+        "iterators/generators require regenerator-runtime, which is too heavyweight for this guide to allow them. Separately, loops should be avoided in favor of array iterations.",
+    },
+    {
+      selector: "LabeledStatement",
+      message:
+        "Labels are a form of GOTO; using them makes code confusing and hard to maintain and understand.",
+    },
+    {
+      selector: "WithStatement",
+      message:
+        "`with` is disallowed in strict mode because it makes code impossible to predict and optimize.",
+    },
+  ],
+
+  // disallow dangling underscores in identifiers
+  // https://eslint.org/docs/rules/no-underscore-dangle
+  "no-underscore-dangle": [
+    "error",
+    {
+      allow: [],
+      allowAfterThis: false,
+      allowAfterSuper: false,
+      enforceInMethodNames: true,
+    },
+  ],
+
+  // disallow the use of Boolean literals in conditional expressions
+  // also, prefer `a || b` over `a ? a : b`
+  // https://eslint.org/docs/rules/no-unneeded-ternary
+  "no-unneeded-ternary": ["error", { defaultAssignment: false }],
+
+  // allow just one var statement per function
+  "one-var": ["error", "never"],
+
+  // require assignment operator shorthand where possible or prohibit it entirely
+  // https://eslint.org/docs/rules/operator-assignment
+  "operator-assignment": ["error", "always"],
+
+  // Disallow the use of Math.pow in favor of the ** operator
+  // https://eslint.org/docs/rules/prefer-exponentiation-operator
+  "prefer-exponentiation-operator": "error",
+
+  // Prefer use of an object spread over Object.assign
+  // https://eslint.org/docs/rules/prefer-object-spread
+  "prefer-object-spread": "error",
+
+  // require or disallow the Unicode Byte Order Mark
+  // https://eslint.org/docs/rules/unicode-bom
+  "unicode-bom": ["error", "never"],
+};
+
+export default baseRules;