.eslintrc

{
  "root": true,
  "parser": "@babel/eslint-parser",
  "extends": [
    "plugin:@wordpress/eslint-plugin/i18n",
    "eslint:recommended",
    "plugin:import/recommended",
    "plugin:@eslint-community/eslint-comments/recommended",
    "plugin:react/recommended",
    "plugin:prettier/recommended",
    "plugin:jsx-a11y/recommended",
    "plugin:jsdoc/recommended",
    "plugin:styled-components-a11y/recommended"
  ],
  "plugins": [
    "@babel",
    "@wordpress",
    "header",
    "jsdoc",
    "jsx-a11y",
    "markdown",
    "react",
    "react-hooks",
    "styled-components-a11y"
  ],
  "parserOptions": {
    "ecmaVersion": "latest",
    "ecmaFeatures": {
      "jsx": true
    }
  },
  "rules": {
    "array-callback-return": "error",
    "block-scoped-var": "error",
    "complexity": ["error", {"max": 20}],
    "consistent-return": "error",
    "curly": ["error", "all"],
    "default-case": "error",
    "eol-last": "error",
    "eqeqeq": "error",
    "guard-for-in": "error",
    "no-await-in-loop": "error",
    "no-constant-binary-expression": "error",
    "no-extra-bind": "error",
    "no-extra-label": "error",
    "no-floating-decimal": "error",
    "no-implicit-coercion": "error",
    "no-implicit-globals": "error",
    "no-implied-eval": "error",
    "no-loop-func": "error",
    "no-new": "error",
    "no-new-func": "error",
    "no-new-wrappers": "error",
    "no-multiple-empty-lines": "error",
    "no-trailing-spaces": "error",
    "header/header": [ "error", "block", [
      "",
      {
        "pattern": " \\* Copyright \\d{4} Google LLC",
        "template": " * Copyright 2024 Google LLC"
      },
      " *",
      " * Licensed under the Apache License, Version 2.0 (the \"License\");",
      " * you may not use this file except in compliance with the License.",
      " * You may obtain a copy of the License at",
      " *",
      " *     https://www.apache.org/licenses/LICENSE-2.0",
      " *",
      " * Unless required by applicable law or agreed to in writing, software",
      " * distributed under the License is distributed on an \"AS IS\" BASIS,",
      " * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.",
      " * See the License for the specific language governing permissions and",
      " * limitations under the License.",
      " "
    ] ],
    "import/no-cycle": "error",
    "import/no-restricted-paths": [ "error", {
      "zones": [ {
        "target": "./packages/migration/src/migrations",
        "from": "./packages/story-editor/src",
        "except": [ "./migration/migrations" ]
      }, {
        "target": "./packages/story-editor/src",
        "from": "./packages/story-editor/src/utils/useWhyDidYouUpdate.js"
      } ]
    } ],
    "import/dynamic-import-chunkname": [ "error", {
      "webpackChunknameFormat": "[0-9a-zA-Z-_/.[\\]]+"
    } ],
    "import/no-useless-path-segments": ["error", {
      "noUselessIndex": true
    }],
    "import/no-relative-packages": "error",
    "import/no-internal-modules": [ "error", {
      "forbid": [ "@googleforcreators/**/*" ]
    } ],
    "jsx-a11y/label-has-for": "off",
    "jsx-a11y/media-has-caption": [ "error", {
      "audio": [ "Audio" ],
      "video": [ "Video", "FadedVideo", "CropVideo", "StyledVideo" ],
      "track": [ "Track" ]
    }],
    "no-restricted-properties": "error",
    "no-return-assign": "error",
    "no-return-await": "error",
    "no-sequences": "error",
    "no-shadow": ["error",
      {
        "ignoreOnInitialization": true
      }
    ],
    "no-template-curly-in-string": "error",
    "no-throw-literal": "error",
    "no-unmodified-loop-condition": "error",
    "no-unused-vars": [
      "error",
      {
        "ignoreRestSiblings": true
      }
    ],
    "no-useless-call": "error",
    "jsx-a11y/anchor-has-content": "off",
    "no-useless-concat": "error",
    "no-console": "error",
    "no-duplicate-imports": "error",
    "no-var": "error",
    "prefer-arrow-callback": [
      "error",
      {
        "allowNamedFunctions": true
      }
    ],
    "prefer-const": "error",
    "prefer-object-spread": "error",
    "prefer-promise-reject-errors": "error",
    "prefer-rest-params": "error",
    "prefer-spread": "error",
    "radix": ["error", "as-needed"],
    "require-await": "error",
    "rest-spread-spacing": ["error", "never"],
    "react/forbid-component-props": ["error", {
      "forbid": ["for"]
    }],
    "react/jsx-key": "error",
    "react/no-array-index-key": "error",
    "react/no-unknown-property": [
      "error",
      {
        "ignore": [
          "amp",
          "amp-boilerplate",
          "amp-custom",
          "animate-in",
          "animate-in-delay",
          "animate-in-duration",
          "custom-element"
        ]
      }
    ],
    "react/prop-types": "error",
    "react-hooks/rules-of-hooks": "error",
    "react-hooks/exhaustive-deps": [
      "error",
      {
        "enableDangerousAutofixThisMayCauseInfiniteLoops": false,
        "additionalHooks": [
          {
            "test": "useSelect$",
            "callbackIndex": 0
          },
          {
            "test": "useBatchingCallback",
            "callbackIndex": 0
          },
          {
            "test": "useKeyEffectInternal",
            "callbackIndex": 3
          },
          {
            "test": "useKeyEffect",
            "callbackIndex": 2
          },
          {
            "test": "useKeyDownEffect",
            "callbackIndex": 2
          },
          {
            "test": "useKeyUpEffect",
            "callbackIndex": 2
          },
          {
            "test": "useGlobalKeyDownEffect",
            "callbackIndex": 1
          },
          {
            "test": "useGlobalKeyUpEffect",
            "callbackIndex": 1
          },
          {
            "test": "useIntersectionEffect",
            "callbackIndex": 2
          },
          {
            "test": "useResizeEffect",
            "callbackIndex": 1
          }
        ]
      }
    ],
    "react/jsx-boolean-value": "error",
    "react/jsx-fragments": "error",
    "react/jsx-no-literals": "error",
    "react/jsx-no-useless-fragment": "error",
    "react/no-unused-prop-types": "error",
    "react/react-in-jsx-scope": "off",
    "react/self-closing-comp": "error",
    "import/no-extraneous-dependencies": "error",
    "import/no-unresolved": "error",
    "import/order": [
      "error",
      {
        "groups": [
          "builtin",
          ["external", "unknown"],
          "internal",
          "parent",
          "sibling",
          "index"
        ]
      }
    ],
    "jsdoc/check-indentation": "error",
    "jsdoc/check-syntax": "error",
    "jsdoc/check-tag-names": ["error", {
      "definedTags": [ "jest-environment" ]
    }],
    "jsdoc/require-jsdoc": ["off", {
      "publicOnly": true
    }],
    "jsdoc/require-returns": "error",
    "jsdoc/require-param-description": "error",
    "jsdoc/tag-lines": [
      "error",
      "any",
      { "startLines": 1 }
    ],
    "jsdoc/valid-types": "error",
    "@eslint-community/eslint-comments/no-unused-disable": "error",
    "@eslint-community/eslint-comments/require-description": "error",
    "@wordpress/dependency-group": "error",
    "@wordpress/i18n-no-flanking-whitespace": "error",
    "@wordpress/no-unused-vars-before-return": ["error", {
      "excludePattern": "^use"
    }],
    "@wordpress/react-no-unsafe-timeout": "error",
    "@wordpress/i18n-text-domain": ["error", {
      "allowedTextDomain": "web-stories"
    }],
    "@wordpress/valid-sprintf": "error",
    "@babel/no-unused-expressions": [
      "error",
      {
        "allowShortCircuit": true
      }
    ]
  },
  "env": {
    "browser": true,
    "es2020": true
  },
  "globals": {
    "__webpack_public_path__": "writable",
    "WEB_STORIES_CI": "readonly",
    "WEB_STORIES_DISABLE_ERROR_BOUNDARIES": "readonly",
    "WEB_STORIES_DISABLE_OPTIMIZED_RENDERING": "readonly",
    "WEB_STORIES_DISABLE_PREVENT": "readonly",
    "WEB_STORIES_DISABLE_QUICK_TIPS": "readonly",
    "WEB_STORIES_ENV": "readonly"
  },
  "settings": {
    "import/resolver": {
      "@web-stories-wp/eslint-import-resolver": {
        "mapping": {
          "^@googleforcreators\\/(.*)\\/(.*)": "./packages/$1/src/$2",
          "^@googleforcreators\\/(.*)": "./packages/$1/src/",
          "^@web-stories-wp\\/(.*)": "./packages/$1/src/"
        },
        "extensions": [ ".js", ".jsx", ".ts", ".tsx" ]
      }
    },
    "jsdoc": {
      "mode": "typescript",
      "preferredTypes": {
        "object": "Object"
      },
      "tagNamePreference": {
        "returns": "return",
        "yields": "yield"
      }
    },
    "react": {
      "version": "detect"
    },
    "linkComponents": [
      "Link",
      {"name": "Plain", "linkAttribute": "href"},
      {"name": "Primary", "linkAttribute": "href"},
      "PrimaryLink",
      "SecondaryLink",
      "ExternalLink",
      "ScrimAnchor"
    ],
    "testing-library/custom-renders": [
      "arrange",
      "renderWithTheme",
      "renderWithProviders",
      "renderPanel",
      "setup"
    ]
  },
  "overrides": [
    {
      "files": [
        "**/*.ts",
        "**/*.tsx"
      ],
      "plugins": [
        "@typescript-eslint"
      ],
      "extends": [
        "plugin:@typescript-eslint/recommended",
        "plugin:@typescript-eslint/recommended-type-checked"
      ],
      "parser": "@typescript-eslint/parser",
      "parserOptions": {
        "EXPERIMENTAL_useProjectService": true,
        "warnOnUnsupportedTypeScriptVersion": false,
        "project": [
          ".tsconfig.json"
        ]
      },
      "rules": {
        "@typescript-eslint/no-shadow": ["error",
          {
            "ignoreOnInitialization": true
          }
        ],
        "@typescript-eslint/unbound-method": [
          "error",
          {
            "ignoreStatic": true
          }
        ],
        "@typescript-eslint/no-unused-vars": [
          "error",
          {
            "ignoreRestSiblings": true
          }
        ],
        "react/prop-types": "off",
        "getter-return": "off",
        "jsdoc/check-param-names": "off",
        "jsdoc/require-param": "off",
        "jsdoc/require-param-type": "off",
        "jsdoc/require-returns": "off",
        "jsdoc/require-returns-check": "off",
        "jsdoc/require-returns-type": "off",
        "jsdoc/no-types": "error",
        "no-duplicate-imports": "off",
        "no-unused-vars": "off",
        "no-shadow": "off",
        "no-restricted-imports": [
          "error",
          {
            "paths": [
              {
                "name": "prop-types",
                "message": "Use TypeScript instead."
              }
            ]
          }
        ]
      }
    },
    {
      "files": [
        "typings/**/*.ts",
        "**/*.d.ts"
      ],
      "rules": {
        "no-undef": "off",
        "no-unused-vars": "off",
        "no-var": "off",
        "@wordpress/dependency-group": "off"
      }
    },
    {
      "files": [
        "__mocks__/**/*.js",
        "**/test/**/*.js",
        "**/test/**/*.ts",
        "**/testUtils/**/*.js",
        "**/testUtils/**/*.ts",
        "tests/js/**/*.js"
      ],
      "excludedFiles": [
        "**/karma/**/*.js",
        "**/test/**/*.karma.js"
      ],
      "extends": [
        "plugin:jest/all",
        "plugin:testing-library/react",
        "plugin:jest-dom/recommended",
        "plugin:jest-extended/all"
      ],
      "plugins": [
        "jsx-a11y",
        "header",
        "testing-library",
        "jest-dom"
      ],
      "env": {
        "node": true
      },
      "rules": {
        "@eslint-community/eslint-comments/require-description": "off",
        "react/prop-types": "off",
        "jest/no-hooks": "off",
        "jest/no-untyped-mock-factory": "off",
        "jest/max-expects": "off",
        "jest/prefer-expect-assertions": "off",
        "jest/prefer-importing-jest-globals": "off",
        "jest/prefer-inline-snapshots": "off",
        "jest/prefer-lowercase-title": [
          "error",
          {
            "ignore": ["describe"]
          }
        ],
        "jest/prefer-mock-promise-shorthand": "off",
        "jest/prefer-snapshot-hint": "off",
        "jsdoc/require-jsdoc": "off",
        "jest/unbound-method": "off",
        "testing-library/no-await-sync-events": "error",
        "testing-library/no-debugging-utils": "error",
        "testing-library/no-dom-import": "error"
      }
    },
    {
      "files": [
        "**/test/**/*.ts",
        "**/testUtils/**/*.ts"
      ],
      "rules": {
        "@typescript-eslint/unbound-method": "off",
        "jest/unbound-method": "error",
        "jest/no-untyped-mock-factory": "error"
      }
    },
    {
      "files": [
        "__mocks__/**/*.js"
      ],
      "rules": {
        "jest/require-hook":  "off"
      }
    },
    {
      "files": [
        "**/karma/**/*.js",
        "packages/karma-*/**/*.js"
      ],
      "extends": [
        "plugin:jasmine/recommended"
      ],
      "plugins": [
        "jsx-a11y",
        "header",
        "testing-library",
        "jasmine"
      ],
      "env": {
        "jasmine": true,
        "node": true
      },
      "rules": {
        "@eslint-community/eslint-comments/require-description": "off",
        "testing-library/no-await-sync-events": "error",
        "testing-library/no-await-sync-queries": "error",
        "testing-library/no-debugging-utils": "error",
        "testing-library/no-dom-import": "error",
        "jasmine/new-line-before-expect": "off",
        "jasmine/no-disabled-tests": "error",
        "jasmine/no-spec-dupes": ["error", "branch"],
        "jasmine/no-suite-dupes": ["error", "branch"],
        "jsdoc/require-jsdoc": "off",
        "no-restricted-imports": [
          "error",
          {
            "paths": [
              {
                "name": "@testing-library/react-hooks",
                "message": "Use karma fixtures instead."
              }
            ]
          }
        ]
      },
      "globals": {
        "karmaPuppeteer": "readonly",
        "karmaSnapshot": "readonly"
      }
    },
    {
      "files": [
        "packages/karma-puppeteer-client/**/*.js"
      ],
      "rules": {
        "no-var": "off",
        "prefer-const": "off"
      }
    },
    {
      "files": [
        "packages/jest-amp/src/**/*.js",
        "packages/jest-puppeteer-amp/src/**/*.js"
      ],
      "env": {
        "node": true
      }
    },
    {
      "files": [
        "packages/jest-puppeteer-amp/src/**/*.js"
      ],
      "globals": {
        "browser": "readonly",
        "page": "readonly"
      }
    },
    {
      "files": [
        "packages/e2e-test-utils/**/*.js",
        "packages/e2e-tests/src/**/*.js"
      ],
      "extends": [
        "plugin:jest/all"
      ],
      "env": {
        "node": true
      },
      "rules": {
        "@eslint-community/eslint-comments/require-description": "off",
        "jest/max-expects": "off",
        "jest/no-hooks": "off",
        "jest/prefer-expect-assertions": "off",
        "jest/prefer-importing-jest-globals": "off",
        "jest/prefer-inline-snapshots": "off",
        "jest/prefer-lowercase-title": [
          "error",
          {
            "ignore": ["describe"]
          }
        ],
        "jest/require-hook": [
          "error",
          {
            "allowedFunctionCalls": [
              "minWPVersionRequired",
              "withDisabledToolbarOnFrontend",
              "withExperimentalFeatures",
              "withPlugin",
              "withRTL",
              "withUser"
            ]
          }
        ],
        "jest/prefer-snapshot-hint": "off",
        "jest/unbound-method": "off"
      },
      "globals": {
        "browser": "readonly",
        "page": "readonly",
        "wp": "readonly"
      }
    },
    {
      "files": [
        "packages/e2e-test-utils/**/*.js"
      ],
      "rules": {
        "@eslint-community/eslint-comments/require-description": "off",
        "jest/expect-expect": "off",
        "jest/max-expects": "off",
        "jest/no-export": "off",
        "jest/require-top-level-describe": "off"
      }
    },
    {
      "files": ["packages/e2e-tests/src/specs/**/*.js"],
      "rules": {
        "jsdoc/require-jsdoc": "off"
      }
    },
    {
      "files": [
        "packages/e2e-tests/src/config/**/*.js",
        "**/testUtils/**/*.js"
      ],
      "rules": {
        "@eslint-community/eslint-comments/require-description": "off",
        "jest/require-hook": "off"
      }
    },
    {
      "files": [
        "packages/commander/**/*.ts",
        "packages/fonts/scripts/**/*.ts",
        "packages/migration/scripts/**/*.js",
        "packages/templates/scripts/**/*.js",
        "packages/text-sets/scripts/**/*.js"
      ],
      "rules": {
        "import/no-useless-path-segments": ["error", {
          "noUselessIndex": false
        }]
      }
    },
    {
      "files": [
        "__mocks__/**/*.js",
        "bin/**/*.js",
        "babel.config.cjs",
        "rollup.config.js",
        "jest-puppeteer.config.cjs",
        "karma-*.config.cjs",
        "webpack.*.cjs",
        ".storybook/*.cjs",
        ".storybook/*.js",
        "tests/js/*.js",
        "packages/e2e-tests/src/*.js",
        "packages/e2e-tests/src/config/*.js",
        "packages/dashboard/src/karma-tests.cjs",
        "packages/story-editor/src/karma-tests.cjs",
        "packages/eslint-import-resolver/**/*.cjs",
        "packages/jest-resolver/**/*.cjs",
        "packages/fonts/**/*.ts",
        "packages/commander/**/*.ts",
        "packages/migration/scripts/**/*.js",
        "packages/templates/scripts/**/*.js",
        "packages/text-sets/scripts/**/*.js"
      ],
      "extends": [
        "plugin:node/recommended",
        "plugin:security/recommended-legacy"
      ],
      "plugins": [
        "security"
      ],
      "env": {
        "node": true
      },
      "rules": {
        "@eslint-community/eslint-comments/require-description": "off",
        "node/no-extraneous-import": "off",
        "node/no-missing-import": "off",
        "node/no-unpublished-import": "off",
        "node/no-unpublished-require": "off",
        "security/detect-non-literal-fs-filename": "off"
      }
    },
    {
      "files": [
        "packages/commander/src/index.ts"
      ],
      "rules": {
        "no-console": "off",
        "node/shebang": "off"
      }
    },
    {
      "files": [
        "packages/migration/scripts/utils/updateTemplates.js"
      ],
      "rules": {
        "@eslint-community/eslint-comments/no-unused-disable": "off"
      }
    },
    {
      "files": [
        "*.md",
        "**/*.md"
      ],
      "processor": "markdown/markdown"
    },
    {
      "files": [
        "**/*.md/*.js"
      ],
      "parserOptions": {
        "ecmaFeatures": {
          "impliedStrict": true
        }
      },
      "rules": {
        "import/no-unresolved": "off",
        "import/no-extraneous-dependencies": "off",
        "@wordpress/dependency-group": "off",
        "no-console": "off",
        "no-undef": "off",
        "no-unused-vars": "off",
        "header/header": "off",
        "prettier/prettier": "off",
        "@eslint-community/eslint-comments/require-description": "off",
        "react/prop-types" : "off"
      }
    },
    {
      "files": [
        "packages/dashboard/src/**/*.js",
        "packages/story-editor/src/**/*.js",
        "packages/**/*.js"
      ],
      "excludedFiles": [
        "packages/activation-notice/**/*.tsx",
        "packages/i18n/**/*.js",
        "packages/stories-block/**/*.js",
        "packages/tinymce-button/**/*.js"
      ],
      "rules":{
        "no-restricted-imports": [
          "error",
          {
            "paths": [
              {
                "name": "@wordpress/i18n",
                "message": "Use @googleforcreators/i18n instead."
              }
            ]
          }
        ]
      }
    },
    {
      "files": [
        "packages/activation-notice/**/*.tsx",
        "packages/stories-block/**/*.js",
        "packages/tinymce-button/**/*.js"
      ],
      "rules":{
        "@wordpress/data-no-store-string-literals": "error",
        "no-restricted-imports": [
          "error",
          {
            "paths": [
              {
                "name": "@googleforcreators/i18n",
                "message": "Use @wordpress/i18n instead."
              },
              {
                "name": "react",
                "message": "Please use React API through `@wordpress/element` instead."
              },
              {
                "name": "react-dom",
                "message": "Please use React API through `@wordpress/element` instead."
              }
            ]
          }
        ]
      }
    },
    {
      "files": [
        "packages/**/*.js"
      ],
      "excludedFiles": [
        ".storybook/preview.js",
        "__mocks__/**/*.js",
        "packages/activation-notice/**/*.tsx",
        "packages/react/**/*.js",
        "packages/dashboard/src/karma/fixture.js",
        "packages/story-editor/src/karma/fixture/fixture.js",
        "packages/story-block/**/*.js",
        "packages/tinymce-button/**/*.js"
      ],
      "rules":{
        "no-restricted-imports": [
          "error",
          {
            "paths": [
              {
                "name": "react",
                "message": "Use @googleforcreators/react instead."
              },
              {
                "name": "react-dom",
                "message": "Use @googleforcreators/react instead."
              }
            ]
          }
        ]
      }
    },
    {
      "files": [
        "packages/activation-notice/**/*.tsx"
      ],
      "rules":{
        "no-restricted-imports": "off",
        "import/no-named-as-default": "off",
        "@typescript-eslint/no-restricted-imports": [
          "error",
          {
            "paths": [
              {
                "name": "react",
                "message": "Use @wordpress/element instead.",
                "allowTypeImports": true
              },
              {
                "name": "react-dom",
                "message": "Use @wordpress/element instead.",
                "allowTypeImports": true
              }
            ]
          }
        ]
      }
    },
    {
      "files": [
        "packages/tinymce-button/src/**/*.js"
      ],
      "globals": {
        "tinymce": "readonly"
      }
    },
    {
      "files": [
        "**/stories/*.js",
        ".storybook/main.cjs"
      ],
      "rules": {
        "react/no-array-index-key" : "off",
        "react/prop-types": "off",
        "@eslint-community/eslint-comments/no-unused-disable": "off",
        "@eslint-community/eslint-comments/require-description": "off"
      }
    },
    {
      "files": [
        "__mocks__/**/*",
        ".storybook/stories/**/*"
      ],
      "rules": {
        "import/no-extraneous-dependencies" : "off"
      }
    },
    {
      "files": [
        "packages/story-editor/src/**/*.js",
        "packages/dashboard/src/**/*.js"
      ],
      "rules": {
        "no-restricted-imports": [
          "error",
          {
            "patterns": [
              {
                "group": [
                  "**/*.css"
                ],
                "message": "css import is not allowed in story-editor and dashboard"
              }
            ]
          }
        ]
      }
    },
    {
      "files": [
        "packages/date/src/third_party/**/*"
      ],
      "rules": {
        "header/header": "off",
        "@typescript-eslint/no-explicit-any": "off",
        "@typescript-eslint/ban-ts-comment": "off",
        "@typescript-eslint/no-unsafe-return": "off"
      }
    },
    {
      "files": [
        "packages/story-editor/src/components/canvas/mediaCaptions/cue.js"
      ],
      "rules": {
        "@eslint-community/eslint-comments/no-unused-disable": "off",
      }
    }
  ]
}