playwright-ast-coverage 0.2.0

Static Playwright AST coverage for Next.js App Router routes
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88

# ESLint and Oxlint Plugin

`eslint-plugin-playwright-ast-coverage` catches test-hook issues while editing:
non-literal IDs, empty IDs, duplicate IDs within a file, inconsistent attributes,
missing interactive IDs, CSS selectors that should be `getByTestId`, and naming
convention violations.

## Install

```sh
npm install --save-dev eslint-plugin-playwright-ast-coverage
```

## ESLint

```js
const playwrightAstCoverage = require("eslint-plugin-playwright-ast-coverage");

module.exports = [
  {
    files: ["**/*.{js,jsx,ts,tsx}"],
    plugins: { "playwright-ast-coverage": playwrightAstCoverage },
    rules: playwrightAstCoverage.configs.strict.rules,
  },
];
```

## Oxlint

```jsonc
{
  "jsPlugins": ["eslint-plugin-playwright-ast-coverage"],
  "rules": {
    "playwright-ast-coverage/literals": "error",
    "playwright-ast-coverage/defaults": "error",
    "playwright-ast-coverage/unique": "error",
  },
}
```

`configs.recommended` enables `literals`, `defaults`, `no-empty`, and `unique`.
`configs.strict` also enables canonical attribute, naming, interactive element,
and `getByTestId` preference rules.

## Rule Options

All rules default to checking both `data-testid` and `data-pw`. Override that
with `selectorAttributes`:

```js
{
  "playwright-ast-coverage/literals": ["error", {
    selectorAttributes: ["data-pw", "data-qa"]
  }]
}
```

`playwright-ast-coverage/literals` also supports:

- `allowDefaultedProps`: boolean. Defaults to `true`. Allows a test ID passed
  through a function prop when that prop has a string-literal default. This
  includes function parameter defaults and local `const` destructuring defaults,
  such as `const { "data-pw": dataPw = "save" } = props`. Local destructuring
  defaults are only accepted when the source is rooted in a function parameter
  whose name ends in `props`, case-insensitively, such as `props`, `buttonProps`,
  or `variantProps`. The local const declaration must appear before the test ID
  reference and must be in the function body or an `if`/`else` block; loop,
  switch, try/catch, and labeled statement containers are intentionally not
  treated as passthrough assertions.
- `allowStaticTemplates`: boolean. Defaults to `false`. Allows template literals
  with at least one static text segment, such as `` `user-${id}` ``.

## Rules

| Rule                                                  | Purpose                                                                         |
| ----------------------------------------------------- | ------------------------------------------------------------------------------- |
| `playwright-ast-coverage/literals`                    | Requires JSX test-id attributes and `getByTestId()` arguments to be static.     |
| `playwright-ast-coverage/defaults`                    | Requires prop-passed test IDs to have string-literal defaults.                  |
| `playwright-ast-coverage/unique`                      | Requires literal test IDs to be unique within the same file.                    |
| `playwright-ast-coverage/no-empty`                    | Disallows empty literal test IDs.                                               |
| `playwright-ast-coverage/consistent-attribute`        | Requires a canonical test-id attribute when multiple attributes are recognized. |
| `playwright-ast-coverage/require-interactive-test-id` | Requires test IDs on interactive JSX elements.                                  |
| `playwright-ast-coverage/prefer-get-by-test-id`       | Reports exact CSS test-id selectors passed to Playwright selector APIs.         |
| `playwright-ast-coverage/naming-convention`           | Requires literal test IDs to match a configurable regular expression.           |

Use `playwright-ast-coverage check --assert-unique-test-ids` and, when needed,
`--assert-unique-html-ids` for project-wide uniqueness in CI. Lint rules are
file-local.