UNPKG

eslint-config-xaxa

Version:

The ultimate ESLint config - successor to Airbnb Config. Built on Anthony Fu's ESLint config, Airbnb, ESLint Stylistic, Perfectionist, React, TypeScript, Astro, JSDocs, Prettier, Node.js, Unicorns, Promises, and more.

1,452 lines (1,174 loc) 66.6 kB
/* eslint-disable max-len */ /* eslint-disable ts/ban-ts-comment */ import type { Linter } from 'eslint'; import { GLOB_SRC, type TypedFlatConfigItem } from '@antfu/eslint-config'; import confusingBrowserGlobals from 'confusing-browser-globals'; import globals from 'globals'; import { pluginImport, pluginNode, pluginStylistic } from '../plugins.ts'; export const airbnbBestPractices: TypedFlatConfigItem = { name: 'airbnb/best-practices', plugins: { node: pluginNode, style: pluginStylistic }, rules: { // enforces getter/setter pairs in objects // https://eslint.org/docs/rules/accessor-pairs 'accessor-pairs': 'off', // enforces return statements in callbacks of array's methods // https://eslint.org/docs/rules/array-callback-return 'array-callback-return': ['error', { allowImplicit: true }], // treat var statements as if they were block scoped // https://eslint.org/docs/rules/block-scoped-var 'block-scoped-var': 'error', // enforce that class methods use "this" // https://eslint.org/docs/rules/class-methods-use-this 'class-methods-use-this': ['error', { exceptMethods: [] }], // specify the maximum cyclomatic complexity allowed in a program // https://eslint.org/docs/rules/complexity 'complexity': ['error', 40], // 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 lexical declarations in case/default clauses // https://eslint.org/docs/rules/no-case-declarations 'no-case-declarations': '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': ['error', { allowEmptyCatch: true }], // disallow empty destructuring patterns // https://eslint.org/docs/rules/no-empty-pattern 'no-empty-pattern': 'error', // Disallow empty static blocks // https://eslint.org/docs/latest/rules/no-empty-static-block 'no-empty-static-block': 'off', // 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 fallthrough of case statements // https://eslint.org/docs/rules/no-fallthrough 'no-fallthrough': 'error', // disallow reassignments of native objects or read-only globals // https://eslint.org/docs/rules/no-global-assign 'no-global-assign': ['error', { exceptions: [] }], // disallow implicit type conversions // https://eslint.org/docs/rules/no-implicit-coercion 'no-implicit-coercion': ['off', { allow: [], boolean: false, number: true, string: true, }], // disallow var and named functions in global scope // https://eslint.org/docs/rules/no-implicit-globals 'no-implicit-globals': 'off', // disallow use of eval()-like methods // https://eslint.org/docs/rules/no-implied-eval 'no-implied-eval': 'error', // https://eslint.org/docs/rules/no-import-assign 'no-import-assign': 'error', // disallow this keywords outside of classes or class-like objects // https://eslint.org/docs/rules/no-invalid-this 'no-invalid-this': 'off', // 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 magic numbers // https://eslint.org/docs/rules/no-magic-numbers 'no-magic-numbers': ['off', { detectObjects: false, enforceConst: true, ignore: [], ignoreArrayIndexes: true, }], // 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 \8 and \9 escape sequences in string literals // https://eslint.org/docs/rules/no-nonoctal-decimal-escape 'no-nonoctal-decimal-escape': 'error', // Disallow calls to the Object constructor without an argument // https://eslint.org/docs/latest/rules/no-object-constructor // yes, we know that it's just a convention, allow me Airbnb. 'no-object-constructor': 'off', // disallow use of (old style) octal literals // https://eslint.org/docs/rules/no-octal 'no-octal': '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', { ignorePropertyModificationsFor: [ // in addition to airbnb's 'err', 'x', '_', 'opts', 'flags', 'options', 'settings', 'config', 'cfg', // airbnb defaults '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 ], props: true, }], // disallow usage of __proto__ property // https://eslint.org/docs/rules/no-proto 'no-proto': 'error', // disallow declaring the same variable more than once // https://eslint.org/docs/rules/no-redeclare 'no-redeclare': 'error', // disallow certain object properties // https://eslint.org/docs/rules/no-restricted-properties 'no-restricted-properties': ['error', { message: 'arguments.callee is deprecated', object: 'arguments', property: 'callee', }, { message: 'Please use Number.isFinite instead', 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.isNaN 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 Object.defineProperty instead.', property: '__defineGetter__', }, { message: 'Please use Object.defineProperty instead.', property: '__defineSetter__', }, { message: 'Use the exponentiation operator (**) instead.', object: 'Math', property: 'pow', }], // disallow use of assignment in return statement // https://eslint.org/docs/rules/no-return-assign 'no-return-assign': ['error', 'always'], // disallow redundant `return await` // https://eslint.org/docs/rules/no-return-await 'no-return-await': 'error', // disallow use of `javascript:` urls. // https://eslint.org/docs/rules/no-script-url 'no-script-url': 'error', // disallow self assignment // https://eslint.org/docs/rules/no-self-assign 'no-self-assign': ['error', { props: true }], // 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 unmodified conditions of loops // https://eslint.org/docs/rules/no-unmodified-loop-condition 'no-unmodified-loop-condition': 'off', // disallow use of optional chaining in contexts where the undefined value is not allowed // https://eslint.org/docs/rules/no-unsafe-optional-chaining 'no-unsafe-optional-chaining': ['error', { disallowArithmeticOperators: true, }], // disallow usage of expressions in statement position // https://eslint.org/docs/rules/no-unused-expressions 'no-unused-expressions': ['error', { allowShortCircuit: false, allowTaggedTemplates: false, allowTernary: false, }], // disallow unused labels // https://eslint.org/docs/rules/no-unused-labels 'no-unused-labels': 'error', // disallow unnecessary .call() and .apply() // https://eslint.org/docs/rules/no-useless-call 'no-useless-call': 'off', // Disallow unnecessary catch clauses // https://eslint.org/docs/rules/no-useless-catch 'no-useless-catch': 'error', // disallow useless string concatenation // https://eslint.org/docs/rules/no-useless-concat 'no-useless-concat': 'error', // disallow unnecessary string escaping // https://eslint.org/docs/rules/no-useless-escape 'no-useless-escape': 'error', // disallow redundant return; keywords // https://eslint.org/docs/rules/no-useless-return 'no-useless-return': 'error', // disallow use of void operator // https://eslint.org/docs/rules/no-void 'no-void': 'off', // disallow usage of configurable warning terms in comments: e.g. todo // https://eslint.org/docs/rules/no-warning-comments 'no-warning-comments': ['off', { location: 'start', terms: ['todo', 'fixme', 'xxx'], }], // disallow use of the with statement // https://eslint.org/docs/rules/no-with 'no-with': 'error', // Suggest using named capture group in regular expression // https://eslint.org/docs/rules/prefer-named-capture-group 'prefer-named-capture-group': 'error', // Prefer Object.hasOwn() over Object.prototype.hasOwnProperty.call() // https://eslint.org/docs/rules/prefer-object-has-own 'prefer-object-has-own': 'error', // 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': 'off', // require `await` in `async function` (note: this is a horrible rule that should never be used) // https://eslint.org/docs/rules/require-await 'require-await': 'off', // Enforce the use of u flag on RegExp // https://eslint.org/docs/rules/require-unicode-regexp 'require-unicode-regexp': 'error', // enforces consistent newlines before or after dots // https://eslint.org/docs/rules/dot-location 'style/dot-location': ['error', 'property'], // https://eslint.org/docs/rules/function-call-argument-newline 'style/function-call-argument-newline': ['error', 'consistent'], // disallow the use of leading or trailing decimal points in numeric literals // https://eslint.org/docs/rules/no-floating-decimal 'style/no-floating-decimal': 'error', // disallow use of multiple spaces // https://eslint.org/docs/rules/no-multi-spaces 'style/no-multi-spaces': ['error', { ignoreEOLComments: false }], // deprecated in favor of no-global-assign // https://eslint.org/docs/rules/no-native-reassign 'style/no-native-reassign': 'off', // require immediate function invocation to be wrapped in parentheses // https://eslint.org/docs/rules/wrap-iife.html 'style/wrap-iife': ['error', 'outside', { functionPrototypeMethods: false }], // 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', }, }; export const airbnbErrors: TypedFlatConfigItem = { name: 'airbnb/errors', plugins: { style: pluginStylistic }, rules: { // Enforce “for” loop update clause moving the counter in the right direction // https://eslint.org/docs/rules/for-direction 'for-direction': 'error', // Enforces that a return statement is present in property getters // https://eslint.org/docs/rules/getter-return 'getter-return': ['error', { allowImplicit: true }], // disallow using an async function as a Promise executor // https://eslint.org/docs/rules/no-async-promise-executor 'no-async-promise-executor': 'error', // Disallow await inside of loops // https://eslint.org/docs/rules/no-await-in-loop 'no-await-in-loop': 'error', // Disallow comparisons to negative zero // https://eslint.org/docs/rules/no-compare-neg-zero 'no-compare-neg-zero': 'error', // disallow assignment in conditional expressions 'no-cond-assign': ['error', 'always'], // disallow use of console 'no-console': 'warn', // Disallows expressions where the operation doesn't affect the value // https://eslint.org/docs/rules/no-constant-binary-expression 'no-constant-binary-expression': 'off', // disallow use of constant expressions in conditions 'no-constant-condition': 'warn', // disallow control characters in regular expressions 'no-control-regex': 'error', // disallow use of debugger 'no-debugger': 'error', // disallow duplicate arguments in functions 'no-dupe-args': 'error', // Disallow duplicate conditions in if-else-if chains // https://eslint.org/docs/rules/no-dupe-else-if 'no-dupe-else-if': 'error', // disallow duplicate keys when creating object literals 'no-dupe-keys': 'error', // disallow a duplicate case label. 'no-duplicate-case': 'error', // disallow empty statements 'no-empty': 'error', // disallow the use of empty character classes in regular expressions 'no-empty-character-class': 'error', // disallow assigning to the exception in a catch block 'no-ex-assign': 'error', // disallow double-negation boolean casts in a boolean context // https://eslint.org/docs/rules/no-extra-boolean-cast 'no-extra-boolean-cast': 'error', // disallow overwriting functions written as function declarations 'no-func-assign': 'error', // https://eslint.org/docs/rules/no-import-assign 'no-import-assign': 'error', // disallow function or variable declarations in nested blocks 'no-inner-declarations': 'error', // disallow invalid regular expression strings in the RegExp constructor 'no-invalid-regexp': 'error', // disallow irregular whitespace outside of strings and comments 'no-irregular-whitespace': 'error', // Disallow Number Literals That Lose Precision // https://eslint.org/docs/rules/no-loss-of-precision 'no-loss-of-precision': 'error', // Disallow characters which are made with multiple code points in character class syntax // https://eslint.org/docs/rules/no-misleading-character-class 'no-misleading-character-class': 'error', // Disallow new operators with global non-constructor functions // https://eslint.org/docs/latest/rules/no-new-native-nonconstructor // ?NOTE: replaces `no-new-symbol` and others 'no-new-native-nonconstructor': 'error', // disallow the use of object properties of the global object (Math and JSON) as functions 'no-obj-calls': 'error', // Disallow returning values from Promise executor functions // https://eslint.org/docs/rules/no-promise-executor-return 'no-promise-executor-return': 'error', // disallow use of Object.prototypes builtins directly // https://eslint.org/docs/rules/no-prototype-builtins 'no-prototype-builtins': 'error', // disallow multiple spaces in a regular expression literal 'no-regex-spaces': 'error', // Disallow returning values from setters // https://eslint.org/docs/rules/no-setter-return 'no-setter-return': 'error', // disallow sparse arrays 'no-sparse-arrays': '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', // Avoid code that looks like two expressions but is actually one // https://eslint.org/docs/rules/no-unexpected-multiline 'no-unexpected-multiline': 'error', // disallow unreachable statements after a return, throw, continue, or break statement 'no-unreachable': 'error', // Disallow loops with a body that allows only one iteration, // WhileStatement, DoWhileStatement, ForStatement, ForInStatement, ForOfStatement // https://eslint.org/docs/rules/no-unreachable-loop 'no-unreachable-loop': ['error', { ignore: [] }], // disallow return/throw/break/continue inside finally blocks // https://eslint.org/docs/rules/no-unsafe-finally 'no-unsafe-finally': 'error', // disallow negating the left operand of relational operators // https://eslint.org/docs/rules/no-unsafe-negation 'no-unsafe-negation': 'error', // disallow negation of the left operand of an in expression // deprecated in favor of no-unsafe-negation // 'style/no-negated-in-lhs': 'error', // disallow use of optional chaining in contexts where the undefined value is not allowed // https://eslint.org/docs/rules/no-unsafe-optional-chaining 'no-unsafe-optional-chaining': ['error', { disallowArithmeticOperators: true, }], // Disallow Unused Private Class Members // https://eslint.org/docs/rules/no-unused-private-class-members 'no-unused-private-class-members': 'warn', // Disallow useless backreferences in regular expressions // https://eslint.org/docs/rules/no-useless-backreference 'no-useless-backreference': 'error', // Disallow assignments that can lead to race conditions due to usage of await or yield // https://eslint.org/docs/rules/require-atomic-updates // note: not enabled because it is very buggy 'require-atomic-updates': 'off', // disallow unnecessary parentheses // https://eslint.org/docs/rules/no-extra-parens 'style/no-extra-parens': ['error', 'all', { conditionalAssign: true, enforceForArrowConditionals: false, ignoreJSX: 'all', // delegate to eslint-plugin-react nestedBinaryExpressions: false, returnAssign: false, }], // disallow unnecessary semicolons 'style/no-extra-semi': 'error', // disallow comparisons with the value NaN 'use-isnan': ['error', { enforceForIndexOf: true, enforceForSwitchCase: true, }], // ensure JSDoc comments are valid // https://eslint.org/docs/rules/valid-jsdoc 'valid-jsdoc': 'off', // ensure that the results of typeof are compared against a valid string // https://eslint.org/docs/rules/valid-typeof 'valid-typeof': ['error', { requireStringLiterals: true }], }, }; export const airbnbES6Style: TypedFlatConfigItem = { name: 'airbnb/es6-style', plugins: { style: pluginStylistic }, rules: { // enforces no braces where they can be omitted // https://eslint.org/docs/rules/arrow-body-style 'arrow-body-style': ['error', 'as-needed', { requireReturnForObjectLiteral: false, }], // verify super() callings in constructors 'constructor-super': 'error', // disallow modifying variables of class declarations // https://eslint.org/docs/rules/no-class-assign 'no-class-assign': 'error', // disallow modifying variables that are declared using const 'no-const-assign': 'error', // disallow duplicate class members // https://eslint.org/docs/rules/no-dupe-class-members 'no-dupe-class-members': 'error', // disallow importing from the same path more than once // https://eslint.org/docs/rules/no-duplicate-imports // replaced by https://github.com/import-js/eslint-plugin-import/blob/master/docs/rules/no-duplicates.md 'no-duplicate-imports': 'off', // disallow symbol constructor // https://eslint.org/docs/rules/no-new-symbol // 'no-new-symbol': 'error', 'no-new-native-nonconstructor': 'error', // 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 'catch', // this will cause tons of confusion when your module is dynamically `import()`ed, and will break in most node ESM versions ], }], // disallow specific imports // https://eslint.org/docs/rules/no-restricted-imports 'no-restricted-imports': ['off', { paths: [], patterns: [], }], // disallow to use this/super before super() calling in constructors. // https://eslint.org/docs/rules/no-this-before-super 'no-this-before-super': 'error', // 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, ignoreExport: true, ignoreImport: true, }], // 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', { avoidQuotes: true, ignoreConstructors: false, }], // 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', { AssignmentExpression: { array: true, object: false, }, VariableDeclarator: { array: false, object: true, }, }, { enforceForRenamedProperties: false, }], // disallow parseInt() in favor of binary, octal, and hexadecimal literals // https://eslint.org/docs/rules/prefer-numeric-literals 'prefer-numeric-literals': 'error', // suggest using Reflect methods where applicable // https://eslint.org/docs/rules/prefer-reflect // ?NOTE: deprecated in ESLint v3.9.0. There is no replacement rule. 'prefer-reflect': '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', // disallow generator functions that do not have yield // https://eslint.org/docs/rules/require-yield 'require-yield': 'error', // import sorting // https://eslint.org/docs/rules/sort-imports 'sort-imports': ['off', { ignoreCase: false, ignoreDeclarationSort: false, ignoreMemberSort: false, memberSyntaxSortOrder: [ 'none', 'all', 'multiple', 'single', ], }], // require parens in arrow function arguments // https://eslint.org/docs/rules/arrow-parens 'style/arrow-parens': ['error', 'always'], // require space before/after arrow function's arrow // https://eslint.org/docs/rules/arrow-spacing 'style/arrow-spacing': ['error', { after: true, before: true, }], // enforce the spacing around the * in generator functions // https://eslint.org/docs/rules/generator-star-spacing 'style/generator-star-spacing': ['error', { after: true, before: false, }], // disallow arrow functions where they could be confused with comparisons // https://eslint.org/docs/rules/no-confusing-arrow 'style/no-confusing-arrow': ['error', { allowParens: true }], // enforce spacing between object rest-spread // https://eslint.org/docs/rules/rest-spread-spacing 'style/rest-spread-spacing': ['error', 'never'], // enforce usage of spacing in template strings // https://eslint.org/docs/rules/template-curly-spacing 'style/template-curly-spacing': 'error', // enforce spacing around the * in yield* expressions // https://eslint.org/docs/rules/yield-star-spacing 'style/yield-star-spacing': ['error', 'after'], // require a Symbol description // https://eslint.org/docs/rules/symbol-description 'symbol-description': 'error', }, }; export const airbnbNodejsSpecifics: TypedFlatConfigItem = { name: 'airbnb/specific-to-nodejs', plugins: { node: pluginNode, style: pluginStylistic }, rules: { // disallow use of the Buffer() constructor // https://eslint.org/docs/rules/no-buffer-constructor // ?NOTE: replaced by `eslint-plugin-n` (node) and `no-deprecated-api` there // 'no-buffer-constructor': 'error', // enforce return after a callback 'node/callback-return': ['error', ['callback', 'cb', 'next', 'done']], // require all requires be top-level // https://eslint.org/docs/rules/global-require 'node/global-require': 'error', // enforces error handling in callbacks (node environment) 'node/handle-callback-err': 'off', // disallow use of new operator with the require function // ?NOTE: replaced in `eslint-plugin-n` (node) by `no-new-require` 'node/no-new-require': 'error', // disallow string concatenation with __dirname and __filename // https://eslint.org/docs/rules/no-path-concat 'node/no-path-concat': 'error', // disallow use of process.env 'node/no-process-env': 'off', // disallow process.exit() 'node/no-process-exit': 'off', // disallow use of synchronous methods (off by default) 'node/no-sync': 'off', // disallow mixing regular variable and require declarations 'style/no-mixed-requires': ['off', false], // restrict usage of specified node modules 'style/no-restricted-modules': 'off', }, }; export const airbnbGeneralStyling: TypedFlatConfigItem = { name: 'airbnb/general-styling', plugins: { style: pluginStylistic }, rules: { // enforce line breaks after opening and before closing array brackets // https://eslint.org/docs/rules/array-bracket-newline // ? NOTE: deprecated since ESLint v8.53, moved to Stylistic // 'array-bracket-newline': ['off', 'consistent'], // object option alternative: { multiline: true, minItems: 3 } // require camel case names 'camelcase': ['error', { ignoreDestructuring: false, properties: 'never', }], // enforce line breaks between array elements // https://eslint.org/docs/rules/array-element-newline // ? NOTE: deprecated since ESLint v8.53, moved to Stylistic // 'array-element-newline': ['off', { minItems: 3, multiline: true }], // enforce or disallow capitalization of the first letter of a comment // https://eslint.org/docs/rules/capitalized-comments 'capitalized-comments': ['off', 'never', { block: { ignoreConsecutiveComments: true, ignoreInlineComments: true, ignorePattern: '.*', }, line: { ignoreConsecutiveComments: true, ignoreInlineComments: true, ignorePattern: '.*', }, }], // enforces consistent naming when capturing the current execution context 'consistent-this': 'off', // requires function names to match the name of the variable or property to which they are // assigned // https://eslint.org/docs/rules/func-name-matching 'func-name-matching': ['off', 'always', { considerPropertyDescriptor: true, includeCommonJSModuleExports: false, }], // require function expressions to have a name // https://eslint.org/docs/rules/func-names 'func-names': 'warn', // enforces use of function declarations or expressions // https://eslint.org/docs/rules/func-style 'func-style': ['off', 'expression'], // disallow specified identifiers // https://eslint.org/docs/rules/id-denylist 'id-denylist': 'off', // this option enforces minimum and maximum identifier lengths // (variable names, property names etc.) 'id-length': 'off', // require identifiers to match the provided regular expression 'id-match': 'off', // Require or disallow logical assignment logical operator shorthand // https://eslint.org/docs/latest/rules/logical-assignment-operators 'logical-assignment-operators': ['off', 'always', { enforceForIfStatements: true, }], // specify the maximum depth that blocks can be nested 'max-depth': ['off', 4], // limits the number of parameters that can be used in the function declaration. 'max-params': ['error', 5], // require a capital letter for constructors 'new-cap': ['error', { capIsNew: false, capIsNewExceptions: ['Immutable.Map', 'Immutable.Set', 'Immutable.List'], newIsCap: true, newIsCapExceptions: [], }], // allow/disallow an empty newline after var statement // ?NOTE: merged into `padding-line-between-statements` // 'newline-after-var': 'off', // https://eslint.org/docs/rules/newline-before-return // ?NOTE: merged into `padding-line-between-statements` // 'newline-before-return': 'off', // 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 comments inline after code 'no-inline-comments': 'off', // 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 negated conditions // https://eslint.org/docs/rules/no-negated-condition 'no-negated-condition': 'off', // disallow nested ternary expressions 'no-nested-ternary': 'error', // disallow use of the Object constructor // 'no-new-object': 'error', // deprecated in ESLint v8.50.0, use `no-object-constructor` 'no-object-constructor': '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', { 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: 'ForInStatement', }, { 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: 'ForOfStatement', }, { message: `Labels are a form of GOTO; using them makes code confusing and hard to maintain and understand.`, selector: 'LabeledStatement', }, { message: `the "with" is disallowed in strict mode because it makes code impossible to predict and optimize.`, selector: 'WithStatement', }], // disallow dangling underscores in identifiers // https://eslint.org/docs/rules/no-underscore-dangle 'no-underscore-dangle': ['error', { allow: [], allowAfterSuper: false, allowAfterThis: 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', // do not require jsdoc // https://eslint.org/docs/rules/require-jsdoc 'require-jsdoc': 'off', // enforce spacing inside array brackets 'style/array-bracket-spacing': ['error', 'never'], // enforce spacing inside single-line blocks // https://eslint.org/docs/rules/block-spacing 'style/block-spacing': ['error', 'always'], // enforce one true brace style 'style/brace-style': ['error', '1tbs', { allowSingleLine: true }], // require trailing commas in multiline object literals 'style/comma-dangle': ['error', { arrays: 'always-multiline', exports: 'always-multiline', functions: 'always-multiline', imports: 'always-multiline', objects: 'always-multiline', }], // enforce spacing before and after comma 'style/comma-spacing': ['error', { after: true, before: false, }], // enforce one true comma style 'style/comma-style': ['error', 'last', { exceptions: { ArrayExpression: false, ArrayPattern: false, ArrowFunctionExpression: false, CallExpression: false, FunctionDeclaration: false, FunctionExpression: false, ImportDeclaration: false, NewExpression: false, ObjectExpression: false, ObjectPattern: false, VariableDeclaration: false, }, }], // disallow padding inside computed properties 'style/computed-property-spacing': ['error', 'never'], // enforce newline at the end of file, with no multiple empty lines 'style/eol-last': ['error', 'always'], // enforce spacing between functions and their invocations // https://eslint.org/docs/rules/func-call-spacing 'style/function-call-spacing': ['error', 'never'], // require line breaks inside function parentheses if there are line breaks between parameters // https://eslint.org/docs/rules/function-paren-newline 'style/function-paren-newline': ['error', 'multiline-arguments'], // Require or disallow padding lines between statements // https://eslint.org/docs/rules/padding-line-between-statements // 'padding-line-between-statements': 'off', // Enforce the location of arrow function bodies with implicit returns // https://eslint.org/docs/rules/implicit-arrow-linebreak 'style/implicit-arrow-linebreak': ['error', 'beside'], // this option sets a specific tab width for your code // https://eslint.org/docs/rules/indent 'style/indent': ['error', 2, { ArrayExpression: 1, CallExpression: { arguments: 1, }, flatTernaryExpressions: false, // MemberExpression: null, FunctionDeclaration: { body: 1, parameters: 1, }, FunctionExpression: { body: 1, parameters: 1, }, ignoreComments: false, // list derived from https://github.com/benjamn/ast-types/blob/HEAD/def/jsx.js ignoredNodes: [ 'JSXElement', 'JSXElement > *', 'JSXAttribute', 'JSXIdentifier', 'JSXNamespacedName', 'JSXMemberExpression', 'JSXSpreadAttribute', 'JSXExpressionContainer', 'JSXOpeningElement', 'JSXClosingElement', 'JSXFragment', 'JSXOpeningFragment', 'JSXClosingFragment', 'JSXText', 'JSXEmptyExpression', 'JSXSpreadChild', ], ImportDeclaration: 1, ObjectExpression: 1, outerIIFEBody: 1, SwitchCase: 1, VariableDeclarator: 1, }], // specify whether double or single quotes should be used in JSX attributes // https://eslint.org/docs/rules/jsx-quotes 'style/jsx-quotes': ['error', 'prefer-double'], // enforces spacing between keys and values in object literal properties 'style/key-spacing': ['error', { afterColon: true, beforeColon: false, }], // require a space before & after certain keywords 'style/keyword-spacing': ['error', { after: true, before: true, overrides: { case: { after: true }, return: { after: true }, throw: { after: true }, }, }], // enforce position of line comments // https://eslint.org/docs/rules/line-comment-position 'style/line-comment-position': ['off', { applyDefaultPatterns: true, ignorePattern: '', position: 'above', }, ], // disallow mixed 'LF' and 'CRLF' as linebreaks // https://eslint.org/docs/rules/linebreak-style 'style/linebreak-style': ['error', 'unix'], // enforces empty lines around comments 'style/lines-around-comment': 'off', // require or disallow an empty line between class members // https://eslint.org/docs/rules/lines-between-class-members 'style/lines-between-class-members': ['error', 'always', { exceptAfterSingleLine: false, }], // specify the maximum length of a line in your program // https://eslint.org/docs/rules/max-len 'style/max-len': ['error', 120, 2, { ignoreComments: true, ignoreRegExpLiterals: true, ignoreStrings: true, ignoreTemplateLiterals: true, ignoreUrls: true, }], // specify the max number of lines in a file // https://eslint.org/docs/rules/max-lines 'style/max-lines': [ 'off', { max: 300, skipBlankLines: true, skipComments: true, }, ], // enforce a maximum function length // https://eslint.org/docs/rules/max-lines-per-function 'style/max-lines-per-function': [ 'off', { IIFEs: true, max: 50, skipBlankLines: true, skipComments: true, }, ], // specify the maximum depth callbacks can be nested 'style/max-nested-callbacks': 'off', // specify the maximum number of statement allowed in a function 'style/max-statements': ['off', 40], // restrict the number of statements per line // https://eslint.org/docs/rules/max-statements-per-line 'style/max-statements-per-line': ['error', { max: 1 }], // enforce a particular style for multiline comments // https://eslint.org/docs/rules/multiline-comment-style 'style/multiline-comment-style': ['off', 'starred-block'], // require multiline ternary // https://eslint.org/docs/rules/multiline-ternary 'style/multiline-ternary': ['error', 'always-multiline'], // disallow the omission of parentheses when invoking a constructor with no arguments // https://eslint.org/docs/rules/new-parens 'style/new-parens': 'error', // enforces new line after each method call in the chain to make it // more readable and easy to maintain // https://eslint.org/docs/rules/newline-per-chained-call 'style/newline-per-chained-call': ['error', { ignoreChainWithDepth: 4 }], // disallow un-paren'd mixes of different operators // https://eslint.org/docs/rules/no-mixed-operators 'style/no-mixed-operators': ['error', { allowSamePrecedence: false, // the list of arithmetic groups disallows mixing `%` and `**` // with other arithmetic operators. groups: [ ['%', '**'], ['%', '+'], ['%', '-'], ['%', '*'], ['%', '/'], ['/', '*'], ['&', '|', '<<', '>>', '>>>'], ['==', '!=', '===', '!=='], ['&&', '||'], ], }], // disallow mixed spaces and tabs for indentation 'style/no-mixed-spaces-and-tabs': 'error', // disallow multiple empty lines, only one newline at the end, and no new lines at the beginning // https://eslint.org/docs/rules/no-multiple-empty-lines 'style/no-multiple-empty-lines': ['error', { max: 1, maxBOF: 0, maxEOF: 0, }], // disallow space between function identifier and application // deprecated in favor of func-call-spacing 'style/no-spaced-func': 'off', // disallow tab characters entirely 'style/no-tabs': 'error', // disallow the use of ternary operators 'style/no-ternary': 'off', // disallow trailing whitespace at the end of lines 'style/no-trailing-spaces': ['error', { ignoreComments: false, skipBlankLines: false, }], // disallow whitespace before properties // https://eslint.org/docs/rules/no-whitespace-before-property 'style/no-whitespace-before-property': 'error', // enforce the location of single-line statements // https://eslint.org/docs/rules/nonblock-statement-body-position 'style/nonblock-statement-body-position': ['error', 'beside', { overrides: {}, }], // enforce line breaks between braces // https://eslint.org/docs/rules/object-curly-newline 'style/object-curly-newline': ['error', { ExportDeclaration: { consistent: true, minProperties: 4, multiline: true, }, ImportDeclaration: { consistent: true, minProperties: 4, multiline: true, }, ObjectExpression: { consistent: true, minProperties: 4, multiline: true }, ObjectPattern: { consistent: true, minProperties: 4, multiline: true }, }], // require padding inside curly braces 'style/object-curly-spacing': ['error', 'always'], // enforce "same line" or "multiple line" on object properties. // https://eslint.org/docs/rules/object-property-newline 'style/object-property-newline': ['error', { allowAllPropertiesOnSameLine: true, }], // require a newline around variable declaration // https://eslint.org/docs/rules/one-var-declaration-per-line 'style/one-var-declaration-per-line': ['error', 'always'], // Requires operator at the beginning of the line in multiline statements // https://eslint.org/docs/rules/operator-linebreak 'style/operator-linebreak': ['error', 'before', { overrides: { '=': 'none' }, }], // disallow padding within blocks 'style/padded-blocks': ['error', { blocks: 'never', classes: 'never', switches: 'never', }, { allowSingleLineBlocks: true, }], // require or disallow newlines around directives // https://eslint.org/docs/rules/lines-around-directive 'style/padding-line-between-statements': ['error', { blankLine: 'always', next: 'return', prev: ['const', 'let', 'var'], }], // require quotes around object literal property names // https://eslint.org/docs/rules/quote-props.html 'style/quote-props': ['error', 'as-needed', { keywords: false, numbers: false, unnecessary: true, }], // specify whether double or single quotes should be used 'style/quotes': ['error', 'single', { allowTemplateLiterals: true, avoidEscape: true, }], // require or disallow use of semicolons instead of ASI 'style/semi': ['error', 'always'], // enforce spacing before and after semicolons 'style/semi-spacing': ['error', { after: true, before: false, }], // Enforce location of semicolons // https://eslint.org/docs/rules/semi-style 'style/semi-style': ['error', 'last'], // requires object keys to be sorted 'style/sort-keys': ['off', 'asc', { caseSensitive: false, natural: true, }], // sort variables within the same declaration block 'style/sort-vars': 'off', // require or disallow space before blocks 'style/space-before-blocks': 'error', // require or disallow space before function opening parenthesis // https://eslint.org/docs/rules/space-before-function-paren 'style/space-before-function-paren': ['error', { anonymous: 'always', asyncArrow: 'always', named: 'never', }], // require or disallow spaces inside parentheses 'style/space-in-parens': ['error', 'never'], // require spaces around operators 'style/space-infix-ops': 'error', // Require or disallow spaces before/after unary operators // https://eslint.org/docs/rules/space-unary-ops 'style/space-unary-ops': ['error', { nonwords: false, overrides: {}, words: true, }], // require or disallow a space immediately following the // or /* in a comment // https://eslint.org/docs/rules/spaced-comment 'style/spaced-comment': ['error', 'always', { block: { balanced: true, exceptions: ['-', '+'], markers: ['=', '!', ':', '::'], // space here to support sprockets directives and flow comment types }, line: { exceptions: ['-', '+'], markers: ['=', '!', '/'], // space here to support sprockets directives, slash for TS /// comments }, }], // Enforce spacing around colons of switch statements // https://eslint.org/docs/rules/switch-colon-spacing 'sty