.eslintrc.js

const parser = '@babel/eslint-parser';

const settings = {
  react: {
    version: 'detect',
  },
};
const parserOptions = {
  ecmaVersion: 2017,
  sourceType: 'module',
  ecmaFeatures: {
    jsx: true,
    modules: true,
  },
  babelOptions: {
    presets: ['@babel/preset-react'],
  },
};

const extending = [
  'plugin:react/recommended',
  'plugin:react/jsx-runtime',
  'plugin:jsx-a11y/recommended',
  'prettier',
];

const plugins = ['react', 'jsx-a11y'];

const env = {
  browser: true,
  es6: true,
  es2021: true,
  jest: true,
  node: true,
};

const rules = {
  // Disallow spacing inside array brackets
  'array-bracket-spacing': [1, 'never'],
  // Enforces return statements in callbacks of array's methods
  'array-callback-return': 1,
  // Enforces no braces where they can be omitted
  'arrow-body-style': 0,
  // Require space before/after arrow function's arrow
  'arrow-spacing': [1, { before: true, after: true }],
  // Treat var statements as if they were block scoped
  'block-scoped-var': 1,
  // Enforce one true brace style
  'brace-style': [1, '1tbs'],
  // Require camel case names
  camelcase: [1, { properties: 'never' }],
  // Disallow trailing commas in object literals
  'comma-dangle': [1, 'only-multiline'],
  // Enforce spacing after comma
  'comma-spacing': [1, { before: false, after: true }],
  // Enforce one true comma style
  'comma-style': [1, 'last'],
  // Specify the maximum cyclomatic complexity allowed in a program
  complexity: [1, 18],
  // Disallow padding inside computed properties
  'computed-property-spacing': [1, 'never'],
  // Require return statements to either always or never specify values
  'consistent-return': 0,
  // Enforce consistent naming when capturing the current execution context
  'consistent-this': 1,
  // Verify super() callings in constructors
  'constructor-super': 1,
  // Require default case in switch statements
  'default-case': 1,
  // Enforces consistent newlines before or after dots
  'dot-location': [1, 'property'],
  // Encourages use of dot notation whenever possible
  'dot-notation': [1, { allowKeywords: true }],
  // Enforce newline at the end of file, with no multiple empty lines
  'eol-last': 1,
  // Require the use of === and !==
  eqeqeq: 1,
  // Enforce use of function declarations or expressions
  'func-style': [1, 'expression'],
  // Enforce the spacing around the * in generator functions
  'generator-star-spacing': 0,
  // Make sure for-in loops have an if statement
  'guard-for-in': 2,
  // Enforce that all elements that require alternative text have meaningful information to relay back to the end user
  'jsx-a11y/alt-text': [2, { img: ['LazyImage'] }],
  // Enforce that a label tag has a text label and an associated control
  'jsx-a11y/label-has-associated-control': [
    1,
    { depth: 3, controlComponents: ['TextSearchBox', 'select'] },
  ],
  // Enforce label tags to have associated control
  'jsx-a11y/label-has-for': 0,
  // Specify quote type in JSX attributes
  'jsx-quotes': [1, 'prefer-double'],
  // Enforce spacing style for keys and values in object literal properties
  'key-spacing': [1, { mode: 'minimum' }],
  // Require a space around certain keywords
  'keyword-spacing': 1,
  // Disallow mixed 'LF' and 'CRLF' as linebreaks
  'linebreak-style': [0, 'unix'],
  // Specify the maximum depth that blocks can be nested
  'max-depth': [1, 4],
  // Specify the maximum depth callbacks can be nested
  'max-nested-callbacks': [1, 5],
  // Limits number of parameters that can be used in the function declaration
  'max-params': [1, 6],
  // Specify the maximum number of statement allowed in a function
  'max-statements': [1, 30],
  // Require a capital letter for constructors
  'new-cap': 0,
  // Disallow omission of parens when invoking constructor with no arguments
  'new-parens': 1,
  // Disallow the use of alert, confirm, and prompt
  'no-alert': 1,
  // Disallow use of the Array constructor
  'no-array-constructor': 1,
  // Disallow use of bitwise operators
  'no-bitwise': 1,
  // Disallow use of arguments.caller or arguments.callee
  'no-caller': 2,
  // Disallow lexical declarations in case/default clauses
  'no-case-declarations': 1,
  // Disallow modifying variables of class declarations
  'no-class-assign': 1,
  // Disallow assignment in conditional expressions
  'no-cond-assign': [1, 'except-parens'],
  // Disallow use of constant expressions in conditions
  'no-constant-condition': 1,
  // Disallow modifying variables that are declared using const
  'no-const-assign': 2,
  // Disallow use of the continue statement
  'no-continue': 0,
  // Disallow control characters in regular expressions
  'no-control-regex': 1,
  // Disallow use of debugger
  'no-debugger': 1,
  // Disallow deletion of variables
  'no-delete-var': 2,
  // Disallow duplicate arguments in functions
  'no-dupe-args': 2,
  // Disallow duplicate name in class members
  'no-dupe-class-members': 2,
  // Disallow duplicate keys when creating object literals
  'no-dupe-keys': 1,
  // Disallow a duplicate case label
  'no-duplicate-case': 2,
  // Disallow else after a return in an if
  'no-else-return': 1,
  // Disallow empty statements
  'no-empty': 1,
  // Disallow the use of empty character classes in regular expressions
  'no-empty-character-class': 1,
  // Disallow empty destructuring patterns
  'no-empty-pattern': 1,
  // Disallow use of eval()
  'no-eval': 2,
  // Disallow assigning to the exception in a catch block
  'no-ex-assign': 1,
  // Disallow adding to native types
  'no-extend-native': 2,
  // Disallow unnecessary function binding
  'no-extra-bind': 1,
  // Disallow double-negation boolean casts in a boolean context
  'no-extra-boolean-cast': 1,
  // Disallow unnecessary labels
  'no-extra-label': 1,
  // Disallow unnecessary parentheses
  'no-extra-parens': [1, 'functions'],
  // Disallow unnecessary semicolons
  'no-extra-semi': 1,
  // Disallow fallthrough of case statements
  'no-fallthrough': 1,
  // Disallow use of leading or trailing decimal points in numeric literals
  'no-floating-decimal': 1,
  // Disallow overwriting functions written as function declarations
  'no-func-assign': 1,
  // Disallow use of eval()-like methods
  'no-implied-eval': 2,
  // Disallow function or variable declarations in nested blocks
  'no-inner-declarations': 1,
  // Disallow invalid regular expression strings in the RegExp constructor
  'no-invalid-regexp': 2,
  // Disallow irregular whitespace outside of strings and comments
  'no-irregular-whitespace': 1,
  // Disallow usage of __iterator__ property
  'no-iterator': 1,
  // Disallow use of labels for anything other then loops and switches
  'no-labels': 2,
  // Disallow labels that share a name with a variable
  'no-label-var': 1,
  // Disallow unnecessary nested blocks
  'no-lone-blocks': 1,
  // Disallow if as the only statement in an else block
  'no-lonely-if': 0,
  // Disallow creation of functions within loops
  'no-loop-func': 1,
  // Disallow magic numbers
  'no-magic-numbers': [
    1,
    { ignoreArrayIndexes: true, ignore: [-1, 0, 1, 2, 100] },
  ],
  // Disallow mixed spaces and tabs for indentation
  'no-mixed-spaces-and-tabs': 2,
  // Disallow multiple empty lines and only one newline at the end
  'no-multiple-empty-lines': [1, { max: 2, maxEOF: 1 }],
  // Disallow use of multiple spaces
  'no-multi-spaces': 1,
  // Disallow use of multiline strings
  'no-multi-str': 1,
  // Disallow reassignments of native objects
  'no-native-reassign': 2,
  // Disallow use of negated expressions in conditions
  'no-negated-condition': 1,
  // Disallow negation of the left operand of an in expression
  'no-negated-in-lhs': 2,
  // Disallow nested ternary expressions
  'no-nested-ternary': 2,
  // Disallow use of new operator when not part of assignment or comparison
  'no-new': 2,
  // Disallow use of new operator for Function object
  'no-new-func': 2,
  // Disallow use of the Object constructor
  'no-new-object': 2,
  // Disallow Symbol Constructor
  'no-new-symbol': 2,
  // Disallow creating new instances of String, Number, and Boolean
  'no-new-wrappers': 2,
  // Disallow the use of object properties of
  // the global object (Math and JSON) as functions
  'no-obj-calls': 2,
  // Disallow use of (old style) octal literals
  'no-octal': 2,
  // Disallow use of octal escape sequences in string literals
  'no-octal-escape': 2,
  // Disallow reassignment of function parameters
  // Allow parameter object manipulation
  'no-param-reassign': [2, { props: false }],
  // Disallow string concatenation when using __dirname and __filename
  'no-path-concat': 1,
  // Disallow use of process.env
  'no-process-env': 1,
  // Disallow usage of __proto__ property
  'no-proto': 2,
  // Disallow declaring the same variable more than once
  'no-redeclare': 2,
  // Disallow multiple spaces in a regular expression literal
  'no-regex-spaces': 1,
  // Disallow use of assignment in return statement
  'no-return-assign': 0,
  // Disallow use of `javascript:` urls.
  'no-script-url': 2,
  // Disallow self assignment
  'no-self-assign': 2,
  // Disallow comparisons where both sides are exactly the same
  'no-self-compare': 2,
  // Disallow use of comma operator
  'no-sequences': 2,
  // Disallow shadowing of restricted names
  'no-shadow-restricted-names': 1,
  // Disallow space between function identifier and application
  'no-spaced-func': 2,
  // Disallow sparse arrays
  'no-sparse-arrays': 2,
  // Disallow use of this/super before super() calling in constructors
  'no-this-before-super': 2,
  // Restrict what can be thrown as an exception
  'no-throw-literal': 2,
  // Disallow trailing whitespace at the end of lines
  'no-trailing-spaces': 1,
  // Disallow use of undeclared variables unless set as global
  'no-undef': 2,
  // Avoid code that looks like two expressions but is actually one
  'no-unexpected-multiline': 2,
  // Disallow unmodified conditions of loops
  'no-unmodified-loop-condition': 2,
  // Disallow the use of Boolean literals in conditional expressions,
  // also, prefer `a || b` over `a ? a : b`
  'no-unneeded-ternary': [1, { defaultAssignment: false }],
  // Disallow unreachable statements after a
  // return, throw, continue, or break statement
  'no-unreachable': 1,
  // Disallow usage of expressions in statement position
  'no-unused-expressions': 0,
  // Disallow unused labels
  'no-unused-labels': 1,
  // Disallow declaration of variables that are not used in the code
  'no-unused-vars': [
    1,
    {
      args: 'after-used',
      argsIgnorePattern: '^_',
      varsIgnorePattern: '^_',
      ignoreRestSiblings: true,
    },
  ],
  // Disallow use of variables before they are defined
  'no-use-before-define': 2,
  // Disallow unnecessary .call() and .apply()
  'no-useless-call': 2,
  // Disallow unnecessary concatenation of strings
  'no-useless-concat': 1,
  // Disallow unnecessary constructor
  'no-useless-constructor': 1,
  // Require let or const instead of var
  'no-var': 1,
  // Disallow use of void operator
  'no-void': 2,
  // Disallow whitespace before properties
  'no-whitespace-before-property': 1,
  // Disallow use of the with statement
  'no-with': 2,
  // Require method and property shorthand syntax for object literals
  'object-shorthand': 0,
  // Enforce variables to be declared either together or separately in functions
  'one-var': [1, 'never'],
  // Require assignment operator shorthand where possible
  'operator-assignment': 1,
  // Suggest using arrow functions as callbacks
  'prefer-arrow-callback': 1,
  // Suggest using of const declaration when never modified after declared
  'prefer-const': 1,
  // Suggest using Reflect methods where applicable
  'prefer-reflect': 0,
  // Suggest using the rest parameters instead of 'arguments'
  'prefer-rest-params': 2,
  // Suggest using the spread operator instead of .apply()
  'prefer-spread': 2,
  // Suggest using template literals instead of string concatenation
  'prefer-template': 1,
  // Require quotes around object literal property names as needed
  'quote-props': [1, 'as-needed'],
  // Specify whether double or single quotes should be used
  quotes: [1, 'single', 'avoid-escape'],
  // Require use of the second argument for parseInt()
  radix: 1,
  // Validate closing bracket location in JSX
  'react/jsx-closing-bracket-location': 1,
  // Disallow spaces inside of curly braces in JSX attributes
  'react/jsx-curly-spacing': [1, 'never', { allowMultiline: true }],
  // Enforce event handler naming conventions in JSX
  'react/jsx-handler-names': 0,
  // Validate JSX has key prop when in array or iterator
  'react/jsx-key': 2,
  // Prevent usage of .bind() and arrow functions in JSX props
  'react/jsx-no-bind': [2, { allowArrowFunctions: true }],
  // Prevent duplicate props in JSX
  'react/jsx-no-duplicate-props': 2,
  // Disallow undeclared variables in JSX
  'react/jsx-no-undef': 2,
  // Enforce PascalCase for user-defined JSX components
  'react/jsx-pascal-case': 1,
  // Prevent React to be incorrectly marked as unused
  'react/jsx-uses-react': 2,
  // Prevent variables used in JSX to be incorrectly marked as unused
  'react/jsx-uses-vars': 2,
  // Prevent usage of dangerous JSX properties
  'react/no-danger': 2,
  // Prevent usage of deprecated methods
  'react/no-deprecated': 1,
  // Allow usage of setState in componentDidMount
  'react/no-did-mount-set-state': 0,
  // Prevent usage of setState in componentDidUpdate
  'react/no-did-update-set-state': 1,
  // Prevent direct mutation of this.state
  'react/no-direct-mutation-state': 2,
  // Prevent usage of isMounted
  'react/no-is-mounted': 2,
  // Prevent multiple component definition per file
  'react/no-multi-comp': 0,
  // Prevent using string references
  'react/no-string-refs': 1,
  // Prevent usage of unknown DOM property
  'react/no-unknown-property': [2, { ignore: ['inert'] }],
  // Require ES6 class declarations over React.createClass
  'react/prefer-es6-class': 2,
  // Prevent missing props validation in a React component definition
  'react/prop-types': [
    1,
    {
      skipUndeclared: true,
    },
  ],
  // Prevent missing React when using JSX
  'react/react-in-jsx-scope': 2,
  // Prevent extra closing tags for components without children
  'react/self-closing-comp': 1,
  // Enforce component methods order
  'react/sort-comp': 1,
  // Require JSDoc comment
  'require-jsdoc': [
    1,
    {
      require: {
        FunctionDeclaration: true,
        MethodDefinition: false,
        ClassDeclaration: false,
      },
    },
  ],
  // Disallow generator functions that do not have yield
  'require-yield': 2,
  // Require or disallow use of semicolons instead of ASI
  semi: [1, 'always'],
  // Enforce spacing before and after semicolons
  'semi-spacing': [1, { before: false, after: true }],
  // Disallow spaces inside parentheses
  'space-in-parens': [1, 'never'],
  // Require spaces around operators
  'space-infix-ops': 1,
  // Require spaces before/after unary operators
  'space-unary-ops': 1,
  // Require a space immediately following the // or /* in a comment
  'spaced-comment': [
    1,
    'always',
    { markers: [':', '::', '?:'], exceptions: ['-'] },
  ],
  // TODO: Remove when is https://github.com/babel/babel-eslint/issues/530 fixed
  // Disallow usage of spacing in template strings
  'template-curly-spacing': 'off', // [1, 'never'],
  indent: 'off',
  // Disallow comparisons with the value NaN
  'use-isnan': 2,
  // Ensure JSDoc comments are valid
  'valid-jsdoc': [
    1,
    {
      requireReturn: false,
    },
  ],
  // Ensure that the results of typeof are compared against a valid string
  'valid-typeof': 2,
  // Requires to declare all vars on top of their containing scope
  'vars-on-top': 1,
  // Require immediate function invocation to be wrapped in parentheses
  'wrap-iife': [2, 'outside'],
  // Enforce spacing around the * in yield* expressions
  'yield-star-spacing': [1, 'after'],
  // Disallow Yoda conditions
  yoda: 1,
};

module.exports = {
  settings,
  parser,
  parserOptions,
  extends: [
    'plugin:react/recommended',
    'plugin:react/jsx-runtime',
    'plugin:jsx-a11y/recommended',
    'prettier',
    'plugin:storybook/recommended',
  ],
  plugins,
  env,
  rules,
  ignorePatterns: ['.eslintrc.js'],
};