@wistia/eslint-config 1.1.0 → 1.2.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @wistia/eslint-config
 
+## 1.2.0
+
+### Minor Changes
+
+- [#399](https://github.com/wistia/eslint-config/pull/399) [`14247d1`](https://github.com/wistia/eslint-config/commit/14247d13443a3d6ba4a2754feda887766ff573a5) Thanks [@okize](https://github.com/okize)! - feat: add rules & config for playwright
+
 ## 1.1.0
 
 ### Minor Changes

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wistia/eslint-config",
-  "version": "1.1.0",
+  "version": "1.2.0",
   "description": "Wistia's ESLint configurations",
   "packageManager": "yarn@4.9.2",
   "type": "module",
@@ -14,6 +14,7 @@
     "./javascript": "./src/configs/javascript.mjs",
     "./jest": "./src/configs/jest.mjs",
     "./node": "./src/configs/node.mjs",
+    "./playwright": "./src/configs/playwright.mjs",
     "./react": "./src/configs/react.mjs",
     "./react-ssr-compatibility": "./src/configs/react-ssr-compatibility.mjs",
     "./storybook": "./src/configs/storybook.mjs",
@@ -57,6 +58,7 @@
     "eslint-plugin-n": "^17.23.1",
     "eslint-plugin-no-only-tests": "^3.3.0",
     "eslint-plugin-no-typeof-window-undefined": "^0.0.2",
+    "eslint-plugin-playwright": "^2.4.0",
     "eslint-plugin-prettier": "^5.5.4",
     "eslint-plugin-promise": "^7.2.1",
     "eslint-plugin-react": "^7.37.5",

package/src/configs/playwright.mjs

@@ -0,0 +1,19 @@
+import playwrightPlugin from 'eslint-plugin-playwright';
+import playwrightRules from '../rules/playwright.mjs';
+
+export default [
+  {
+    languageOptions: {
+      globals: playwrightPlugin.configs['flat/recommended'].languageOptions.globals,
+    },
+    plugins: {
+      playwright: playwrightPlugin,
+    },
+    rules: {
+      ...playwrightRules,
+
+      // see: https://github.com/mskelton/eslint-plugin-playwright/pull/26
+      'no-empty-pattern': 'off',
+    },
+  },
+];

package/src/configs/storybook.mjs

@@ -13,6 +13,15 @@ export default [
     },
     rules: {
       ...storybookRules,
+      // storybook >7 requires default exports in stories
+      'import/no-anonymous-default-export': 'off',
+      'import/no-default-export': 'off',
+      'import/no-extraneous-dependencies': ['error', { devDependencies: true }],
+      'import/prefer-default-export': 'error',
+
+      // the default export is always called `meta` so the filenames
+      // will never match the exported name
+      'filenames/match-exported': 'off',
     },
   },
 ];

package/src/rules/playwright.mjs

@@ -0,0 +1,216 @@
+// Playwright-specific ESLint rules
+// see: https://github.com/playwright-community/eslint-plugin-playwright#rules
+
+export default {
+  // Prevent focused tests (.only)
+  // https://github.com/playwright-community/eslint-plugin-playwright/blob/main/docs/rules/no-focused-test.md
+  'playwright/no-focused-test': 'error',
+
+  // Enforce assertion to be made in a test body
+  // https://github.com/playwright-community/eslint-plugin-playwright/blob/main/docs/rules/expect-expect.md
+  'playwright/expect-expect': 'error',
+
+  // Enforce Playwright APIs to be awaited
+  // https://github.com/playwright-community/eslint-plugin-playwright/blob/main/docs/rules/missing-playwright-await.md
+  'playwright/missing-playwright-await': 'error',
+
+  // Enforces a maximum depth to nested describe calls
+  // https://github.com/playwright-community/eslint-plugin-playwright/blob/main/docs/rules/max-nested-describe.md
+  'playwright/max-nested-describe': 'error',
+
+  // Prevent calling `expect` conditionally
+  // https://github.com/playwright-community/eslint-plugin-playwright/blob/main/docs/rules/no-conditional-expect.md
+  'playwright/no-conditional-expect': 'error',
+
+  // Disallow conditional logic in tests
+  // https://github.com/playwright-community/eslint-plugin-playwright/blob/main/docs/rules/no-conditional-in-test.md
+  'playwright/no-conditional-in-test': 'error',
+
+  // Disallow commented out tests
+  // https://github.com/playwright-community/eslint-plugin-playwright/blob/main/docs/rules/no-commented-out-tests.md
+  'playwright/no-commented-out-tests': 'error',
+
+  // Disallow duplicate setup and teardown hooks
+  // https://github.com/playwright-community/eslint-plugin-playwright/blob/main/docs/rules/no-duplicate-hooks.md
+  'playwright/no-duplicate-hooks': 'error',
+
+  // Disallow usage of element handles (prefer locators)
+  // https://github.com/playwright-community/eslint-plugin-playwright/blob/main/docs/rules/no-element-handle.md
+  'playwright/no-element-handle': 'error',
+
+  // Disallow usage of `page.$eval()` and `page.$$eval()`
+  // https://github.com/playwright-community/eslint-plugin-playwright/blob/main/docs/rules/no-eval.md
+  'playwright/no-eval': 'error',
+
+  // Disallow usage of the `{ force: true }` option
+  // https://github.com/playwright-community/eslint-plugin-playwright/blob/main/docs/rules/no-force-option.md
+  'playwright/no-force-option': 'error',
+
+  // Disallow using `getByTitle()`
+  // https://github.com/playwright-community/eslint-plugin-playwright/blob/main/docs/rules/no-get-by-title.md
+  'playwright/no-get-by-title': 'error',
+
+  // Disallow setup and teardown hooks
+  // https://github.com/playwright-community/eslint-plugin-playwright/blob/main/docs/rules/no-hooks.md
+  // decision: hooks are useful for setup and teardown, similar to Jest configuration
+  'playwright/no-hooks': 'off',
+
+  // Disallow nested `test.step()` methods
+  // https://github.com/playwright-community/eslint-plugin-playwright/blob/main/docs/rules/no-nested-step.md
+  'playwright/no-nested-step': 'error',
+
+  // Disallow usage of the `networkidle` option
+  // https://github.com/playwright-community/eslint-plugin-playwright/blob/main/docs/rules/no-networkidle.md
+  'playwright/no-networkidle': 'error',
+
+  // Disallow using `page.pause()`
+  // https://github.com/playwright-community/eslint-plugin-playwright/blob/main/docs/rules/no-page-pause.md
+  'playwright/no-page-pause': 'error',
+
+  // Disallow using raw locators
+  // https://github.com/playwright-community/eslint-plugin-playwright/blob/main/docs/rules/no-raw-locators.md
+  'playwright/no-raw-locators': 'error',
+
+  // Disallow usage of the `.skip` annotation
+  // https://github.com/playwright-community/eslint-plugin-playwright/blob/main/docs/rules/no-skipped-test.md
+  // decision: it is often useful to be allowed to add a .skip, similar to Jest configuration
+  'playwright/no-skipped-test': 'off',
+
+  // Disallow using expect outside of `test` blocks
+  // https://github.com/playwright-community/eslint-plugin-playwright/blob/main/docs/rules/no-standalone-expect.md
+  'playwright/no-standalone-expect': 'error',
+
+  // Prevent unsafe variable references in `page.evaluate()`
+  // https://github.com/playwright-community/eslint-plugin-playwright/blob/main/docs/rules/no-unsafe-references.md
+  'playwright/no-unsafe-references': 'error',
+
+  // Disallow usage of page locators that are not used
+  // https://github.com/playwright-community/eslint-plugin-playwright/blob/main/docs/rules/no-unused-locators.md
+  'playwright/no-unused-locators': 'error',
+
+  // Disallow unnecessary `await`s for Playwright methods
+  // https://github.com/playwright-community/eslint-plugin-playwright/blob/main/docs/rules/no-useless-await.md
+  'playwright/no-useless-await': 'error',
+
+  // Disallow usage of `not` matchers when a specific matcher exists
+  // https://github.com/playwright-community/eslint-plugin-playwright/blob/main/docs/rules/no-useless-not.md
+  'playwright/no-useless-not': 'error',
+
+  // Disallow usage of `page.waitForNavigation()`
+  // https://github.com/playwright-community/eslint-plugin-playwright/blob/main/docs/rules/no-wait-for-navigation.md
+  'playwright/no-wait-for-navigation': 'error',
+
+  // Disallow usage of `page.waitForSelector()`
+  // https://github.com/playwright-community/eslint-plugin-playwright/blob/main/docs/rules/no-wait-for-selector.md
+  'playwright/no-wait-for-selector': 'error',
+
+  // Disallow usage of `page.waitForTimeout()`
+  // https://github.com/playwright-community/eslint-plugin-playwright/blob/main/docs/rules/no-wait-for-timeout.md
+  'playwright/no-wait-for-timeout': 'error',
+
+  // Suggest built-in locators over `page.locator()`
+  // https://github.com/playwright-community/eslint-plugin-playwright/blob/main/docs/rules/prefer-native-locators.md
+  'playwright/prefer-native-locators': 'error',
+
+  // Enforce lowercase test names
+  // https://github.com/playwright-community/eslint-plugin-playwright/blob/main/docs/rules/prefer-lowercase-title.md
+  // decision: descriptions are often named after React components which are capitalized, similar to Jest
+  'playwright/prefer-lowercase-title': 'off',
+
+  // Suggest using web first assertions
+  // https://github.com/playwright-community/eslint-plugin-playwright/blob/main/docs/rules/prefer-web-first-assertions.md
+  'playwright/prefer-web-first-assertions': 'error',
+
+  // Require setup and teardown code to be within a hook
+  // https://github.com/playwright-community/eslint-plugin-playwright/blob/main/docs/rules/require-hook.md
+  'playwright/require-hook': 'error',
+
+  // Enforce valid `describe()` callback
+  // https://github.com/playwright-community/eslint-plugin-playwright/blob/main/docs/rules/valid-describe-callback.md
+  'playwright/valid-describe-callback': 'error',
+
+  // Enforce valid `expect()` usage
+  // https://github.com/playwright-community/eslint-plugin-playwright/blob/main/docs/rules/valid-expect.md
+  'playwright/valid-expect': 'error',
+
+  // Enforce valid titles
+  // https://github.com/playwright-community/eslint-plugin-playwright/blob/main/docs/rules/valid-title.md
+  'playwright/valid-title': 'error',
+
+  // Enforces a maximum number of expects in a test
+  // https://github.com/playwright-community/eslint-plugin-playwright/blob/main/docs/rules/max-expects.md
+  'playwright/max-expects': 'error',
+
+  // Enforce valid `expect()` usage in promises
+  // https://github.com/playwright-community/eslint-plugin-playwright/blob/main/docs/rules/valid-expect-in-promise.md
+  'playwright/valid-expect-in-promise': 'error',
+
+  // Require test cases and hooks to be inside a `describe` block
+  // https://github.com/playwright-community/eslint-plugin-playwright/blob/main/docs/rules/require-top-level-describe.md
+  'playwright/require-top-level-describe': 'error',
+
+  // Enforce valid test tags
+  // https://github.com/playwright-community/eslint-plugin-playwright/blob/main/docs/rules/valid-test-tags.md
+  'playwright/valid-test-tags': 'error',
+
+  // Disallow usage of the `.slow()` annotation
+  // https://github.com/playwright-community/eslint-plugin-playwright/blob/main/docs/rules/no-slowed-test.md
+  'playwright/no-slowed-test': 'error',
+
+  // Disallow usage of nth methods
+  // https://github.com/playwright-community/eslint-plugin-playwright/blob/main/docs/rules/no-nth-methods.md
+  'playwright/no-nth-methods': 'error',
+
+  // Disallow specific matchers
+  // https://github.com/playwright-community/eslint-plugin-playwright/blob/main/docs/rules/no-restricted-matchers.md
+  'playwright/no-restricted-matchers': 'off', // off by default, can be configured per project
+
+  // Suggest using comparison matchers
+  // https://github.com/playwright-community/eslint-plugin-playwright/blob/main/docs/rules/prefer-comparison-matcher.md
+  'playwright/prefer-comparison-matcher': 'error',
+
+  // Suggest using equality matchers
+  // https://github.com/playwright-community/eslint-plugin-playwright/blob/main/docs/rules/prefer-equality-matcher.md
+  'playwright/prefer-equality-matcher': 'error',
+
+  // Enforce hook ordering
+  // https://github.com/playwright-community/eslint-plugin-playwright/blob/main/docs/rules/prefer-hooks-in-order.md
+  'playwright/prefer-hooks-in-order': 'error',
+
+  // Enforce hooks to be at the top of tests
+  // https://github.com/playwright-community/eslint-plugin-playwright/blob/main/docs/rules/prefer-hooks-on-top.md
+  'playwright/prefer-hooks-on-top': 'error',
+
+  // Suggest using `locator()` over other locator methods
+  // https://github.com/playwright-community/eslint-plugin-playwright/blob/main/docs/rules/prefer-locator.md
+  'playwright/prefer-locator': 'error',
+
+  // Suggest using `toStrictEqual()` over `toEqual()`
+  // https://github.com/playwright-community/eslint-plugin-playwright/blob/main/docs/rules/prefer-strict-equal.md
+  'playwright/prefer-strict-equal': 'error',
+
+  // Suggest using `toBe()` for primitive literals
+  // https://github.com/playwright-community/eslint-plugin-playwright/blob/main/docs/rules/prefer-to-be.md
+  'playwright/prefer-to-be': 'error',
+
+  // Suggest using `toContain()`
+  // https://github.com/playwright-community/eslint-plugin-playwright/blob/main/docs/rules/prefer-to-contain.md
+  'playwright/prefer-to-contain': 'error',
+
+  // Suggest using `toHaveCount()`
+  // https://github.com/playwright-community/eslint-plugin-playwright/blob/main/docs/rules/prefer-to-have-count.md
+  'playwright/prefer-to-have-count': 'error',
+
+  // Suggest using `toHaveLength()`
+  // https://github.com/playwright-community/eslint-plugin-playwright/blob/main/docs/rules/prefer-to-have-length.md
+  'playwright/prefer-to-have-length': 'error',
+
+  // Require soft assertions
+  // https://github.com/playwright-community/eslint-plugin-playwright/blob/main/docs/rules/require-soft-assertions.md
+  // decision: off by default as it's project-specific
+  'playwright/require-soft-assertions': 'off',
+
+  // Require `toThrow()` to have a message
+  // https://github.com/playwright-community/eslint-plugin-playwright/blob/main/docs/rules/require-to-throw-message.md
+  'playwright/require-to-throw-message': 'error',
+};

package/src/rules/storybook.mjs

@@ -2,16 +2,6 @@
 // see: https://github.com/storybookjs/eslint-plugin-storybook#supported-rules-and-configurations
 
 export default {
-  // storybook >7 requires default exports in stories
-  'import/no-anonymous-default-export': 'off',
-  'import/no-default-export': 'off',
-  'import/no-extraneous-dependencies': ['error', { devDependencies: true }],
-  'import/prefer-default-export': 'error',
-
-  // ...and the default export is always called `meta` so the filenames
-  // will never match the exported name
-  'filenames/match-exported': 'off',
-
   // Interactions should be awaited
   // https://github.com/storybookjs/eslint-plugin-storybook/blob/main/docs/rules/await-interactions.md
   'storybook/await-interactions': 'error',

package/test/__snapshots__/playwright.mjs.snap

@@ -0,0 +1,256 @@
+{
+  "language": "@/js",
+  "languageOptions": {
+    "ecmaVersion": 2026,
+    "globals": {
+      "AbortController": false,
+      "AbortSignal": false,
+      "AsyncDisposableStack": false,
+      "Blob": false,
+      "BroadcastChannel": false,
+      "ByteLengthQueuingStrategy": false,
+      "CloseEvent": false,
+      "CompressionStream": false,
+      "CountQueuingStrategy": false,
+      "Crypto": false,
+      "CryptoKey": false,
+      "CustomEvent": false,
+      "DOMException": false,
+      "DecompressionStream": false,
+      "DisposableStack": false,
+      "ErrorEvent": false,
+      "Event": false,
+      "EventTarget": false,
+      "File": false,
+      "FormData": false,
+      "Headers": false,
+      "MessageChannel": false,
+      "MessageEvent": false,
+      "MessagePort": false,
+      "Navigator": false,
+      "Performance": false,
+      "PerformanceEntry": false,
+      "PerformanceMark": false,
+      "PerformanceMeasure": false,
+      "PerformanceObserver": false,
+      "PerformanceObserverEntryList": false,
+      "PerformanceResourceTiming": false,
+      "ReadableByteStreamController": false,
+      "ReadableStream": false,
+      "ReadableStreamBYOBReader": false,
+      "ReadableStreamBYOBRequest": false,
+      "ReadableStreamDefaultController": false,
+      "ReadableStreamDefaultReader": false,
+      "Request": false,
+      "Response": false,
+      "Storage": false,
+      "SubtleCrypto": false,
+      "SuppressedError": false,
+      "TextDecoder": false,
+      "TextDecoderStream": false,
+      "TextEncoder": false,
+      "TextEncoderStream": false,
+      "TransformStream": false,
+      "TransformStreamDefaultController": false,
+      "URL": false,
+      "URLPattern": false,
+      "URLSearchParams": false,
+      "WebAssembly": false,
+      "WebSocket": false,
+      "WritableStream": false,
+      "WritableStreamDefaultController": false,
+      "WritableStreamDefaultWriter": false,
+      "atob": false,
+      "btoa": false,
+      "clearInterval": false,
+      "clearTimeout": false,
+      "console": false,
+      "crypto": false,
+      "fetch": false,
+      "localStorage": false,
+      "navigator": false,
+      "performance": false,
+      "queueMicrotask": false,
+      "sessionStorage": false,
+      "setInterval": false,
+      "setTimeout": false,
+      "structuredClone": false,
+    },
+    "parser": "espree@10.4.0",
+    "parserOptions": {
+      "sourceType": "module",
+    },
+    "sourceType": "module",
+  },
+  "linterOptions": {
+    "reportUnusedDisableDirectives": 1,
+  },
+  "plugins": [
+    "@",
+    "playwright",
+  ],
+  "rules": {
+    "no-empty-pattern": [
+      0,
+      {
+        "allowObjectPatternsAsParameters": false,
+      },
+    ],
+    "playwright/expect-expect": [
+      2,
+    ],
+    "playwright/max-expects": [
+      2,
+    ],
+    "playwright/max-nested-describe": [
+      2,
+    ],
+    "playwright/missing-playwright-await": [
+      2,
+    ],
+    "playwright/no-commented-out-tests": [
+      2,
+    ],
+    "playwright/no-conditional-expect": [
+      2,
+    ],
+    "playwright/no-conditional-in-test": [
+      2,
+    ],
+    "playwright/no-duplicate-hooks": [
+      2,
+    ],
+    "playwright/no-element-handle": [
+      2,
+    ],
+    "playwright/no-eval": [
+      2,
+    ],
+    "playwright/no-focused-test": [
+      2,
+    ],
+    "playwright/no-force-option": [
+      2,
+    ],
+    "playwright/no-get-by-title": [
+      2,
+    ],
+    "playwright/no-hooks": [
+      0,
+    ],
+    "playwright/no-nested-step": [
+      2,
+    ],
+    "playwright/no-networkidle": [
+      2,
+    ],
+    "playwright/no-nth-methods": [
+      2,
+    ],
+    "playwright/no-page-pause": [
+      2,
+    ],
+    "playwright/no-raw-locators": [
+      2,
+    ],
+    "playwright/no-restricted-matchers": [
+      0,
+    ],
+    "playwright/no-skipped-test": [
+      0,
+    ],
+    "playwright/no-slowed-test": [
+      2,
+    ],
+    "playwright/no-standalone-expect": [
+      2,
+    ],
+    "playwright/no-unsafe-references": [
+      2,
+    ],
+    "playwright/no-unused-locators": [
+      2,
+    ],
+    "playwright/no-useless-await": [
+      2,
+    ],
+    "playwright/no-useless-not": [
+      2,
+    ],
+    "playwright/no-wait-for-navigation": [
+      2,
+    ],
+    "playwright/no-wait-for-selector": [
+      2,
+    ],
+    "playwright/no-wait-for-timeout": [
+      2,
+    ],
+    "playwright/prefer-comparison-matcher": [
+      2,
+    ],
+    "playwright/prefer-equality-matcher": [
+      2,
+    ],
+    "playwright/prefer-hooks-in-order": [
+      2,
+    ],
+    "playwright/prefer-hooks-on-top": [
+      2,
+    ],
+    "playwright/prefer-locator": [
+      2,
+    ],
+    "playwright/prefer-lowercase-title": [
+      0,
+    ],
+    "playwright/prefer-native-locators": [
+      2,
+    ],
+    "playwright/prefer-strict-equal": [
+      2,
+    ],
+    "playwright/prefer-to-be": [
+      2,
+    ],
+    "playwright/prefer-to-contain": [
+      2,
+    ],
+    "playwright/prefer-to-have-count": [
+      2,
+    ],
+    "playwright/prefer-to-have-length": [
+      2,
+    ],
+    "playwright/prefer-web-first-assertions": [
+      2,
+    ],
+    "playwright/require-hook": [
+      2,
+    ],
+    "playwright/require-soft-assertions": [
+      0,
+    ],
+    "playwright/require-to-throw-message": [
+      2,
+    ],
+    "playwright/require-top-level-describe": [
+      2,
+    ],
+    "playwright/valid-describe-callback": [
+      2,
+    ],
+    "playwright/valid-expect": [
+      2,
+    ],
+    "playwright/valid-expect-in-promise": [
+      2,
+    ],
+    "playwright/valid-test-tags": [
+      2,
+    ],
+    "playwright/valid-title": [
+      2,
+    ],
+  },
+}