.eslintrc

extends: yoast

parserOptions:
  ecmaVersion: 2018
  sourceType: module

settings:
  react:
    version: "16.8"

rules:
  no-prototype-builtins: 0
  comma-dangle:
    - error
    - arrays: always-multiline
      objects: always-multiline
      imports: always-multiline
      exports: always-multiline
      functions: never

overrides:
  - files:
      - "packages/*/tests/**/*.js"
      - "packages/*/spec/**/*.js"
      # Temporary exclusion:
      - "packages/components/a11y/tests/**/*.js"
    env:
      jest: true
    rules:
      no-restricted-imports: "off"
  - files:
      - "packages/js/**/*.js"
    rules:
      # Custom rules: only for temporary exceptions that should be removed over time
      camelcase: 1
      complexity: [ 1, 6 ]
      brace-style: 1
      max-statements: 1
      no-shadow: 1
      require-jsdoc: 1
      react/jsx-no-bind: 1
      react/jsx-no-target-blank: 1
      react/no-access-state-in-setstate: 1
      react/no-deprecated: 1
      react/no-unused-prop-types: 1
      react/prop-types: 1
      react/require-default-props: 1
      no-restricted-imports:
        - error
        - name: react
          message: Please use @wordpress/element instead. No need to import just for JSX.
        - name: react-dom
          message: Please use @wordpress/element instead.

      # Disabled rules
      # In the editor, we're using the pragma `wp.element.createElement`
      react/react-in-jsx-scope: 0
  - files:
      - "packages/js/tests/**/*.js"
    rules:
      no-restricted-imports: 0
  - files:
      - "packages/schema-blocks/src/**"
    env:
      jest: true
    rules:
      new-cap: 0
      complexity:
        - 2
        - 10
      "@typescript-eslint/no-parameter-properties":
        - 2
        - allows:
            - protected readonly
            - private readonly
      "@typescript-eslint/explicit-function-return-type": 0
      "@typescript-eslint/no-use-before-define":
        - error
        - functions: false
      no-constant-condition:
        - error
        - checkLoops: false
      max-statements:
        - 2
        - 33
      no-unused-vars: 'off'
      "@typescript-eslint/no-unused-vars":
        - error
        - varsIgnorePattern: "^createElement$"
      no-dupe-class-members: 'off'
      indent: 'off'
      "@typescript-eslint/indent":
        - 2
        - tab
        - SwitchCase: 1
      space-before-function-paren:
        - error
        - anonymous: never
          named: never
          asyncArrow: always
      valid-jsdoc:
        - error
        - requireReturn: false
          requireReturnType: false
          requireParamType: false
      react/react-in-jsx-scope: 0
  - files:
      - "packages/components/**/*.js"
    rules:
      react/jsx-no-bind: 1
      react/require-default-props: 1
      react/default-props-match-prop-types: 1
      react/no-unused-prop-types: 1
      require-jsdoc: 1
  - files:
      - "packages/configuration-wizard/**/*.js"
    rules:
      react/no-unused-prop-types: 1
      react/jsx-no-bind: 1
      react/no-access-state-in-setstate: 1
      require-jsdoc: 1
  - files:
      - "packages/replacement-variable-editor/**/*.js"
    rules:
      react/jsx-no-bind: 1
      react/require-default-props: 1
  - files:
      - "packages/search-metadata-previews/**/*.js"
    rules:
      react/jsx-no-bind: 1
      react/no-unused-state: 1
      react/no-access-state-in-setstate: 1
      react/require-default-props: 1
      react/default-props-match-prop-types: 1
  - files:
      - "packages/yoastseo/**/*.js"
    rules:
      complexity: 1
      # Longer grace period for Yoast config.
      no-shadow: [ 1, { "builtinGlobals": false, "hoist": "all", "allow": [ ] } ]
      require-jsdoc: [ 1, { "require": { "MethodDefinition": true, "ClassDeclaration": true, "ArrowFunctionExpression": true, "FunctionExpression": true } } ]
      no-useless-escape: 1
  - files:
      - "packages/analysis-report/**/*.js"
    rules:
      complexity: [ 1, 6 ]
      // A wrapping label is not necessary when there already is an htmlFor attribute.
      jsx-a11y/label-has-for: [ "error", { required: "id" } ]
      require-jsdoc: 1
      react/button-has-type: 1
      react/default-props-match-prop-types: 1
      react/no-unused-prop-types: 1
      react/no-access-state-in-setstate: 1
      react/no-unused-state: 1
      react/jsx-no-bind: 1
      react/jsx-no-target-blank: 1
      react/require-default-props: 1
      react/forbid-foreign-prop-types: 1
  - files:
      - "packages/yoast-components/**/*.js"
    rules:
      complexity: [ 1, 6 ]
      // A wrapping label is not necessary when there already is an htmlFor attribute.
      jsx-a11y/label-has-for: [ "error", { required: "id" } ]
      require-jsdoc: 1
      react/button-has-type: 1
      react/default-props-match-prop-types: 1
      react/no-unused-prop-types: 1
      react/no-access-state-in-setstate: 1
      react/no-unused-state: 1
      react/jsx-no-bind: 1
      react/jsx-no-target-blank: 1
      react/require-default-props: 1
      react/forbid-foreign-prop-types: 1
    env:
      jest: true