@qaguardian/playwright-score 0.1.12 → 0.1.14

package/README.md

@@ -16,7 +16,7 @@ Lint + score Playwright tests with:
 
 The score never calls an LLM. AI may *generate* or *repair* code using findings; **rules grade code**.
 
-See [METHODOLOGY.md](./METHODOLOGY.md) for the frozen formula, or the full product write-up on the [landing page](https://qaguardian.com/open-source/playwright-score).
+See [METHODOLOGY.md](./METHODOLOGY.md) for the frozen formula, [VALIDATION.md](./VALIDATION.md) for real-world results against public repos (cal.com, Grafana, Mattermost, ...) and a re-runnable script to reproduce them, or the full product write-up on the [landing page](https://qaguardian.com/open-source/playwright-score).
 
 ## Install
 

package/dist/cli.js

@@ -34,6 +34,14 @@ Website: https://qaguardian.com/open-source/playwright-score
 Methodology: METHODOLOGY.md (sqs-v1)
 `);
 }
+// Deliberately never process.exit() right after a console.log/console.error
+// — for a large enough write (verified against a real suite: a JSON report
+// with 1000+ findings, ~370KB) stdout to a pipe (not a TTY) is asynchronous,
+// and process.exit() can terminate the process before the OS has drained
+// the write, silently truncating the output exactly at the pipe buffer
+// size (64KB on macOS/Linux). Setting process.exitCode and returning lets
+// Node exit naturally once pending I/O actually completes, which is the
+// standard fix for this class of bug.
 async function main() {
     const args = process.argv.slice(2);
     if (args.includes('--version') || args.includes('-v')) {
@@ -46,11 +54,13 @@ async function main() {
         catch {
             console.log('0.1.8');
         }
-        process.exit(0);
+        process.exitCode = 0;
+        return;
     }
     if (args.length === 0 || args.includes('--help') || args.includes('-h')) {
         printHelp();
-        process.exit(args.length === 0 ? 2 : 0);
+        process.exitCode = args.length === 0 ? 2 : 0;
+        return;
     }
     let profile = 'standard';
     let threshold;
@@ -63,21 +73,24 @@ async function main() {
             profile = args[++i];
             if (profile !== 'standard' && profile !== 'guardian') {
                 console.error(`Invalid profile: ${profile}`);
-                process.exit(2);
+                process.exitCode = 2;
+                return;
             }
         }
         else if (a === '--threshold') {
             threshold = Number(args[++i]);
             if (Number.isNaN(threshold) || threshold < 0 || threshold > 100) {
                 console.error('threshold must be 0-100');
-                process.exit(2);
+                process.exitCode = 2;
+                return;
             }
         }
         else if (a === '--format') {
             const f = args[++i];
             if (f !== 'text' && f !== 'json' && f !== 'markdown' && f !== 'sarif') {
                 console.error(`Invalid format: ${f}`);
-                process.exit(2);
+                process.exitCode = 2;
+                return;
             }
             format = f;
         }
@@ -89,7 +102,8 @@ async function main() {
         }
         else if (a.startsWith('-')) {
             console.error(`Unknown option: ${a}`);
-            process.exit(2);
+            process.exitCode = 2;
+            return;
         }
         else {
             paths.push(a);
@@ -97,7 +111,8 @@ async function main() {
     }
     if (paths.length === 0) {
         console.error('At least one path is required');
-        process.exit(2);
+        process.exitCode = 2;
+        return;
     }
     try {
         const result = await scorePaths({ paths, profile, threshold });
@@ -122,11 +137,11 @@ async function main() {
         else {
             console.log(body);
         }
-        process.exit(result.pass ? 0 : 1);
+        process.exitCode = result.pass ? 0 : 1;
     }
     catch (err) {
         console.error(err instanceof Error ? err.message : err);
-        process.exit(2);
+        process.exitCode = 2;
     }
 }
 main();

package/dist/formatters/markdown.js

@@ -24,7 +24,7 @@ export function formatMarkdown(result) {
     }
     if (result.skippedFiles?.length) {
         lines.push('');
-        lines.push(`<details><summary>Skipped — looks like a non-Playwright test (Jest/Vitest/RTL) (${result.skippedFiles.length})</summary>`);
+        lines.push(`<details><summary>Skipped — looks like a non-Playwright test (Jest/Vitest/RTL/Cypress) (${result.skippedFiles.length})</summary>`);
         lines.push('');
         for (const f of result.skippedFiles) {
             lines.push(`- \`${f}\``);

package/dist/formatters/text.js

@@ -26,7 +26,7 @@ export function formatText(result) {
     }
     if (result.skippedFiles?.length) {
         lines.push('');
-        lines.push(`Skipped (looks like a non-Playwright test — Jest/Vitest/RTL — ${result.skippedFiles.length}):`);
+        lines.push(`Skipped (looks like a non-Playwright test — Jest/Vitest/RTL/Cypress — ${result.skippedFiles.length}):`);
         for (const f of result.skippedFiles.slice(0, 20)) {
             lines.push(`  ${f}`);
         }

package/dist/index.js

@@ -14,7 +14,20 @@ export { formatJson } from './formatters/json.js';
 export { formatText } from './formatters/text.js';
 export { formatMarkdown } from './formatters/markdown.js';
 export { formatSarif } from './formatters/sarif.js';
-const SPEC_GLOBS = ['**/*.{spec,test}.{ts,tsx,js,jsx}', '**/*.spec.ts', '**/*.test.ts'];
+// `.e2e.`/`.e2e-spec.`/`.e2e-test.` are real, common conventions for
+// disambiguating end-to-end specs from unit tests living in the same tree
+// — verified against two well-known, large real-world repos where a
+// directory scan previously hard-failed with "no files matched" despite a
+// fully healthy, populated suite: cal.com (53 specs, all *.e2e.ts) and
+// Immich (52 specs, all *.e2e-spec.ts). looksLikeNonPlaywrightTest (see
+// metrics.ts) is the safety net for a repo that uses `.e2e.` for a
+// *different* framework — Cypress specifically was common enough here to
+// get its own explicit check alongside the existing Jest/Vitest/RTL ones.
+const SPEC_GLOBS = [
+    '**/*.{spec,test,e2e,e2e-spec,e2e-test}.{ts,tsx,js,jsx}',
+    '**/*.spec.ts',
+    '**/*.test.ts',
+];
 // Directory/glob expansion must never sweep in vendored or generated code —
 // verified as a real bug: scanning a project root with a plain node_modules
 // dependency that ships its own *.spec.ts files silently included them
@@ -43,7 +56,7 @@ const DEFAULT_IGNORE_GLOBS = [
  * `expanded`: everything else (matched via a directory scan or a glob
  * pattern) — subject to the looksLikePlaywrightSpec filter in scorePaths,
  * since a broad `**\/*.test.ts`-style match can just as easily sweep in
- * unrelated Jest/Vitest/RTL unit tests sitting in the same repo.
+ * unrelated Jest/Vitest/RTL/Cypress unit tests sitting in the same repo.
  */
 function expandPaths(inputs, cwd) {
     const explicit = new Set();
@@ -166,7 +179,7 @@ export async function scorePaths(options) {
             {
                 rule: 'playwright-score/no-files',
                 severity: 'error',
-                message: `${expanded.length} file(s) matched but all look like non-Playwright tests (Jest/Vitest/RTL) — nothing to score.`,
+                message: `${expanded.length} file(s) matched but all look like non-Playwright tests (Jest/Vitest/RTL/Cypress) — nothing to score.`,
                 file: cwd,
                 dimension: 'structure',
             },

package/dist/metrics.d.ts

@@ -1,11 +1,11 @@
 import type { Finding, LocatorCounts } from './types.js';
 /**
  * Heuristic: does this file show positive evidence of being a *non*-
- * Playwright test (Jest/Vitest/Mocha/Jasmine/React Testing Library), as
- * opposed to a Playwright spec that a broad `**\/*.test.ts` glob would
- * otherwise sweep in alongside real e2e specs? Used only to decide whether
- * to auto-exclude a file discovered via directory/glob expansion — never
- * applied to a file path the caller named explicitly.
+ * Playwright test (Jest/Vitest/Mocha/Jasmine/React Testing Library/
+ * Cypress), as opposed to a Playwright spec that a broad `**\/*.test.ts`
+ * glob would otherwise sweep in alongside real e2e specs? Used only to
+ * decide whether to auto-exclude a file discovered via directory/glob
+ * expansion — never applied to a file path the caller named explicitly.
  */
 export declare function looksLikeNonPlaywrightTest(source: string): boolean;
 export declare function countLocators(source: string, file?: string): LocatorCounts;

package/dist/metrics.js

@@ -13,18 +13,27 @@ import { countSloc } from './sloc.js';
 // in one real suite). Denylisting known non-Playwright frameworks is much
 // safer — a missed rare/unusual file just scores harmlessly, where a
 // falsely-skipped real spec silently stops being scored at all.
-const NON_PLAYWRIGHT_IMPORT_RE = /from\s+['"](?:vitest|jest|@jest\/[a-z-]+|mocha|jasmine|chai|@testing-library\/[a-z-]+)['"]/;
+const NON_PLAYWRIGHT_IMPORT_RE = /from\s+['"](?:vitest|jest|@jest\/[a-z-]+|mocha|jasmine|chai|@testing-library\/[a-z-]+|cypress)['"]/;
 const RTL_API_RE = /\bscreen\.(?:getBy|queryBy|findBy|getAllBy|queryAllBy|findAllBy)\w*\(|\btoBeInTheDocument\(/;
+// Cypress's `cy` command object is globally available without an import in
+// the framework's default setup, the same way RTL's `screen` often is —
+// matched on specific, common Cypress command names (not a bare `cy.`
+// prefix) to avoid colliding with an unrelated local variable named `cy`.
+// Added alongside SPEC_GLOBS picking up `*.e2e.*` by default (see
+// index.ts): `.e2e.` is Cypress's own scaffolding convention too, so
+// broadening spec discovery to that suffix needed this as a companion
+// safety net, not just Playwright's own conventions.
+const CYPRESS_API_RE = /\bcy\.(?:visit|get|contains|click|type|should|intercept|wait|request|fixture)\(/;
 /**
  * Heuristic: does this file show positive evidence of being a *non*-
- * Playwright test (Jest/Vitest/Mocha/Jasmine/React Testing Library), as
- * opposed to a Playwright spec that a broad `**\/*.test.ts` glob would
- * otherwise sweep in alongside real e2e specs? Used only to decide whether
- * to auto-exclude a file discovered via directory/glob expansion — never
- * applied to a file path the caller named explicitly.
+ * Playwright test (Jest/Vitest/Mocha/Jasmine/React Testing Library/
+ * Cypress), as opposed to a Playwright spec that a broad `**\/*.test.ts`
+ * glob would otherwise sweep in alongside real e2e specs? Used only to
+ * decide whether to auto-exclude a file discovered via directory/glob
+ * expansion — never applied to a file path the caller named explicitly.
  */
 export function looksLikeNonPlaywrightTest(source) {
-    return NON_PLAYWRIGHT_IMPORT_RE.test(source) || RTL_API_RE.test(source);
+    return NON_PLAYWRIGHT_IMPORT_RE.test(source) || RTL_API_RE.test(source) || CYPRESS_API_RE.test(source);
 }
 const NATIVE_METHODS = new Set([
     'getByRole',

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@qaguardian/playwright-score",
-  "version": "0.1.12",
+  "version": "0.1.14",
   "description": "Deterministic, AI-free Playwright spec quality score (sqs-v1). Lint + score with standard and guardian profiles.",
   "type": "module",
   "main": "./dist/index.js",