@opensip-cli/checks-universal 0.1.0

package/dist/checks/testing/index.js

@@ -0,0 +1,6 @@
+export * from './no-skipped-tests.js';
+export * from './no-stub-tests.js';
+export * from './test-convention-consistency.js';
+export * from './test-file-naming.js';
+export * from './test-file-pairing.js';
+//# sourceMappingURL=index.js.map

package/dist/checks/testing/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/checks/testing/index.ts"],"names":[],"mappings":"AAAA,cAAc,uBAAuB,CAAC;AACtC,cAAc,oBAAoB,CAAC;AACnC,cAAc,kCAAkC,CAAC;AACjD,cAAc,uBAAuB,CAAC;AACtC,cAAc,wBAAwB,CAAC"}

package/dist/checks/testing/no-skipped-tests.d.ts

@@ -0,0 +1,40 @@
+/**
+ * @fileoverview Cross-language skipped / focused / placeholder test detection.
+ *
+ * Detects disabled (`.skip`, `@Disabled`, `#[ignore]`, `t.Skip`),
+ * focused (`.only`, `fit(`, `fdescribe(`), and placeholder (`it.todo`)
+ * tests across JS/TS, Python, Go, Rust, and Java test files. Disabled or
+ * abandoned test work silently erodes coverage; a `.only` is the most
+ * dangerous of all because it silences every OTHER test in the suite.
+ *
+ * INVERSION: unlike most checks (which skip test files), this check ONLY
+ * applies to test files — `if (!isTestFile(filePath)) return []`.
+ *
+ * Uses the `strip-strings-and-comments` content filter so the idioms are
+ * matched as live CODE only, never as text inside a description string
+ * (`it('should skip empty input', ...)`) or a comment (`fit (checks/recipes)`
+ * in prose, or a commented-out `// it.skip(...)`). Both classes would
+ * otherwise false-fire — comments especially for `fit(` / `xit(`, which are
+ * also ordinary English words.
+ *
+ * Supersedes the former TS-only `no-focused-tests` check (its `.only` / `fit(`
+ * / `fdescribe(` detection is folded in here); the slug and id are retained
+ * so the dogfood baseline stays continuous.
+ */
+import { type CheckViolation } from '@opensip-cli/fitness';
+/**
+ * Pure analysis function. Exported so unit tests can exercise the detection
+ * logic without standing up the full Check framework. `content` is expected
+ * to be the `strip-strings`-filtered source so that idiom-like words inside
+ * description string literals don't false-fire; `filePath` selects the
+ * language idiom set (the caller is responsible for the `isTestFile` gate).
+ */
+export declare function analyzeSkippedTests(content: string, filePath: string): CheckViolation[];
+/**
+ * Check: testing/no-skipped-tests
+ *
+ * Detects skipped, focused, or placeholder tests across JS/TS, Python, Go,
+ * Rust, and Java. Test-files-only (the inverse of most checks).
+ */
+export declare const noSkippedTests: import("@opensip-cli/fitness").Check;
+//# sourceMappingURL=no-skipped-tests.d.ts.map

package/dist/checks/testing/no-skipped-tests.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"no-skipped-tests.d.ts","sourceRoot":"","sources":["../../../src/checks/testing/no-skipped-tests.ts"],"names":[],"mappings":"AACA;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,OAAO,EAA2B,KAAK,cAAc,EAAE,MAAM,sBAAsB,CAAC;AAoGpF;;;;;;GAMG;AACH,wBAAgB,mBAAmB,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,cAAc,EAAE,CAwBvF;AAED;;;;;GAKG;AACH,eAAO,MAAM,cAAc,sCA8BzB,CAAC"}

package/dist/checks/testing/no-skipped-tests.js

@@ -0,0 +1,174 @@
+// @fitness-ignore-file no-skipped-tests -- this file's job is to detect skip/focus idioms; the patterns appear in regex and JSDoc by design
+/**
+ * @fileoverview Cross-language skipped / focused / placeholder test detection.
+ *
+ * Detects disabled (`.skip`, `@Disabled`, `#[ignore]`, `t.Skip`),
+ * focused (`.only`, `fit(`, `fdescribe(`), and placeholder (`it.todo`)
+ * tests across JS/TS, Python, Go, Rust, and Java test files. Disabled or
+ * abandoned test work silently erodes coverage; a `.only` is the most
+ * dangerous of all because it silences every OTHER test in the suite.
+ *
+ * INVERSION: unlike most checks (which skip test files), this check ONLY
+ * applies to test files — `if (!isTestFile(filePath)) return []`.
+ *
+ * Uses the `strip-strings-and-comments` content filter so the idioms are
+ * matched as live CODE only, never as text inside a description string
+ * (`it('should skip empty input', ...)`) or a comment (`fit (checks/recipes)`
+ * in prose, or a commented-out `// it.skip(...)`). Both classes would
+ * otherwise false-fire — comments especially for `fit(` / `xit(`, which are
+ * also ordinary English words.
+ *
+ * Supersedes the former TS-only `no-focused-tests` check (its `.only` / `fit(`
+ * / `fdescribe(` detection is folded in here); the slug and id are retained
+ * so the dogfood baseline stays continuous.
+ */
+import { defineCheck, isTestFile } from '@opensip-cli/fitness';
+const SUGGESTION = 'Re-enable the test or remove it; track the reason in an issue. ' +
+    '`.only` must never ship — it silences the rest of the suite.';
+const FOCUSED_SUGGESTION = 'A focused test disables EVERY OTHER test in the file. Remove the focus ' +
+    '(`.only` / `fit(` / `fdescribe(`) before committing — it must never ship.';
+// JS/TS — vitest / jest / mocha / playwright. Method-call forms (`.skip(`,
+// `.only(`, `.todo(`, `.concurrent.skip(`) plus the word-boundary call forms
+// (`xit(`, `fit(`, ...).
+const JS_IDIOMS = [
+    {
+        pattern: /\b(?:it|test|describe|context|suite|bench)(?:\.concurrent)?\.only\b/g,
+        label: '.only focused test',
+        focused: true,
+    },
+    {
+        pattern: /\b(?:it|test|describe|context|suite|bench)(?:\.concurrent)?\.skip\b/g,
+        label: '.skip skipped test',
+        focused: false,
+    },
+    { pattern: /\b(?:it|test)\.todo\b/g, label: '.todo placeholder test', focused: false },
+    { pattern: /\bfit\s*\(/g, label: 'fit() focused test', focused: true },
+    { pattern: /\bfdescribe\s*\(/g, label: 'fdescribe() focused suite', focused: true },
+    { pattern: /\bxit\s*\(/g, label: 'xit() skipped test', focused: false },
+    { pattern: /\bxtest\s*\(/g, label: 'xtest() skipped test', focused: false },
+    { pattern: /\bxdescribe\s*\(/g, label: 'xdescribe() skipped suite', focused: false },
+];
+// Python — pytest / unittest.
+const PY_IDIOMS = [
+    { pattern: /@pytest\.mark\.skipif\b/g, label: '@pytest.mark.skipif', focused: false },
+    { pattern: /@pytest\.mark\.skip\b/g, label: '@pytest.mark.skip', focused: false },
+    { pattern: /@unittest\.expectedFailure\b/g, label: '@unittest.expectedFailure', focused: false },
+    { pattern: /@unittest\.skip\b/g, label: '@unittest.skip', focused: false },
+    { pattern: /\bself\.skipTest\s*\(/g, label: 'self.skipTest()', focused: false },
+    { pattern: /\bpytest\.skip\s*\(/g, label: 'pytest.skip()', focused: false },
+];
+// Go — testing.T skip APIs.
+const GO_IDIOMS = [
+    { pattern: /\bt\.SkipNow\s*\(/g, label: 't.SkipNow()', focused: false },
+    { pattern: /\bt\.Skipf\s*\(/g, label: 't.Skipf()', focused: false },
+    { pattern: /\bt\.Skip\s*\(/g, label: 't.Skip()', focused: false },
+];
+// Rust — the #[ignore] test attribute.
+const RUST_IDIOMS = [
+    { pattern: /#\[\s*ignore\b/g, label: '#[ignore] test attribute', focused: false },
+];
+// Java — JUnit 5 (@Disabled) / JUnit 4 (@Ignore).
+const JAVA_IDIOMS = [
+    { pattern: /@Disabled\b/g, label: '@Disabled', focused: false },
+    { pattern: /@Ignore\b/g, label: '@Ignore', focused: false },
+];
+/** Map a file extension (no leading dot) to its idiom set. */
+function idiomsForExtension(filePath) {
+    const ext = filePath.slice(filePath.lastIndexOf('.') + 1).toLowerCase();
+    switch (ext) {
+        case 'ts':
+        case 'tsx':
+        case 'js':
+        case 'jsx':
+        case 'mjs':
+        case 'cjs': {
+            return JS_IDIOMS;
+        }
+        case 'py': {
+            return PY_IDIOMS;
+        }
+        case 'go': {
+            return GO_IDIOMS;
+        }
+        case 'rs': {
+            return RUST_IDIOMS;
+        }
+        case 'java': {
+            return JAVA_IDIOMS;
+        }
+        default: {
+            return [];
+        }
+    }
+}
+/**
+ * Pure analysis function. Exported so unit tests can exercise the detection
+ * logic without standing up the full Check framework. `content` is expected
+ * to be the `strip-strings`-filtered source so that idiom-like words inside
+ * description string literals don't false-fire; `filePath` selects the
+ * language idiom set (the caller is responsible for the `isTestFile` gate).
+ */
+export function analyzeSkippedTests(content, filePath) {
+    const idioms = idiomsForExtension(filePath);
+    if (idioms.length === 0)
+        return [];
+    const violations = [];
+    const lines = content.split('\n');
+    for (const [i, line] of lines.entries()) {
+        for (const idiom of idioms) {
+            idiom.pattern.lastIndex = 0;
+            if (idiom.pattern.test(line)) {
+                violations.push({
+                    message: idiom.focused
+                        ? `Focused test detected (${idiom.label}) — it disables every other test in the file`
+                        : `Skipped/placeholder test detected (${idiom.label})`,
+                    // Soft shipped default; repos wanting a hard gate set `failOnWarnings`
+                    // (this repo does — see opensip-cli.config.yml).
+                    severity: 'warning',
+                    line: i + 1,
+                    suggestion: idiom.focused ? FOCUSED_SUGGESTION : SUGGESTION,
+                });
+            }
+        }
+    }
+    return violations;
+}
+/**
+ * Check: testing/no-skipped-tests
+ *
+ * Detects skipped, focused, or placeholder tests across JS/TS, Python, Go,
+ * Rust, and Java. Test-files-only (the inverse of most checks).
+ */
+export const noSkippedTests = defineCheck({
+    id: '6d58546e-7335-42da-94f3-abb015e3a4c0',
+    slug: 'no-skipped-tests',
+    scope: { languages: [], concerns: ['testing'] },
+    description: 'Tests must never ship skipped, focused (.only), or placeholder',
+    longDescription: `**Purpose:** Surfaces disabled, focused, and placeholder tests so they are re-enabled or removed rather than left to silently erode coverage. A committed \`.only\` is the most dangerous case — it silences every other test in the file and gives a false green CI signal.
+
+**Detects (test files only, by extension):**
+- **JS/TS** — \`.only\` / \`.skip\` / \`.todo\` (incl. \`.concurrent.*\`) on \`it\`/\`test\`/\`describe\`/\`context\`/\`suite\`/\`bench\`, plus \`fit(\`, \`fdescribe(\`, \`xit(\`, \`xtest(\`, \`xdescribe(\`
+- **Python** — \`@pytest.mark.skip\`/\`skipif\`, \`@unittest.skip\`/\`expectedFailure\`, \`self.skipTest(\`, \`pytest.skip(\`
+- **Go** — \`t.Skip(\`, \`t.Skipf(\`, \`t.SkipNow(\`
+- **Rust** — the \`#[ignore]\` test attribute
+- **Java** — \`@Disabled\` (JUnit 5), \`@Ignore\` (JUnit 4)
+
+**Why it matters:** Skipped tests accumulate as dead code and silently reduce effective coverage; focused tests cause CI to run only the focused test while the rest of the suite is silently skipped.
+
+**Scope:** Cross-language best practice. Uses the \`strip-strings-and-comments\` filter so idiom-like words inside description strings (e.g. \`it('should skip empty input')\`) and comments (e.g. \`fit(\` in prose, or a commented-out \`// it.skip(...)\`) do not false-fire. Targets test files only.`,
+    tags: ['quality', 'testing', 'ci-blocking'],
+    fileTypes: ['ts', 'tsx', 'js', 'jsx', 'mjs', 'cjs', 'py', 'go', 'java', 'rs'],
+    // Match the skip idioms as live CODE only — never inside a description
+    // string (`it('should skip empty input', ...)`) or a comment (`fit(` / `xit(`
+    // are ordinary English words that recur in prose and commented-out tests).
+    contentFilter: 'strip-strings-and-comments',
+    confidence: 'high',
+    analyze: (content, filePath) => {
+        // INVERSION: this hygiene rule applies ONLY to test files. A skip idiom
+        // in production code is not this check's concern.
+        if (!isTestFile(filePath))
+            return [];
+        return analyzeSkippedTests(content, filePath);
+    },
+});
+//# sourceMappingURL=no-skipped-tests.js.map

package/dist/checks/testing/no-skipped-tests.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"no-skipped-tests.js","sourceRoot":"","sources":["../../../src/checks/testing/no-skipped-tests.ts"],"names":[],"mappings":"AAAA,4IAA4I;AAC5I;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,OAAO,EAAE,WAAW,EAAE,UAAU,EAAuB,MAAM,sBAAsB,CAAC;AAYpF,MAAM,UAAU,GACd,iEAAiE;IACjE,8DAA8D,CAAC;AAEjE,MAAM,kBAAkB,GACtB,yEAAyE;IACzE,2EAA2E,CAAC;AAE9E,2EAA2E;AAC3E,6EAA6E;AAC7E,yBAAyB;AACzB,MAAM,SAAS,GAAyB;IACtC;QACE,OAAO,EAAE,sEAAsE;QAC/E,KAAK,EAAE,oBAAoB;QAC3B,OAAO,EAAE,IAAI;KACd;IACD;QACE,OAAO,EAAE,sEAAsE;QAC/E,KAAK,EAAE,oBAAoB;QAC3B,OAAO,EAAE,KAAK;KACf;IACD,EAAE,OAAO,EAAE,wBAAwB,EAAE,KAAK,EAAE,wBAAwB,EAAE,OAAO,EAAE,KAAK,EAAE;IACtF,EAAE,OAAO,EAAE,aAAa,EAAE,KAAK,EAAE,oBAAoB,EAAE,OAAO,EAAE,IAAI,EAAE;IACtE,EAAE,OAAO,EAAE,mBAAmB,EAAE,KAAK,EAAE,2BAA2B,EAAE,OAAO,EAAE,IAAI,EAAE;IACnF,EAAE,OAAO,EAAE,aAAa,EAAE,KAAK,EAAE,oBAAoB,EAAE,OAAO,EAAE,KAAK,EAAE;IACvE,EAAE,OAAO,EAAE,eAAe,EAAE,KAAK,EAAE,sBAAsB,EAAE,OAAO,EAAE,KAAK,EAAE;IAC3E,EAAE,OAAO,EAAE,mBAAmB,EAAE,KAAK,EAAE,2BAA2B,EAAE,OAAO,EAAE,KAAK,EAAE;CACrF,CAAC;AAEF,8BAA8B;AAC9B,MAAM,SAAS,GAAyB;IACtC,EAAE,OAAO,EAAE,0BAA0B,EAAE,KAAK,EAAE,qBAAqB,EAAE,OAAO,EAAE,KAAK,EAAE;IACrF,EAAE,OAAO,EAAE,wBAAwB,EAAE,KAAK,EAAE,mBAAmB,EAAE,OAAO,EAAE,KAAK,EAAE;IACjF,EAAE,OAAO,EAAE,+BAA+B,EAAE,KAAK,EAAE,2BAA2B,EAAE,OAAO,EAAE,KAAK,EAAE;IAChG,EAAE,OAAO,EAAE,oBAAoB,EAAE,KAAK,EAAE,gBAAgB,EAAE,OAAO,EAAE,KAAK,EAAE;IAC1E,EAAE,OAAO,EAAE,wBAAwB,EAAE,KAAK,EAAE,iBAAiB,EAAE,OAAO,EAAE,KAAK,EAAE;IAC/E,EAAE,OAAO,EAAE,sBAAsB,EAAE,KAAK,EAAE,eAAe,EAAE,OAAO,EAAE,KAAK,EAAE;CAC5E,CAAC;AAEF,4BAA4B;AAC5B,MAAM,SAAS,GAAyB;IACtC,EAAE,OAAO,EAAE,oBAAoB,EAAE,KAAK,EAAE,aAAa,EAAE,OAAO,EAAE,KAAK,EAAE;IACvE,EAAE,OAAO,EAAE,kBAAkB,EAAE,KAAK,EAAE,WAAW,EAAE,OAAO,EAAE,KAAK,EAAE;IACnE,EAAE,OAAO,EAAE,iBAAiB,EAAE,KAAK,EAAE,UAAU,EAAE,OAAO,EAAE,KAAK,EAAE;CAClE,CAAC;AAEF,uCAAuC;AACvC,MAAM,WAAW,GAAyB;IACxC,EAAE,OAAO,EAAE,iBAAiB,EAAE,KAAK,EAAE,0BAA0B,EAAE,OAAO,EAAE,KAAK,EAAE;CAClF,CAAC;AAEF,kDAAkD;AAClD,MAAM,WAAW,GAAyB;IACxC,EAAE,OAAO,EAAE,cAAc,EAAE,KAAK,EAAE,WAAW,EAAE,OAAO,EAAE,KAAK,EAAE;IAC/D,EAAE,OAAO,EAAE,YAAY,EAAE,KAAK,EAAE,SAAS,EAAE,OAAO,EAAE,KAAK,EAAE;CAC5D,CAAC;AAEF,8DAA8D;AAC9D,SAAS,kBAAkB,CAAC,QAAgB;IAC1C,MAAM,GAAG,GAAG,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,WAAW,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC;IACxE,QAAQ,GAAG,EAAE,CAAC;QACZ,KAAK,IAAI,CAAC;QACV,KAAK,KAAK,CAAC;QACX,KAAK,IAAI,CAAC;QACV,KAAK,KAAK,CAAC;QACX,KAAK,KAAK,CAAC;QACX,KAAK,KAAK,CAAC,CAAC,CAAC;YACX,OAAO,SAAS,CAAC;QACnB,CAAC;QACD,KAAK,IAAI,CAAC,CAAC,CAAC;YACV,OAAO,SAAS,CAAC;QACnB,CAAC;QACD,KAAK,IAAI,CAAC,CAAC,CAAC;YACV,OAAO,SAAS,CAAC;QACnB,CAAC;QACD,KAAK,IAAI,CAAC,CAAC,CAAC;YACV,OAAO,WAAW,CAAC;QACrB,CAAC;QACD,KAAK,MAAM,CAAC,CAAC,CAAC;YACZ,OAAO,WAAW,CAAC;QACrB,CAAC;QACD,OAAO,CAAC,CAAC,CAAC;YACR,OAAO,EAAE,CAAC;QACZ,CAAC;IACH,CAAC;AACH,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,mBAAmB,CAAC,OAAe,EAAE,QAAgB;IACnE,MAAM,MAAM,GAAG,kBAAkB,CAAC,QAAQ,CAAC,CAAC;IAC5C,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,EAAE,CAAC;IAEnC,MAAM,UAAU,GAAqB,EAAE,CAAC;IACxC,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IAClC,KAAK,MAAM,CAAC,CAAC,EAAE,IAAI,CAAC,IAAI,KAAK,CAAC,OAAO,EAAE,EAAE,CAAC;QACxC,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;YAC3B,KAAK,CAAC,OAAO,CAAC,SAAS,GAAG,CAAC,CAAC;YAC5B,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;gBAC7B,UAAU,CAAC,IAAI,CAAC;oBACd,OAAO,EAAE,KAAK,CAAC,OAAO;wBACpB,CAAC,CAAC,0BAA0B,KAAK,CAAC,KAAK,8CAA8C;wBACrF,CAAC,CAAC,sCAAsC,KAAK,CAAC,KAAK,GAAG;oBACxD,uEAAuE;oBACvE,iDAAiD;oBACjD,QAAQ,EAAE,SAAS;oBACnB,IAAI,EAAE,CAAC,GAAG,CAAC;oBACX,UAAU,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,kBAAkB,CAAC,CAAC,CAAC,UAAU;iBAC5D,CAAC,CAAC;YACL,CAAC;QACH,CAAC;IACH,CAAC;IACD,OAAO,UAAU,CAAC;AACpB,CAAC;AAED;;;;;GAKG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,WAAW,CAAC;IACxC,EAAE,EAAE,sCAAsC;IAC1C,IAAI,EAAE,kBAAkB;IACxB,KAAK,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE,QAAQ,EAAE,CAAC,SAAS,CAAC,EAAE;IAC/C,WAAW,EAAE,gEAAgE;IAC7E,eAAe,EAAE;;;;;;;;;;;0SAWuR;IACxS,IAAI,EAAE,CAAC,SAAS,EAAE,SAAS,EAAE,aAAa,CAAC;IAC3C,SAAS,EAAE,CAAC,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC;IAC7E,uEAAuE;IACvE,8EAA8E;IAC9E,2EAA2E;IAC3E,aAAa,EAAE,4BAA4B;IAC3C,UAAU,EAAE,MAAM;IAClB,OAAO,EAAE,CAAC,OAAO,EAAE,QAAQ,EAAE,EAAE;QAC7B,wEAAwE;QACxE,kDAAkD;QAClD,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC;YAAE,OAAO,EAAE,CAAC;QACrC,OAAO,mBAAmB,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;IAChD,CAAC;CACF,CAAC,CAAC"}

package/dist/checks/testing/no-stub-tests.d.ts

@@ -0,0 +1,11 @@
+/**
+ * @fileoverview No stub tests check
+ */
+/**
+ * Check: testing/no-stub-tests
+ *
+ * Detects stub tests with empty bodies, TODO-only bodies,
+ * or trivial always-passing assertions that inflate coverage metrics.
+ */
+export declare const noStubTests: import("@opensip-cli/fitness").Check;
+//# sourceMappingURL=no-stub-tests.d.ts.map

package/dist/checks/testing/no-stub-tests.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"no-stub-tests.d.ts","sourceRoot":"","sources":["../../../src/checks/testing/no-stub-tests.ts"],"names":[],"mappings":"AAGA;;GAEG;AAmFH;;;;;GAKG;AACH,eAAO,MAAM,WAAW,sCAsBtB,CAAC"}

package/dist/checks/testing/no-stub-tests.js

@@ -0,0 +1,103 @@
+/* eslint-disable sonarjs/fixme-tag -- this file detects TODO/FIXME markers in test bodies; the words appear in directives, JSDoc, and regex literals by design */
+// @fitness-ignore-file no-stub-tests -- longDescription contains backtick-escaped stub test examples for documentation
+// @fitness-ignore-file no-todo-comments -- this file detects TODO/FIXME markers in test bodies; the words appear in regex and JSDoc by design
+/**
+ * @fileoverview No stub tests check
+ */
+import { defineCheck } from '@opensip-cli/fitness';
+/**
+ * Patterns for empty test bodies on a single line
+ */
+const EMPTY_BODY_PATTERNS = [
+    // it('...', () => {}) or it('...', () => { })
+    /(?:it|test)\s*\(\s*['"`].*['"`]\s*,\s*(?:async\s*)?\(\)\s*=>\s*\{\s*\}\s*\)/,
+    // it('...', function() {}) or it('...', function() { })
+    /(?:it|test)\s*\(\s*['"`].*['"`]\s*,\s*(?:async\s*)?function\s*\(\)\s*\{\s*\}\s*\)/,
+];
+/**
+ * Pattern for TODO/FIXME comments inside test bodies on same line
+ */
+const TODO_IN_TEST_BODY = /(?:it|test)\s*\(\s*['"`].*['"`]\s*,\s*(?:async\s*)?\(\)\s*=>\s*\{\s*\/[/*]\s*(?:TODO|FIXME|HACK|STUB)/i;
+/**
+ * Pattern for trivial always-passing assertions
+ */
+const TRIVIAL_ASSERTION = /expect\s*\(\s*true\s*\)\s*\.toBe\s*\(\s*true\s*\)/;
+/**
+ * Analyze a test file for stub tests
+ */
+function analyzeTestFile(content, _filePath) {
+    const violations = [];
+    const lines = content.split('\n');
+    for (const [i, line_] of lines.entries()) {
+        const line = line_ ?? '';
+        const trimmed = line.trim();
+        // Skip actual comments (not inside test bodies)
+        if (trimmed.startsWith('//') || trimmed.startsWith('*'))
+            continue;
+        // Check for empty test bodies
+        for (const pattern of EMPTY_BODY_PATTERNS) {
+            if (pattern.test(line)) {
+                violations.push({
+                    line: i + 1,
+                    message: 'Empty test body — this test always passes without asserting anything',
+                    severity: 'error',
+                    suggestion: 'Add meaningful assertions or use `it.todo()` if the test is planned but not yet implemented',
+                    type: 'empty-test-body',
+                    match: trimmed.slice(0, 120),
+                });
+                break;
+            }
+        }
+        // Check for TODO comments inside test bodies
+        if (TODO_IN_TEST_BODY.test(line)) {
+            violations.push({
+                line: i + 1,
+                message: 'Test body contains only a TODO comment — this is a stub that inflates coverage',
+                severity: 'error',
+                suggestion: 'Implement the test or convert to `it.todo()` to track as unimplemented',
+                type: 'todo-stub-test',
+                match: trimmed.slice(0, 120),
+            });
+        }
+        // Check for trivial always-passing assertions
+        if (TRIVIAL_ASSERTION.test(line)) {
+            violations.push({
+                line: i + 1,
+                message: 'Trivial `expect(true).toBe(true)` assertion — this test always passes',
+                severity: 'warning',
+                suggestion: 'Replace with a meaningful assertion that validates actual behavior',
+                type: 'trivial-assertion',
+                match: trimmed.slice(0, 120),
+            });
+        }
+    }
+    return violations;
+}
+/**
+ * Check: testing/no-stub-tests
+ *
+ * Detects stub tests with empty bodies, TODO-only bodies,
+ * or trivial always-passing assertions that inflate coverage metrics.
+ */
+export const noStubTests = defineCheck({
+    id: 'fc8032e4-9fcf-4a1f-bc00-e080e58ae1c5',
+    slug: 'no-stub-tests',
+    scope: { languages: ['typescript', 'tsx'], concerns: ['testing'] },
+    contentFilter: 'strip-strings',
+    confidence: 'medium',
+    description: 'Detects stub tests with empty bodies, TODO-only bodies, or trivial always-passing assertions',
+    longDescription: `**Purpose:** Detects tests that exist but don't actually test anything, inflating coverage metrics and masking gaps.
+
+**Detects:**
+- Empty test bodies: \`it('should X', () => {})\`
+- TODO-only test bodies: \`it('should X', () => { /* TODO */ })\`
+- Trivial assertions: \`expect(true).toBe(true)\`
+
+**Why it matters:** Stub tests give false confidence in test coverage. They pass without asserting anything, hiding missing test coverage.
+
+**Scope:** Test files only. Analyzes each file individually via regex.`,
+    tags: ['testing', 'quality', 'coverage'],
+    fileTypes: ['ts', 'tsx'],
+    analyze: analyzeTestFile,
+});
+//# sourceMappingURL=no-stub-tests.js.map

package/dist/checks/testing/no-stub-tests.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"no-stub-tests.js","sourceRoot":"","sources":["../../../src/checks/testing/no-stub-tests.ts"],"names":[],"mappings":"AAAA,kKAAkK;AAClK,uHAAuH;AACvH,8IAA8I;AAC9I;;GAEG;AAEH,OAAO,EAAE,WAAW,EAAuB,MAAM,sBAAsB,CAAC;AAExE;;GAEG;AACH,MAAM,mBAAmB,GAAG;IAC1B,8CAA8C;IAC9C,6EAA6E;IAC7E,wDAAwD;IACxD,mFAAmF;CACpF,CAAC;AAEF;;GAEG;AACH,MAAM,iBAAiB,GACrB,wGAAwG,CAAC;AAE3G;;GAEG;AACH,MAAM,iBAAiB,GAAG,mDAAmD,CAAC;AAE9E;;GAEG;AACH,SAAS,eAAe,CAAC,OAAe,EAAE,SAAiB;IACzD,MAAM,UAAU,GAAqB,EAAE,CAAC;IACxC,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IAElC,KAAK,MAAM,CAAC,CAAC,EAAE,KAAK,CAAC,IAAI,KAAK,CAAC,OAAO,EAAE,EAAE,CAAC;QACzC,MAAM,IAAI,GAAG,KAAK,IAAI,EAAE,CAAC;QACzB,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC;QAE5B,gDAAgD;QAChD,IAAI,OAAO,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,OAAO,CAAC,UAAU,CAAC,GAAG,CAAC;YAAE,SAAS;QAElE,8BAA8B;QAC9B,KAAK,MAAM,OAAO,IAAI,mBAAmB,EAAE,CAAC;YAC1C,IAAI,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;gBACvB,UAAU,CAAC,IAAI,CAAC;oBACd,IAAI,EAAE,CAAC,GAAG,CAAC;oBACX,OAAO,EAAE,sEAAsE;oBAC/E,QAAQ,EAAE,OAAO;oBACjB,UAAU,EACR,6FAA6F;oBAC/F,IAAI,EAAE,iBAAiB;oBACvB,KAAK,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,GAAG,CAAC;iBAC7B,CAAC,CAAC;gBACH,MAAM;YACR,CAAC;QACH,CAAC;QAED,6CAA6C;QAC7C,IAAI,iBAAiB,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;YACjC,UAAU,CAAC,IAAI,CAAC;gBACd,IAAI,EAAE,CAAC,GAAG,CAAC;gBACX,OAAO,EAAE,gFAAgF;gBACzF,QAAQ,EAAE,OAAO;gBACjB,UAAU,EAAE,wEAAwE;gBACpF,IAAI,EAAE,gBAAgB;gBACtB,KAAK,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,GAAG,CAAC;aAC7B,CAAC,CAAC;QACL,CAAC;QAED,8CAA8C;QAC9C,IAAI,iBAAiB,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;YACjC,UAAU,CAAC,IAAI,CAAC;gBACd,IAAI,EAAE,CAAC,GAAG,CAAC;gBACX,OAAO,EAAE,uEAAuE;gBAChF,QAAQ,EAAE,SAAS;gBACnB,UAAU,EAAE,oEAAoE;gBAChF,IAAI,EAAE,mBAAmB;gBACzB,KAAK,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,GAAG,CAAC;aAC7B,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IAED,OAAO,UAAU,CAAC;AACpB,CAAC;AAED;;;;;GAKG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG,WAAW,CAAC;IACrC,EAAE,EAAE,sCAAsC;IAC1C,IAAI,EAAE,eAAe;IACrB,KAAK,EAAE,EAAE,SAAS,EAAE,CAAC,YAAY,EAAE,KAAK,CAAC,EAAE,QAAQ,EAAE,CAAC,SAAS,CAAC,EAAE;IAClE,aAAa,EAAE,eAAe;IAE9B,UAAU,EAAE,QAAQ;IACpB,WAAW,EACT,8FAA8F;IAChG,eAAe,EAAE;;;;;;;;;uEASoD;IACrE,IAAI,EAAE,CAAC,SAAS,EAAE,SAAS,EAAE,UAAU,CAAC;IACxC,SAAS,EAAE,CAAC,IAAI,EAAE,KAAK,CAAC;IACxB,OAAO,EAAE,eAAe;CACzB,CAAC,CAAC"}

package/dist/checks/testing/test-convention-consistency.d.ts

@@ -0,0 +1,14 @@
+/**
+ * @fileoverview Test convention consistency check
+ *
+ * Detects mixed .test and .spec naming conventions across the codebase.
+ * When one convention is dominant (>95%), flags the minority files for renaming.
+ */
+/**
+ * Check: testing/test-convention-consistency
+ *
+ * Detects mixed .test and .spec naming conventions. When one is dominant (>95%),
+ * flags minority files for renaming to match the dominant convention.
+ */
+export declare const testConventionConsistency: import("@opensip-cli/fitness").Check;
+//# sourceMappingURL=test-convention-consistency.d.ts.map

package/dist/checks/testing/test-convention-consistency.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"test-convention-consistency.d.ts","sourceRoot":"","sources":["../../../src/checks/testing/test-convention-consistency.ts"],"names":[],"mappings":"AACA;;;;;GAKG;AAmBH;;;;;GAKG;AACH,eAAO,MAAM,yBAAyB,sCA2EpC,CAAC"}

package/dist/checks/testing/test-convention-consistency.js

@@ -0,0 +1,93 @@
+// @fitness-ignore-file batch-operation-limits -- iterates bounded collections (config entries, registry items, or small analysis results)
+/**
+ * @fileoverview Test convention consistency check
+ *
+ * Detects mixed .test and .spec naming conventions across the codebase.
+ * When one convention is dominant (>95%), flags the minority files for renaming.
+ */
+import * as path from 'node:path';
+import { defineCheck } from '@opensip-cli/fitness';
+/** Threshold for convention dominance (95%) */
+const DOMINANCE_THRESHOLD = 0.95;
+/**
+ * Determine which convention a file path uses.
+ */
+function getConvention(filePath) {
+    const basename = path.basename(filePath);
+    return basename.includes('.spec.') ? 'spec' : 'test';
+}
+/**
+ * Check: testing/test-convention-consistency
+ *
+ * Detects mixed .test and .spec naming conventions. When one is dominant (>95%),
+ * flags minority files for renaming to match the dominant convention.
+ */
+export const testConventionConsistency = defineCheck({
+    id: 'e5a7d9f1-6b0c-4a4d-c8e3-1f5b9d7a0c6e',
+    slug: 'test-convention-consistency',
+    scope: { languages: ['typescript', 'tsx'], concerns: ['testing'] },
+    confidence: 'medium',
+    description: 'Detects mixed .test and .spec naming conventions across the codebase',
+    longDescription: `**Purpose:** Detects mixed \`.test\` and \`.spec\` naming conventions and flags minority files when one convention is dominant (>95%).
+
+**Detects:**
+- Files using the minority test naming convention
+- Only flags when one convention is clearly dominant (>95% of all test files)
+- If neither convention is dominant, no violations are reported
+
+**Why it matters:** Consistent test naming conventions improve developer experience and make it easier to configure test runners, CI pipelines, and glob patterns consistently.
+
+**Scope:** Cross-file analysis via \`analyzeAll\`. General best practice.`,
+    tags: ['testing', 'consistency'],
+    fileTypes: ['ts', 'tsx'],
+    // @fitness-ignore-next-line concurrency-safety -- async keyword required by analyzeAll interface contract; synchronous analysis implementation
+    // eslint-disable-next-line @typescript-eslint/require-await -- AnalyzeAllCheckConfig requires Promise<CheckViolation[]>; this implementation is synchronous
+    async analyzeAll(files) {
+        const testFiles = [];
+        const specFiles = [];
+        // Categorize files by convention
+        for (const filePath of files.paths) {
+            const convention = getConvention(filePath);
+            if (convention === 'spec') {
+                specFiles.push(filePath);
+            }
+            else {
+                testFiles.push(filePath);
+            }
+        }
+        const total = testFiles.length + specFiles.length;
+        if (total === 0)
+            return [];
+        // Determine if one convention is dominant
+        const testRatio = testFiles.length / total;
+        const specRatio = specFiles.length / total;
+        let dominant = null;
+        let minorityFiles = [];
+        if (testRatio >= DOMINANCE_THRESHOLD) {
+            dominant = 'test';
+            minorityFiles = specFiles;
+        }
+        else if (specRatio >= DOMINANCE_THRESHOLD) {
+            dominant = 'spec';
+            minorityFiles = testFiles;
+        }
+        // No dominant convention — no violations
+        if (!dominant)
+            return [];
+        const violations = [];
+        const minorityConvention = dominant === 'test' ? 'spec' : 'test';
+        for (const filePath of minorityFiles) {
+            const basename = path.basename(filePath);
+            const renamed = basename.replace(`.${minorityConvention}.`, `.${dominant}.`);
+            violations.push({
+                filePath,
+                line: 1,
+                message: `Test file uses .${minorityConvention} convention but codebase uses .${dominant} (${Math.round((dominant === 'test' ? testRatio : specRatio) * 100)}% dominant)`,
+                severity: 'warning',
+                suggestion: `Rename to match dominant convention: ${renamed}`,
+            });
+        }
+        return violations;
+    },
+});
+//# sourceMappingURL=test-convention-consistency.js.map

package/dist/checks/testing/test-convention-consistency.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"test-convention-consistency.js","sourceRoot":"","sources":["../../../src/checks/testing/test-convention-consistency.ts"],"names":[],"mappings":"AAAA,0IAA0I;AAC1I;;;;;GAKG;AAEH,OAAO,KAAK,IAAI,MAAM,WAAW,CAAC;AAElC,OAAO,EAAE,WAAW,EAA0C,MAAM,sBAAsB,CAAC;AAE3F,+CAA+C;AAC/C,MAAM,mBAAmB,GAAG,IAAI,CAAC;AAIjC;;GAEG;AACH,SAAS,aAAa,CAAC,QAAgB;IACrC,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;IACzC,OAAO,QAAQ,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC;AACvD,CAAC;AAED;;;;;GAKG;AACH,MAAM,CAAC,MAAM,yBAAyB,GAAG,WAAW,CAAC;IACnD,EAAE,EAAE,sCAAsC;IAC1C,IAAI,EAAE,6BAA6B;IACnC,KAAK,EAAE,EAAE,SAAS,EAAE,CAAC,YAAY,EAAE,KAAK,CAAC,EAAE,QAAQ,EAAE,CAAC,SAAS,CAAC,EAAE;IAElE,UAAU,EAAE,QAAQ;IACpB,WAAW,EAAE,sEAAsE;IACnF,eAAe,EAAE;;;;;;;;;0EASuD;IACxE,IAAI,EAAE,CAAC,SAAS,EAAE,aAAa,CAAC;IAChC,SAAS,EAAE,CAAC,IAAI,EAAE,KAAK,CAAC;IAExB,+IAA+I;IAC/I,4JAA4J;IAC5J,KAAK,CAAC,UAAU,CAAC,KAAmB;QAClC,MAAM,SAAS,GAAa,EAAE,CAAC;QAC/B,MAAM,SAAS,GAAa,EAAE,CAAC;QAE/B,iCAAiC;QACjC,KAAK,MAAM,QAAQ,IAAI,KAAK,CAAC,KAAK,EAAE,CAAC;YACnC,MAAM,UAAU,GAAG,aAAa,CAAC,QAAQ,CAAC,CAAC;YAC3C,IAAI,UAAU,KAAK,MAAM,EAAE,CAAC;gBAC1B,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YAC3B,CAAC;iBAAM,CAAC;gBACN,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YAC3B,CAAC;QACH,CAAC;QAED,MAAM,KAAK,GAAG,SAAS,CAAC,MAAM,GAAG,SAAS,CAAC,MAAM,CAAC;QAClD,IAAI,KAAK,KAAK,CAAC;YAAE,OAAO,EAAE,CAAC;QAE3B,0CAA0C;QAC1C,MAAM,SAAS,GAAG,SAAS,CAAC,MAAM,GAAG,KAAK,CAAC;QAC3C,MAAM,SAAS,GAAG,SAAS,CAAC,MAAM,GAAG,KAAK,CAAC;QAE3C,IAAI,QAAQ,GAAsB,IAAI,CAAC;QACvC,IAAI,aAAa,GAAa,EAAE,CAAC;QAEjC,IAAI,SAAS,IAAI,mBAAmB,EAAE,CAAC;YACrC,QAAQ,GAAG,MAAM,CAAC;YAClB,aAAa,GAAG,SAAS,CAAC;QAC5B,CAAC;aAAM,IAAI,SAAS,IAAI,mBAAmB,EAAE,CAAC;YAC5C,QAAQ,GAAG,MAAM,CAAC;YAClB,aAAa,GAAG,SAAS,CAAC;QAC5B,CAAC;QAED,yCAAyC;QACzC,IAAI,CAAC,QAAQ;YAAE,OAAO,EAAE,CAAC;QAEzB,MAAM,UAAU,GAAqB,EAAE,CAAC;QACxC,MAAM,kBAAkB,GAAG,QAAQ,KAAK,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC;QAEjE,KAAK,MAAM,QAAQ,IAAI,aAAa,EAAE,CAAC;YACrC,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;YACzC,MAAM,OAAO,GAAG,QAAQ,CAAC,OAAO,CAAC,IAAI,kBAAkB,GAAG,EAAE,IAAI,QAAQ,GAAG,CAAC,CAAC;YAE7E,UAAU,CAAC,IAAI,CAAC;gBACd,QAAQ;gBACR,IAAI,EAAE,CAAC;gBACP,OAAO,EAAE,mBAAmB,kBAAkB,kCAAkC,QAAQ,KAAK,IAAI,CAAC,KAAK,CAAC,CAAC,QAAQ,KAAK,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,GAAG,GAAG,CAAC,aAAa;gBACzK,QAAQ,EAAE,SAAS;gBACnB,UAAU,EAAE,wCAAwC,OAAO,EAAE;aAC9D,CAAC,CAAC;QACL,CAAC;QAED,OAAO,UAAU,CAAC;IACpB,CAAC;CACF,CAAC,CAAC"}

package/dist/checks/testing/test-file-naming.d.ts

@@ -0,0 +1,13 @@
+/**
+ * @fileoverview Validates test file naming conventions
+ *
+ * Test files should follow the pattern *.test.ts or *.spec.ts
+ * and be located in __tests__ directories.
+ */
+/**
+ * Check: testing/test-file-naming
+ *
+ * Validates test file naming conventions follow *.test.ts or *.spec.ts patterns.
+ */
+export declare const testFileNaming: import("@opensip-cli/fitness").Check;
+//# sourceMappingURL=test-file-naming.d.ts.map

package/dist/checks/testing/test-file-naming.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"test-file-naming.d.ts","sourceRoot":"","sources":["../../../src/checks/testing/test-file-naming.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AA6MH;;;;GAIG;AACH,eAAO,MAAM,cAAc,sCAuBzB,CAAC"}