eslint-plugin-test-governance 0.13.1 → 0.13.2

package/CHANGELOG.md

@@ -6,6 +6,31 @@ All notable changes to this project are documented here. The format follows
 
 ## [Unreleased]
 
+## [0.13.2] - 2026-11-08
+
+### Fixed
+
+- Local aliases such as `const check = it; check.skip(...)`, and aliases of conditional test functions,
+  are checked like the functions they keep.
+- A helper's parameter or block variable named like a test context no longer makes its `skip()` or
+  `test()` calls count as runtime skips or subtests.
+- Runtime calls with a literal `false` condition, such as Playwright's `test.skip(false)`, need neither
+  a ticket nor a reason.
+- Details, options and annotations use the last value of a property, including values from object
+  spreads. An unread spread or computed key no longer leaves an earlier value treated as certain.
+- A tag read beyond an array's bounds no longer crashes linting. An index after a spread, or a string
+  such as `'01'` that isn't an array index, is left unread instead of using the wrong tag.
+- Circular object spreads no longer overflow the stack during analysis.
+- Playwright annotation arrays read tickets from spreads of arrays declared in the same file, and
+  report unread spreads with `reportUnreadableTags`.
+- A ticket marker in a block comment no longer hides unrelated `TODO` or `FIXME` work comments on
+  other lines of that block.
+- The `pattern` preset matches the whole ticket even with the multiline flag, and no longer accepts
+  trailing line breaks outside the pattern.
+- Moving a ticket into an annotation preserves comments inside an empty details object.
+- node:test's `todo` state no longer makes `no-conflicting-states` call a new test skipped: Node still
+  runs its body.
+
 ## [0.13.1] - 2026-11-06
 
 ### Fixed
@@ -573,7 +598,8 @@ First release.
 - Support for ESLint 9 and 10 flat config, JavaScript and TypeScript test files, `.extend()`
   fixtures, describe blocks, runtime skips and tags in titles or the `tag` option.
 
-[Unreleased]: https://github.com/Huldoser/eslint-plugin-test-governance/compare/v0.13.1...HEAD
+[Unreleased]: https://github.com/Huldoser/eslint-plugin-test-governance/compare/v0.13.2...HEAD
+[0.13.2]: https://github.com/Huldoser/eslint-plugin-test-governance/compare/v0.13.1...v0.13.2
 [0.13.1]: https://github.com/Huldoser/eslint-plugin-test-governance/compare/v0.13.0...v0.13.1
 [0.13.0]: https://github.com/Huldoser/eslint-plugin-test-governance/compare/v0.12.1...v0.13.0
 [0.12.1]: https://github.com/Huldoser/eslint-plugin-test-governance/compare/v0.12.0...v0.12.1

package/dist/rules/require-ticket-in-comments.js

@@ -37,7 +37,7 @@ export default createRule({
             for (const marker of [...subject.markers, ...subject.regionMarkers]) {
                 const state = marker.state ?? marker.caseOf;
                 if (state && appliesTo(subject, state.name))
-                    owned.add(marker.comment);
+                    owned.add(marker.keywordStart);
             }
         }
         // `TODO`/`FIXME` in capitals counts with or without a colon. Other casings need the colon, so a
@@ -62,13 +62,13 @@ export default createRule({
             return { ...parsed, extra: { text: note, range: [start + close, start + line.trimEnd().length] } };
         }
         for (const comment of sourceCode.getAllComments()) {
-            if (owned.has(comment))
-                continue;
             for (const { text: line, start } of commentLines(comment)) {
                 const match = keywordRe.exec(line);
                 if (!match)
                     continue;
                 const [whole, indent, keyword] = match;
+                if (owned.has(start + indent.length))
+                    continue;
                 // The parenthesised group is optional, so it can be undefined despite RegExpExecArray's typing.
                 const inParens = match[3];
                 const upper = keyword.toUpperCase();

package/dist/utils/analyze.js

@@ -100,14 +100,16 @@ function disableRegions(comments, states) {
 /** The names a parameter gives to runtime info: `testInfo`, or `skip` in `({ skip }) => ...`. */
 function infoNames(param, methods, step) {
     if (param?.type === 'Identifier')
-        return [{ name: param.name, methods, step }];
+        return [{ name: param.name, binding: param, methods, step }];
     if (param?.type !== 'ObjectPattern')
         return [];
     return param.properties.flatMap((prop) => {
         if (prop.type !== 'Property' || prop.value.type !== 'Identifier')
             return [];
         const method = propertyName(prop);
-        return method !== undefined && methods.has(method) ? [{ name: prop.value.name, method, step }] : [];
+        return method !== undefined && methods.has(method)
+            ? [{ name: prop.value.name, binding: prop.value, method, step }]
+            : [];
     });
 }
 function memberName(node) {
@@ -630,10 +632,12 @@ function constantValue(sourceCode, node) {
         return propertyValue(owner, key);
     if (owner.type === 'ArrayExpression') {
         const index = Number(key);
-        if (!Number.isInteger(index))
+        if (!Number.isInteger(index) || index < 0 || String(index) !== key)
             return undefined;
-        const element = owner.elements[index];
-        return element !== null && element.type !== 'SpreadElement' ? element : undefined;
+        if (owner.elements.slice(0, index + 1).some((element) => element?.type === 'SpreadElement'))
+            return undefined;
+        const element = owner.elements.at(index);
+        return element !== undefined && element !== null && element.type !== 'SpreadElement' ? element : undefined;
     }
     if (owner.type !== 'TSEnumDeclaration')
         return undefined;
@@ -700,20 +704,35 @@ function detailKey(sourceCode, prop, unread) {
  * The plain-keyed properties of a details object, following spread objects declared in this file and
  * collecting the ones that can't be read.
  */
-function objectDetails(sourceCode, object, unread) {
-    return object.properties.flatMap((prop) => {
+function objectDetails(sourceCode, object, unread, path = []) {
+    if (path.includes(object)) {
+        unread.push(object);
+        return [];
+    }
+    const entries = new Map();
+    for (const prop of object.properties) {
         if (prop.type === 'SpreadElement') {
             const argument = unwrap(prop.argument);
             const value = argument.type === 'ObjectExpression' ? argument : constantValue(sourceCode, argument);
             const spread = value && unwrap(value);
-            if (spread?.type === 'ObjectExpression')
-                return objectDetails(sourceCode, spread, unread);
-            unread.push(prop.argument);
-            return [];
+            const before = unread.length;
+            const values = spread?.type === 'ObjectExpression' ? objectDetails(sourceCode, spread, unread, [...path, object]) : [];
+            if (spread?.type !== 'ObjectExpression')
+                unread.push(prop.argument);
+            // An unread spread may replace any earlier property; later known properties still win.
+            if (unread.length > before)
+                entries.clear();
+            for (const [key, value] of values)
+                entries.set(key, value);
+            continue;
         }
         const key = detailKey(sourceCode, prop, unread);
-        return key === undefined ? [] : [[key, prop.value]];
-    });
+        if (key === undefined)
+            entries.clear();
+        else
+            entries.set(key, prop.value);
+    }
+    return [...entries];
 }
 /**
  * The details or options object of a declaration, the second argument in
@@ -805,7 +824,7 @@ function collectAnnotations(sourceCode, details, source, annotations) {
         }
         tickets.push({ text, node: description[1] });
     };
-    const readValue = (value) => {
+    const readValue = (value, path = []) => {
         const carrier = annotationCarrier(sourceCode, value);
         if (carrier === 'unread') {
             unread.push(value);
@@ -813,6 +832,10 @@ function collectAnnotations(sourceCode, details, source, annotations) {
         }
         if (carrier === undefined)
             return;
+        if (path.includes(carrier)) {
+            unread.push(value);
+            return;
+        }
         if (source.shape === 'meta') {
             if (carrier.type === 'ObjectExpression') {
                 const unreadKeys = [];
@@ -834,8 +857,12 @@ function collectAnnotations(sourceCode, details, source, annotations) {
             readPlaywright(carrier);
         else {
             for (const element of carrier.elements) {
-                if (element === null || element.type === 'SpreadElement')
+                if (element === null)
+                    continue;
+                if (element.type === 'SpreadElement') {
+                    readValue(element.argument, [...path, carrier]);
                     continue;
+                }
                 const inner = annotationCarrier(sourceCode, element);
                 if (inner === 'unread')
                     unread.push(element);
@@ -1134,7 +1161,7 @@ function runAnalysis(sourceCode, options) {
      * `['describe', 'skip']` for `test.describe.skip` or `pw.test.describe.skip`. Undefined when the callee
      * isn't one of the framework's test functions.
      */
-    const target = (chain) => {
+    const target = (chain, seen = []) => {
         if (chain === undefined)
             return undefined;
         const { root, path, args } = chain;
@@ -1156,7 +1183,13 @@ function runAnalysis(sourceCode, options) {
             base = member;
             rest = path.slice(1);
         }
-        return base !== undefined && !isLocalVariable(sourceCode, root) ? { root: base, path: rest, args } : undefined;
+        if (base !== undefined && !isLocalVariable(sourceCode, root))
+            return { root: base, path: rest, args };
+        const value = declaredValue(sourceCode, root);
+        if (value === undefined || seen.includes(value))
+            return undefined;
+        const alias = target(chainOf(unwrap(value), framework.factories), [...seen, value]);
+        return alias && { root: alias.root, path: [...alias.path, ...path], args: new Map([...alias.args, ...args]) };
     };
     let usesTest = sourceCode.ast.body.some((statement) => statement.type === 'ImportDeclaration' && framework.ownsModule(statement.source.value));
     const subjects = [];
@@ -1179,6 +1212,13 @@ function runAnalysis(sourceCode, options) {
     }
     const stack = [];
     const infos = [];
+    const infoOf = (id) => {
+        const info = infos.findLast((entry) => entry.name === id.name);
+        return info?.binding !== undefined &&
+            declaredVariable(sourceCode, id) !== declaredVariable(sourceCode, info.binding)
+            ? undefined
+            : info;
+    };
     const keys = sourceCode.visitorKeys;
     /** States an options object can put a test in, such as `skip` for Vitest's `{ skip: true }`. */
     const optionModifiers = new Set(framework.optionEffects.values());
@@ -1284,7 +1324,7 @@ function runAnalysis(sourceCode, options) {
             for (const tag of parent.tags)
                 inheritedTags.add(tag.tag);
         }
-        const ownSkip = [...modifiers].some(([modifier, always]) => always && SKIPPING_MODIFIERS.has(modifier));
+        const ownSkip = [...modifiers].some(([modifier, always]) => always && SKIPPING_MODIFIERS.has(modifier) && !(modifier === 'todo' && framework.name === 'node-test'));
         const subject = {
             kind,
             node: call,
@@ -1482,7 +1522,7 @@ function runAnalysis(sourceCode, options) {
         if (!framework.subtests || callee.type !== 'MemberExpression' || memberName(callee) !== 'test')
             return undefined;
         const { object } = callee;
-        if (object.type !== 'Identifier' || !infos.findLast((info) => info.name === object.name)?.methods)
+        if (object.type !== 'Identifier' || !infoOf(object)?.methods)
             return undefined;
         const declaration = { kind: 'test', members: [], written: [], args: new Map() };
         return declares(declaration, call.arguments)
@@ -1497,8 +1537,16 @@ function runAnalysis(sourceCode, options) {
     const aliasValue = (callee) => {
         if (callee.type !== 'Identifier' || testNames.roots.has(callee.name))
             return undefined;
-        const value = declaredValue(sourceCode, callee);
-        return value && ALIAS_VALUES.has(unwrap(value).type) ? value : undefined;
+        const seen = new Set();
+        let value = declaredValue(sourceCode, callee);
+        while (value !== undefined && !seen.has(value)) {
+            seen.add(value);
+            const expression = unwrap(value);
+            if (expression.type !== 'Identifier')
+                return ALIAS_VALUES.has(expression.type) ? value : undefined;
+            value = declaredValue(sourceCode, expression);
+        }
+        return undefined;
     };
     /**
      * Whether the declaration of a constant that holds a test function says why above it or at the end of its
@@ -1573,14 +1621,12 @@ function runAnalysis(sourceCode, options) {
      */
     const runtimeCall = (call) => {
         const { callee } = call;
-        // The innermost parameter with a name is the one the call uses.
-        const innermost = (name) => infos.findLast((info) => info.name === name);
         /**
          * What a name stands for: a context in scope, or a local constant that keeps one of its methods, as
          * `const skip = testInfo.skip`, `const { skip } = t` or `const p = pending`.
          */
         const resolveInfo = (id) => {
-            const direct = innermost(id.name);
+            const direct = infoOf(id);
             if (direct !== undefined)
                 return direct;
             const definition = declaredVariable(sourceCode, id)?.defs.find((def) => def.type === 'Variable');
@@ -1599,12 +1645,12 @@ function runAnalysis(sourceCode, options) {
                             ? { name: id.name, method: name }
                             : undefined;
                     }
-                    const object = init.object.type === 'Identifier' ? innermost(init.object.name) : undefined;
+                    const object = init.object.type === 'Identifier' ? infoOf(init.object) : undefined;
                     return object?.methods?.has(name) ? { name: id.name, method: name, step: object.step } : undefined;
                 }
                 if (init.type !== 'Identifier')
                     return undefined;
-                const source = innermost(init.name);
+                const source = infoOf(init);
                 if (source === undefined)
                     return undefined;
                 const fn = source.runtimeFunction;
@@ -1616,7 +1662,7 @@ function runAnalysis(sourceCode, options) {
             }
             if (declarator.id.type !== 'ObjectPattern' || init.type !== 'Identifier')
                 return undefined;
-            const source = innermost(init.name);
+            const source = infoOf(init);
             if (source?.methods === undefined)
                 return undefined;
             const property = declarator.id.properties.find((prop) => prop.type === 'Property' && prop.value.type === 'Identifier' && prop.value.name === id.name);
@@ -1701,6 +1747,8 @@ function runAnalysis(sourceCode, options) {
     const runtimeSubject = (call, modifier, step, always = isUnconditional(call, framework)) => {
         if (!states.some((s) => s.modifier === modifier))
             return undefined;
+        if (framework.reasonArgument !== 'only' && booleanOf(call.arguments.at(0)) === false)
+            return undefined;
         const subject = makeSubject('runtime', call, new Map([[modifier, always]]), NO_TAGS, step ?? stack.findLast((s) => s.kind !== 'step'));
         const parent = subject.parent;
         if (parent) {

package/dist/utils/fix.js

@@ -91,6 +91,8 @@ export function moveToAnnotation(sourceCode, call, marker, source, type) {
     const last = details.properties.at(-1);
     return (fixer) => [
         remove,
-        last === undefined ? fixer.replaceText(details, `{ ${property} }`) : fixer.insertTextAfter(last, `, ${property}`),
+        last === undefined
+            ? fixer.insertTextBeforeRange([details.range[1] - 1, details.range[1]], ` ${property} `)
+            : fixer.insertTextAfter(last, `, ${property}`),
     ];
 }

package/dist/utils/tickets.js

@@ -139,7 +139,7 @@ export function ticketPattern(pattern, flags) {
     const kept = flags?.replace(/[gy]/g, '');
     // Compiled alone first: a stray `)` in it would otherwise close the anchoring group and match anything.
     new RegExp(pattern, kept);
-    return new RegExp(`^(?:${pattern})$`, kept);
+    return new RegExp(`(?<![\\s\\S])(?:${pattern})(?![\\s\\S])`, kept);
 }
 function compilePreset(spec) {
     switch (spec.preset) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-test-governance",
-  "version": "0.13.1",
+  "version": "0.13.2",
   "description": "ESLint rules that require a ticket for skipped, fixme, todo, retried, tagged and commented-out Playwright, Jest, Vitest, Mocha, Cypress, WebdriverIO, node:test and Jasmine tests.",
   "keywords": [
     "eslint",