eslint-plugin-test-governance 0.6.2 → 0.8.0

package/dist/utils/options.d.ts

@@ -20,14 +20,14 @@ export interface CustomState {
 /** Options shared by every rule. Set them once in `settings['test-governance']`. */
 export interface GovernanceOptions {
     /**
-     * The test framework of the files the config applies to: `'playwright'`, `'jest'` or `'vitest'`. Required;
-     * `configs.playwright`, `configs.jest` and `configs.vitest` set it.
+     * The test framework of the files the config applies to: `'playwright'`, `'jest'`, `'vitest'`, `'mocha'`,
+     * `'cypress'`, `'webdriverio'` or `'node-test'`. Required; each framework's config, such as `configs.mocha`, sets it.
      */
     framework: FrameworkName;
     /**
-     * Names that are treated as the framework's `test` function. Defaults to `['test']` for Playwright and
-     * `['test', 'it']` for Jest and Vitest. Your list replaces the default one, so include those names if
-     * you still need them.
+     * Names that are treated as the framework's `test` function. Defaults to `['test']` for Playwright,
+     * `['test', 'it']` for Jest and Vitest, and `['it', 'specify', 'test']` for Mocha, Cypress and
+     * WebdriverIO. Your list replaces the default one, so include those names if you still need them.
      */
     testFunctions?: string[];
     /** Accepted ticket formats. Defaults to `{ preset: 'any' }`. */

package/dist/utils/schema.js

@@ -6,7 +6,9 @@ const KEY_PATTERN = '^[A-Z][A-Z0-9_]+$';
 const KEY_HINT = 'an uppercase key as it appears in tickets, such as WEB for WEB-123';
 /** `['"a"', '"b"', '"c"']` as `"a", "b" or "c"`. */
 const orList = (items) => `${items.slice(0, -1).join(', ')} or ${items.slice(-1).join('')}`;
-const FRAMEWORK_HINT = `set it to ${orList(FRAMEWORK_NAMES.map((name) => `"${name}"`))}, or use ${orList(FRAMEWORK_NAMES.map((name) => `configs.${name}`))}`;
+/** How code reads a framework's config: `configs.mocha`, or `configs['node-test']` for a name with a dash. */
+const configAccess = (name) => (/^\w+$/.test(name) ? `configs.${name}` : `configs['${name}']`);
+const FRAMEWORK_HINT = `set it to ${orList(FRAMEWORK_NAMES.map((name) => `"${name}"`))}, or use ${orList(FRAMEWORK_NAMES.map(configAccess))}`;
 const ticketSpecSchema = {
     type: 'object',
     properties: {

package/docs/rules/marker-matches-state.md

@@ -2,7 +2,7 @@
 
 📝 Require the marker keyword to match the test's state.
 
-💼 This rule is enabled in the following [configs](https://github.com/Huldoser/eslint-plugin-test-governance#usage): 🃏 `jest`, 🎭 `playwright`, ⚡ `vitest`.
+💼 This rule is enabled in the following [configs](https://github.com/Huldoser/eslint-plugin-test-governance#usage): 🌲 `cypress`, 🃏 `jest`, ☕ `mocha`, 🟢 `node-test`, 🎭 `playwright`, ⚡ `vitest`, 🤖 `webdriverio`.
 
 💡 This rule is manually fixable by [editor suggestions](https://eslint.org/docs/latest/use/core-concepts#rule-suggestions).
 

package/docs/rules/no-conflicting-states.md

@@ -2,7 +2,7 @@
 
 📝 Disallow state tags that contradict each other, differ in case or look like typos.
 
-⚠️ This rule _warns_ in the following [configs](https://github.com/Huldoser/eslint-plugin-test-governance#usage): 🃏 `jest`, 🎭 `playwright`, ⚡ `vitest`.
+⚠️ This rule _warns_ in the following [configs](https://github.com/Huldoser/eslint-plugin-test-governance#usage): 🌲 `cypress`, 🃏 `jest`, ☕ `mocha`, 🟢 `node-test`, 🎭 `playwright`, ⚡ `vitest`, 🤖 `webdriverio`.
 
 🔧 This rule is automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).
 

package/docs/rules/no-orphaned-marker.md

@@ -2,7 +2,7 @@
 
 📝 Disallow marker comments that no longer match a test state.
 
-💼 This rule is enabled in the following [configs](https://github.com/Huldoser/eslint-plugin-test-governance#usage): 🃏 `jest`, 🎭 `playwright`, ⚡ `vitest`.
+💼 This rule is enabled in the following [configs](https://github.com/Huldoser/eslint-plugin-test-governance#usage): 🌲 `cypress`, 🃏 `jest`, ☕ `mocha`, 🟢 `node-test`, 🎭 `playwright`, ⚡ `vitest`, 🤖 `webdriverio`.
 
 💡 This rule is manually fixable by [editor suggestions](https://eslint.org/docs/latest/use/core-concepts#rule-suggestions).
 
@@ -26,9 +26,9 @@ A `FIXME:` or `TODO:` comment that starts with a valid ticket is treated by wher
   leftover marker and is reported, since `// FIXME: TRADE-12` above a test usually means the test was
   fixed and the marker forgotten. Move a work comment into the test body, or onto the line of code it
   is about.
-- Above a Jest or Vitest test that is not a todo, a `TODO:` comment is a tracked work comment about
+- Above a test that is not a todo, in every framework but Playwright, a `TODO:` comment is a tracked work comment about
   the test and is allowed. `TODO` is the everyday keyword for such comments, so there it is far more
-  often a note than the forgotten marker of a `test.todo`.
+  often a note than the forgotten marker of a todo test.
 
 Other markers that read as a sentence, such as `// SKIP: this one is flaky`, are left alone too: the rule
 counts a comment as prose when its first word is not a valid ticket and more text follows.

package/docs/rules/require-ticket-in-comments.md

@@ -2,7 +2,7 @@
 
 📝 Require FIXME and TODO comments in test files to start with a ticket.
 
-💼 This rule is enabled in the following [configs](https://github.com/Huldoser/eslint-plugin-test-governance#usage): 🃏 `jest`, 🎭 `playwright`, ⚡ `vitest`.
+💼 This rule is enabled in the following [configs](https://github.com/Huldoser/eslint-plugin-test-governance#usage): 🌲 `cypress`, 🃏 `jest`, ☕ `mocha`, 🟢 `node-test`, 🎭 `playwright`, ⚡ `vitest`, 🤖 `webdriverio`.
 
 💡 This rule is manually fixable by [editor suggestions](https://eslint.org/docs/latest/use/core-concepts#rule-suggestions).
 
@@ -30,9 +30,10 @@ How comments are read:
   style many teams already use. Anything after the parentheses is a note, as it would be after `TODO: TRADE-512`.
 - The tickets follow the same rules as markers: the shared ticket format, placeholders such as `TBD`
   rejected, and no text after the tickets unless `allowNotes` is set.
-- A `// FIXME:` marker directly above a `test.fixme(...)`, or a `// TODO:` marker above a Jest or
-  Vitest `test.todo(...)`, is checked by [`require-ticket`](require-ticket.md) instead, so it is
-  reported once.
+- A `// FIXME:` marker directly above a `test.fixme(...)`, or a `// TODO:` marker above a todo test,
+  such as Jest's `test.todo(...)` or Mocha's `it('title')`, is checked by [`require-ticket`](require-ticket.md) instead, so it is
+  reported once. That includes one in the wrong case, `// fixme:` or `// Todo:`, which `require-ticket` asks to write in
+  uppercase.
 - Only test files (a test framework import or a call to a test function) are checked.
   Application code is left alone, even if your config applies the plugin to it.
 

package/docs/rules/require-ticket.md

@@ -2,7 +2,7 @@
 
 📝 Require a ticket marker comment above skipped, fixme and tagged tests.
 
-💼 This rule is enabled in the following [configs](https://github.com/Huldoser/eslint-plugin-test-governance#usage): 🃏 `jest`, 🎭 `playwright`, ⚡ `vitest`.
+💼 This rule is enabled in the following [configs](https://github.com/Huldoser/eslint-plugin-test-governance#usage): 🌲 `cypress`, 🃏 `jest`, ☕ `mocha`, 🟢 `node-test`, 🎭 `playwright`, ⚡ `vitest`, 🤖 `webdriverio`.
 
 💡 This rule is manually fixable by [editor suggestions](https://eslint.org/docs/latest/use/core-concepts#rule-suggestions).
 
@@ -17,19 +17,23 @@ A test is in a state when it is:
 | -------------- | ------------------------------------------------------------------------------------------------------------------------------------- | ---------------------- | -------------------------- |
 | `skip`         | `test.skip('title', fn)`, `test.describe.skip`, `test.skip()` in a body, `testInfo.skip()`, `test.step.skip`, `step.skip()` in a step | `// SKIP:`             | yes                        |
 | `fixme`        | `test.fixme(...)`, `test.describe.fixme`, `testInfo.fixme()`                                                                          | `// FIXME:`            | yes                        |
-| `todo`         | Jest's and Vitest's `test.todo`                                                                                                       | `// TODO:`             | yes, in Jest and Vitest    |
+| `todo`         | Jest's, Vitest's and `node:test`'s `test.todo`, and a Mocha test with only a title, `it('title')`                                     | `// TODO:`             | yes, except in Playwright  |
 | `new`          | the `@new` tag                                                                                                                        | `// NEW:`              | with `lifecycleTags: true` |
 | `quarantined`  | the `@quarantined` tag                                                                                                                | `// QUARANTINED:`      | with `lifecycleTags: true` |
 | `fail`, `slow` | `test.fail(...)`, `test.slow()`, `testInfo.fail()`, `testInfo.slow()`                                                                 | `// FAIL:`, `// SLOW:` | no                         |
 | custom         | any tag you list in `customStates`                                                                                                    | your keyword           | when configured            |
 
 In Jest and Vitest, `xit`, `xdescribe`, Vitest's `{ skip: true }`, `skipIf(true)`, `context.skip()` and
-`context.skip('note')`, in a test or in `beforeEach`, skip a test too, and `test.failing` and `test.fails` put it in the `fail` state. The
+`context.skip('note')`, in a test or in `beforeEach`, skip a test too, and `test.failing` and `test.fails` put it in the `fail` state. In Mocha, Cypress and WebdriverIO, `xit`, `xdescribe` and
+`this.skip()` in a test or hook skip a test too, and Cypress's `{ browser: '!webkit' }` skips it in other
+browsers, which counts as a conditional skip. In `node:test`, `{ skip: 'reason' }`, `t.skip()` and `this.skip()` skip a test, `{ todo: true }`,
+`t.todo()` and `this.todo()` make it a todo, `t.test()` subtests count as tests, and `test.expectFailure` puts it in the `fail` state. The
 [README](../../README.md#frameworks) lists every form.
 
 Tags are read from the title (`'places a limit order @new'`) and from `{ tag: '@new' }` or `{ tag: ['@new', '@smoke'] }`,
 also when they come from a `const` or an enum declared in the same file, as in `{ tag: TAGS.NEW }`.
-Vitest writes tag names without the `@`, so `{ tags: ['new'] }` is the `@new` tag. Tags on a
+Vitest writes tag names without the `@`, so `{ tags: ['new'] }` is the `@new` tag. Cypress tags from
+@cypress/grep keep it: `{ tags: '@new' }`. Tags on a
 `describe` apply to every test inside it. `states` can rename the tag and marker of `new` and
 `quarantined`, as in `states: { quarantined: { tag: '@flaky', marker: 'FLAKY' } }`.
 
@@ -77,8 +81,10 @@ Conditional skips such as `test.skip(browserName === 'webkit', 'Not supported')`
 permanent platform limit, so they need no ticket unless you set `requireTicketForConditional: true`.
 A runtime skip under an `if`, a `switch` case, a ternary or `&&` counts as conditional too, since
 `if (!enabled) test.skip()` does the same as `test.skip(!enabled)`. So does a skip in a `catch` block,
-such as `catch { test.skip(true, 'Market data feed is down') }`, and a skip after an early exit such as
-`if (ready) return;` or `if (!ok) throw error;` earlier in the same function.
+such as `catch { test.skip(true, 'Market data feed is down') }`, a skip after other code in a `try`
+block that has a `catch`, as in `try { await stat(target); test.skip(); } catch {}`, where an error
+skips past it, and a skip after an early exit such as `if (ready) return;` or `if (!ok) throw error;`
+earlier in the same function.
 
 A test or describe whose function a condition picks is a conditional skip too, in every framework. Its
 title and tags count as usual, and a marker goes above it, or in code without semicolons above the
@@ -191,6 +197,28 @@ it.todo('caps position size at 2% of equity');
 test.skipIf(true)('fills a stop order when the market opens', () => {});
 ```
 
+<!-- example: invalid settings={"framework":"mocha"} -->
+
+```js
+it('settles a trade at T+1', function () {
+  this.skip();
+});
+```
+
+<!-- example: invalid settings={"framework":"node-test"} -->
+
+```js
+import { test } from 'node:test';
+
+test('liquidates below maintenance', { skip: 'broker sandbox is down' }, () => {});
+```
+
+<!-- example: invalid settings={"framework":"cypress","lifecycleTags":true} -->
+
+```js
+it('places a stop order', { tags: '@quarantined' }, () => {});
+```
+
 Correct:
 
 <!-- example: valid -->
@@ -245,6 +273,32 @@ describe('risk limits', () => {
 });
 ```
 
+<!-- example: valid settings={"framework":"mocha"} -->
+
+```js
+describe('settlement', function () {
+  // TODO: TRADE-91
+  it('settles a trade on a market holiday');
+
+  it('settles in the clearing house currency', function () {
+    if (!process.env.CLEARING_URL) this.skip();
+  });
+});
+```
+
+<!-- example: valid settings={"framework":"node-test"} -->
+
+```js
+import { test } from 'node:test';
+
+// SKIP: TRADE-92
+test('liquidates below maintenance', { skip: 'broker sandbox is down' }, () => {});
+
+test('nets margin across accounts', (t) => {
+  if (!process.env.RISK_URL) t.skip();
+});
+```
+
 ## Options
 
 This rule has no options of its own. It reads the shared options described in the

package/docs/upgrading.md

@@ -90,7 +90,7 @@ becomes `extends: ['test-governance/playwright']`.
 A config that still reads `configs.recommended` fails when it loads:
 
 ```text
-eslint-plugin-test-governance: configs.recommended was removed in 0.5.0. Use the config for your framework: configs.playwright, configs.jest or configs.vitest. See https://github.com/Huldoser/eslint-plugin-test-governance/blob/main/docs/upgrading.md
+eslint-plugin-test-governance: configs.recommended was removed in 0.5.0. Use the config for your framework: configs.playwright, configs.jest, configs.vitest, configs.mocha, configs.cypress, configs.webdriverio or configs['node-test']. See https://github.com/Huldoser/eslint-plugin-test-governance/blob/main/docs/upgrading.md
 ```
 
 ### The framework option
@@ -121,7 +121,7 @@ Without it, the config fails when it loads:
 
 ```text
 eslint-plugin-test-governance: invalid options:
-  - framework is required: set it to "playwright", "jest" or "vitest", or use configs.playwright, configs.jest or configs.vitest
+  - framework is required: set it to "playwright", "jest", "vitest", "mocha", "cypress", "webdriverio" or "node-test", or use configs.playwright, configs.jest, configs.vitest, configs.mocha, configs.cypress, configs.webdriverio or configs['node-test']
 ```
 
 If you write `settings['test-governance']` yourself instead of calling `configure()`, add `framework`

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "eslint-plugin-test-governance",
-  "version": "0.6.2",
-  "description": "ESLint rules that require a ticket comment above skipped, fixme, todo and tagged Playwright, Jest and Vitest tests.",
+  "version": "0.8.0",
+  "description": "ESLint rules that require a ticket comment above skipped, fixme, todo and tagged Playwright, Jest, Vitest, Mocha, Cypress, WebdriverIO and node:test tests.",
   "keywords": [
     "eslint",
     "eslintplugin",
@@ -9,6 +9,10 @@
     "playwright",
     "jest",
     "vitest",
+    "mocha",
+    "cypress",
+    "webdriverio",
+    "node-test",
     "testing"
   ],
   "homepage": "https://github.com/Huldoser/eslint-plugin-test-governance#readme",