@veda-hq/pariksha 0.3.2 → 0.5.1

package/README.md

@@ -4,8 +4,8 @@
 test-quality ratchets. Part of [Veda](https://github.com/veda-hq/veda).
 
 ```sh
-npx @veda-hq/pariksha@0.3.2 <check> [flags]
-npx @veda-hq/pariksha@0.3.2 --version
+npx @veda-hq/pariksha@0.5.1 <check> [flags]
+npx @veda-hq/pariksha@0.5.1 --version
 ```
 
 Every check exits 0 when the repository passes, 1 when it refuses something
@@ -62,6 +62,41 @@ the repository's deny list.
 - Binary files (any NUL byte) are skipped. Untracked files are not read.
   Line 0 in a finding is the file's path.
 
+## `coverage-by-type`
+
+```sh
+pariksha coverage-by-type [--config <file>] [--files-from <file>|-] [--root <dir>]
+```
+
+A source file in a category needs the tests its category names: by default a
+service, hook, utility or context a unit test, a repository a unit and an
+integration test, a component or screen a UI (`.test.tsx`) test. A suite named
+after its subject that never imports it is no test of it, so a candidate
+counts only when it loads the subject at runtime, directly or through one
+module it imports (a barrel, a collaborator). `import type`, a clause whose
+every binding is type-only, and `typeof import()` load nothing and do not
+count; `import()`, `require()`, `importActual` and `requireActual` do.
+
+Only `.ts` and `.tsx` files are judged. Without `--files-from` every tracked
+regular file is (not a symlink, not one deleted in the working tree), and a
+tree with none in a category exits 2. With it, the listed paths are (one per
+line or NUL-separated, relative to the root or absolute; `-` reads stdin, a
+file path is relative to the current directory); a listed path that does not
+exist or lies outside the root exits 2, and a listed symlink is skipped. The
+JSON `--config` (relative to the root) replaces each default it names, and
+refuses one that would judge nothing (no categories, an empty pattern, a
+category needing no test):
+`categories` (name to path regex, first match wins), `required` (category to
+test kinds), `tests` (kind to candidate paths, `{dir}` and `{name}`),
+`exclude` (path regexes), `aliases` (specifier prefix to a directory under the
+importing file's nearest `package.json`), `maxHops` (default 1) and `hint` (a
+line printed under a failure).
+
+Needs `typescript` `>=5.4 <6`, the repository's own install first, else one
+beside pariksha (an optional peer dependency: only this check reads it).
+TypeScript 7 exports no stable compiler API yet, so it exits 2 naming the
+installed version.
+
 ## `doc-budgets`
 
 ```sh

package/dist/authority-citations.js

@@ -21,7 +21,7 @@
 // again. tree mode judges every tracked file.
 import { existsSync, readdirSync, readFileSync, statSync } from 'node:fs';
 import { join, posix } from 'node:path';
-import { must, PLAIN_DIFF } from './git.js';
+import { must, PLAIN_DIFF } from "./git.js";
 export const DEFAULTS = { authorities: [], issuePrefixes: [], adrDir: 'docs/adr' };
 const escape = (s) => s.replace(/[.*+?^${}()|[\]\\]/g, '\\$&');
 /**

package/dist/cli.js

@@ -4,15 +4,17 @@ import { execFileSync } from 'node:child_process';
 import { existsSync, readFileSync, realpathSync, statSync } from 'node:fs';
 import { join, relative, resolve } from 'node:path';
 import { fileURLToPath } from 'node:url';
-import { adrDirOf, DEFAULTS, findUncited, formatClaims, listAdrs, readOrUndefined, stagedSource, treeSource } from './authority-citations.js';
-import { findDenied, hash, isText, parseDenyList } from './boundary.js';
-import { checkBudgets } from './doc-budgets.js';
-import { checkExportDeletions, formatReport } from './export-deletions.js';
-import { BASE_CANDIDATES, gitAt, gitAtTop, resolveBase, topOf } from './git.js';
+import { adrDirOf, DEFAULTS, findUncited, formatClaims, listAdrs, readOrUndefined, stagedSource, treeSource } from "./authority-citations.js";
+import { findDenied, hash, isText, parseDenyList } from "./boundary.js";
+import { DEFAULT_CONFIG, findGaps, formatGaps, listedPaths, loadTypescript, parseConfig, treePaths, typescriptLoaders } from "./coverage-by-type.js";
+import { checkBudgets } from "./doc-budgets.js";
+import { checkExportDeletions, formatReport } from "./export-deletions.js";
+import { BASE_CANDIDATES, gitAt, gitAtTop, must, resolveBase, topOf } from "./git.js";
 export const DENY_FILE = '.veda/deny.sha256';
 const USAGE = [
     'usage: pariksha authority-citations [--mode staged|tree] [--authority <a,b>] [--issue-prefix <A,B>] [--adr-dir <dir>] [--root <dir>]',
     '       pariksha boundary [--root <dir>] [--deny <file>]',
+    '       pariksha coverage-by-type [--config <file>] [--files-from <file>|-] [--root <dir>]',
     '       pariksha doc-budgets --table <file> [--section <name>] [--root <dir>]',
     '       pariksha export-deletions [--base <ref>] [--root <dir>]',
     '       pariksha hash <word>',
@@ -24,7 +26,7 @@ export const ownVersion = () => {
 };
 /** The files git tracks under root, text ones only. */
 export const trackedFiles = (root) => {
-    const names = execFileSync('git', ['ls-files', '-z'], { cwd: root, encoding: 'utf8' }).split('\0').filter(Boolean);
+    const names = must(gitAt(root), ['ls-files', '-z']).split('\0').filter(Boolean);
     const files = [];
     for (const path of names) {
         const full = join(root, path);
@@ -163,9 +165,45 @@ const authorityCitations = (f, io, env) => {
     result.err.forEach(io.err);
     return result.ok ? 0 : 1;
 };
+const coverageByType = (f, io) => {
+    const dir = resolve(f.get('--root') ?? '.');
+    const root = topOf(dir);
+    if (root === undefined) {
+        io.err(`pariksha coverage-by-type: ${dir} is not in a git repository`);
+        return 2;
+    }
+    const ts = (io.typescript ?? (() => loadTypescript(typescriptLoaders(root))))();
+    if (typeof ts === 'string') {
+        io.err(`pariksha coverage-by-type: ${ts}`);
+        return 2;
+    }
+    try {
+        const configPath = f.get('--config');
+        const config = configPath === undefined ? DEFAULT_CONFIG : parseConfig(readFileSync(resolve(root, configPath), 'utf8'));
+        const from = f.get('--files-from');
+        const paths = from === undefined
+            ? treePaths(root, must(gitAt(root), ['ls-files', '-z']))
+            : listedPaths(root, from === '-' ? (io.stdin ?? (() => readFileSync(0, 'utf8')))() : readFileSync(resolve(from), 'utf8'));
+        const findings = findGaps(ts, config, root, paths);
+        if (from === undefined && findings.judged === 0) {
+            // The whole tree in no category is a config that checks nothing.
+            io.err(`pariksha coverage-by-type: none of ${findings.listed} tracked file(s) is in a category; nothing was checked, so this is not a pass`);
+            return 2;
+        }
+        const result = formatGaps(config, findings);
+        result.out.forEach(io.out);
+        result.err.forEach(io.err);
+        return result.ok ? 0 : 1;
+    }
+    catch (e) {
+        io.err(`pariksha coverage-by-type: ${e.message}; nothing was checked, so this is not a pass`);
+        return 2;
+    }
+};
 const COMMANDS = {
     'authority-citations': { allowed: ['--mode', '--authority', '--issue-prefix', '--adr-dir', '--root'], run: authorityCitations },
     boundary: { allowed: ['--root', '--deny'], run: boundary },
+    'coverage-by-type': { allowed: ['--config', '--files-from', '--root'], run: coverageByType },
     'doc-budgets': { allowed: ['--table', '--section', '--root'], run: docBudgets },
     'export-deletions': { allowed: ['--base', '--root'], run: exportDeletions },
 };

package/dist/coverage-by-type.js

@@ -0,0 +1,396 @@
+// coverage-by-type: a source file in a category needs the tests its category names,
+// and a test counts only if it loads its subject at runtime.
+//
+// A suite named after its subject that never imports it is no test of it: a page
+// sat at 0% covered while `Page.test.tsx` tested a helper, and a filename match
+// called the page covered. So a candidate suite counts only when it reaches the
+// subject through a runtime import, directly or through one module it imports.
+import { createRequire } from 'node:module';
+import { existsSync, lstatSync, readFileSync, realpathSync, statSync } from 'node:fs';
+import { basename, dirname, isAbsolute, join, relative, resolve, sep } from 'node:path';
+const KINDS_AT = (dirs, suffixes) => dirs.flatMap((d) => suffixes.map((s) => `${d}{name}${s}`));
+export const DEFAULT_CONFIG = {
+    categories: [
+        ['service', /\/(services|domain)\/.+\.(ts|tsx)$/],
+        ['repository', /\/repositories?\/.+\.(ts|tsx)$/],
+        ['component', /\/components?\/.+\.(tsx)$/],
+        ['screen', /\/screens?\/.+\.(tsx)$/],
+        ['hook', /\/hooks?\/use[A-Z].+\.(ts|tsx)$/],
+        ['utility', /\/(utils|helpers|lib)\/.+\.(ts|tsx)$/],
+        ['context', /\/context\/.+\.(tsx)$/],
+    ],
+    required: new Map([
+        ['service', ['unit']],
+        ['repository', ['unit', 'integration']],
+        ['component', ['ui']],
+        ['screen', ['ui']],
+        ['hook', ['unit']],
+        ['utility', ['unit']],
+        ['context', ['unit']],
+    ]),
+    exclude: [
+        /\.(test|spec|test-d|spec-d|perf-test)\.(ts|tsx)$/,
+        /\.d\.ts$/,
+        /\.config\.(ts|js|mts|mjs)$/,
+        /index\.(ts|tsx)$/,
+        /types?\.(ts|tsx)$/,
+        /(^|\/)types\//,
+        /__mocks__\//,
+        /__tests__\//,
+        /\/e2e\//,
+        /\/test\//,
+        /node_modules/,
+    ],
+    tests: new Map([
+        ['unit', KINDS_AT(['{dir}/', '{dir}/__tests__/', '{dir}/test/', '{dir}/tests/'], ['.test.ts', '.test.tsx'])],
+        [
+            'integration',
+            [
+                ...KINDS_AT(['{dir}/'], ['.integration.test.ts', '.integration.test.tsx']),
+                ...KINDS_AT(['{dir}/__tests__/integration/', '{dir}/test/integration/', '{dir}/tests/integration/'], ['.test.ts', '.test.tsx']),
+            ],
+        ],
+        ['ui', KINDS_AT(['{dir}/', '{dir}/__tests__/', '{dir}/test/', '{dir}/tests/'], ['.test.tsx'])],
+    ]),
+    aliases: new Map(),
+    maxHops: 1,
+    hint: undefined,
+};
+const isRecord = (v) => typeof v === 'object' && v !== null && !Array.isArray(v);
+const isStrings = (v) => Array.isArray(v) && v.every((s) => typeof s === 'string');
+const regex = (source, where) => {
+    // An empty pattern matches every path: an exclusion would judge nothing.
+    if (source === '')
+        throw new Error(`${where}: an empty pattern matches every path`);
+    try {
+        // The product's own config file, read from its own checkout.
+        return new RegExp(source);
+    }
+    catch (e) {
+        throw new Error(`${where}: ${e.message}`);
+    }
+};
+const KEYS = new Set(['categories', 'required', 'exclude', 'tests', 'aliases', 'maxHops', 'hint']);
+/** The config a JSON text names, over the defaults; throws naming the first bad key. */
+export const parseConfig = (text) => {
+    let raw;
+    try {
+        raw = JSON.parse(text);
+    }
+    catch (e) {
+        throw new Error(`not JSON: ${e.message}`);
+    }
+    if (!isRecord(raw))
+        throw new Error('the config must be a JSON object');
+    const unknown = Object.keys(raw).find((k) => !KEYS.has(k));
+    if (unknown !== undefined)
+        throw new Error(`unknown key "${unknown}"`);
+    const stringMap = (key) => {
+        const v = raw[key];
+        if (v === undefined)
+            return undefined;
+        if (!isRecord(v) || !Object.values(v).every((s) => typeof s === 'string'))
+            throw new Error(`"${key}" must map names to strings`);
+        return new Map(Object.entries(v));
+    };
+    const listMap = (key) => {
+        const v = raw[key];
+        if (v === undefined)
+            return undefined;
+        if (!isRecord(v) || !Object.values(v).every(isStrings))
+            throw new Error(`"${key}" must map names to lists of strings`);
+        return new Map(Object.entries(v));
+    };
+    const cats = stringMap('categories');
+    if (cats?.size === 0)
+        throw new Error('"categories" is empty, so no file would be judged');
+    // JSON objects iterate integer-like keys first, which would reorder "first match wins".
+    const numeric = cats && [...cats.keys()].find((k) => /^(0|[1-9]\d*)$/.test(k));
+    if (numeric)
+        throw new Error(`category "${numeric}": a name that is a number loses its place in the order`);
+    const categories = cats ? [...cats].map(([name, src]) => [name, regex(src, `categories.${name}`)]) : DEFAULT_CONFIG.categories;
+    const required = listMap('required') ?? DEFAULT_CONFIG.required;
+    const tests = listMap('tests') ?? DEFAULT_CONFIG.tests;
+    const aliases = stringMap('aliases') ?? DEFAULT_CONFIG.aliases;
+    let exclude = DEFAULT_CONFIG.exclude;
+    if (raw['exclude'] !== undefined) {
+        if (!isStrings(raw['exclude']))
+            throw new Error('"exclude" must be a list of strings');
+        exclude = raw['exclude'].map((src, i) => regex(src, `exclude[${i}]`));
+    }
+    const maxHops = raw['maxHops'] ?? DEFAULT_CONFIG.maxHops;
+    if (typeof maxHops !== 'number' || !Number.isInteger(maxHops) || maxHops < 0)
+        throw new Error('"maxHops" must be a whole number, 0 or more');
+    const hint = raw['hint'] ?? DEFAULT_CONFIG.hint;
+    if (hint !== undefined && typeof hint !== 'string')
+        throw new Error('"hint" must be a string');
+    for (const [name] of categories) {
+        const kinds = required.get(name);
+        if (kinds === undefined)
+            throw new Error(`category "${name}" has no "required" entry`);
+        if (kinds.length === 0)
+            throw new Error(`category "${name}" requires no test, so it would never be refused`);
+        const missing = kinds.find((k) => !tests.has(k));
+        if (missing !== undefined)
+            throw new Error(`category "${name}" requires "${missing}", which "tests" does not define`);
+    }
+    for (const [kind, paths] of tests) {
+        const bad = paths.find((p) => !p.includes('{name}'));
+        if (bad !== undefined)
+            throw new Error(`tests.${kind}: "${bad}" has no {name}, so it names one file for every source`);
+    }
+    return { categories, required, exclude, tests, aliases, maxHops, hint };
+};
+/** Where typescript is looked for: the product's own install at `root` first, then beside pariksha (npx installs no optional peer). */
+export const typescriptLoaders = (root) => [createRequire(join(root, 'package.json')), createRequire(import.meta.url)];
+/** TypeScript from the first loader that has it; a message naming why when it cannot be used. */
+export const loadTypescript = (loaders = typescriptLoaders(process.cwd())) => {
+    let mod;
+    for (const load of loaders) {
+        try {
+            mod = load('typescript');
+            break;
+        }
+        catch {
+            // not installed there; try the next
+        }
+    }
+    if (mod === undefined)
+        return 'needs the typescript package (>=5.4 <6) in the repository or beside pariksha';
+    const ts = mod;
+    if (typeof ts.createSourceFile !== 'function') {
+        return `needs the TypeScript compiler API, which typescript ${String(ts.version)} does not export; install typescript >=5.4 <6`;
+    }
+    return ts;
+};
+const toPosix = (p) => p.split(sep).join('/');
+/** Extensions a specifier may omit, or carry as its ESM-facing `.js` form. */
+const MODULE_EXTENSIONS = ['.ts', '.tsx', '.js', '.jsx', '.mts', '.mjs'];
+/** The call forms that load a module at runtime, by callee name. */
+const RUNTIME_LOADERS = new Set(['require', 'importActual', 'requireActual']);
+/**
+ * Whether an import or export clause survives to runtime. `import type` is erased
+ * and loads nothing; so is a named clause whose every binding is type-only. A
+ * clause-less import runs its module.
+ */
+const clauseReachesRuntime = (ts, node) => {
+    if (ts.isExportDeclaration(node)) {
+        if (node.isTypeOnly)
+            return false;
+        const b = node.exportClause;
+        return b && ts.isNamedExports(b) ? b.elements.some((e) => !e.isTypeOnly) : true;
+    }
+    const clause = node.importClause;
+    if (!clause)
+        return true;
+    if (clause.isTypeOnly)
+        return false;
+    if (clause.name)
+        return true;
+    const b = clause.namedBindings;
+    return b && ts.isNamedImports(b) ? b.elements.some((e) => !e.isTypeOnly) : true;
+};
+/**
+ * Every module specifier a file loads at runtime: surviving imports and re-exports,
+ * `import()`, `require()`, and `importActual`/`requireActual`. Parsed, not matched:
+ * `typeof import('./x')` in a type loads nothing, and only syntax tells it apart.
+ * A template with substitutions is not resolved; its target needs evaluating.
+ */
+export const moduleSpecifiers = (ts, source, fileName = 'file.tsx') => {
+    const parsed = ts.createSourceFile(fileName, source, ts.ScriptTarget.Latest);
+    const found = [];
+    const visit = (node) => {
+        if ((ts.isImportDeclaration(node) || ts.isExportDeclaration(node)) && node.moduleSpecifier && ts.isStringLiteral(node.moduleSpecifier)) {
+            if (clauseReachesRuntime(ts, node))
+                found.push(node.moduleSpecifier.text);
+        }
+        else if (ts.isCallExpression(node)) {
+            const [first] = node.arguments;
+            const callee = node.expression;
+            const name = ts.isPropertyAccessExpression(callee) ? callee.name.text : ts.isIdentifier(callee) ? callee.text : undefined;
+            const isDynamicImport = callee.kind === ts.SyntaxKind.ImportKeyword;
+            const specifier = first && (ts.isStringLiteral(first) || ts.isNoSubstitutionTemplateLiteral(first)) ? first.text : undefined;
+            if (specifier !== undefined && (isDynamicImport || (name !== undefined && RUNTIME_LOADERS.has(name))))
+                found.push(specifier);
+        }
+        ts.forEachChild(node, visit);
+    };
+    ts.forEachChild(parsed, visit);
+    return found;
+};
+const stripModuleExtension = (p) => {
+    const ext = MODULE_EXTENSIONS.find((e) => p.endsWith(e));
+    return ext ? p.slice(0, -ext.length) : p;
+};
+const isFile = (p) => existsSync(p) && statSync(p).isFile();
+/** The workspace a file belongs to: its nearest ancestor holding a package.json. */
+const workspaceRootOf = (file) => {
+    for (let dir = dirname(resolve(file));; dir = dirname(dir)) {
+        if (existsSync(join(dir, 'package.json')))
+            return dir;
+        if (dirname(dir) === dir)
+            return undefined;
+    }
+};
+/** The walk from a test to its subject, with each file's specifiers read once. */
+export class ImportWalk {
+    #specifiers = new Map();
+    #ts;
+    #config;
+    constructor(ts, config) {
+        this.#ts = ts;
+        this.#config = config;
+    }
+    #specifiersOf(file) {
+        let found = this.#specifiers.get(file);
+        if (found === undefined) {
+            found = moduleSpecifiers(this.#ts, readFileSync(file, 'utf8'), file);
+            this.#specifiers.set(file, found);
+        }
+        return found;
+    }
+    /** An absolute extensionless path, or undefined for what cannot be followed (a package, an unknown alias). */
+    #resolveSpecifier(specifier, fromFile) {
+        if (specifier.startsWith('.'))
+            return stripModuleExtension(resolve(dirname(fromFile), specifier));
+        for (const [prefix, dir] of this.#config.aliases) {
+            if (!specifier.startsWith(prefix))
+                continue;
+            const root = workspaceRootOf(fromFile);
+            return root === undefined ? undefined : stripModuleExtension(resolve(root, dir, specifier.slice(prefix.length)));
+        }
+        return undefined;
+    }
+    /** Whether a test reaches its subject, directly or through up to maxHops modules it imports. */
+    reaches(testFile, sourceFile) {
+        const target = stripModuleExtension(resolve(sourceFile));
+        const start = resolve(testFile);
+        const visited = new Set([start]);
+        let frontier = [start];
+        for (let hop = 0; hop <= this.#config.maxHops; hop++) {
+            const next = [];
+            for (const file of frontier) {
+                for (const specifier of this.#specifiersOf(file)) {
+                    const resolved = this.#resolveSpecifier(specifier, file);
+                    if (resolved === undefined)
+                        continue;
+                    if (resolved === target)
+                        return true;
+                    const onDisk = resolveToFile(resolved);
+                    if (onDisk === undefined)
+                        continue;
+                    if (stripModuleExtension(onDisk) === target)
+                        return true;
+                    if (!visited.has(onDisk)) {
+                        visited.add(onDisk);
+                        next.push(onDisk);
+                    }
+                }
+            }
+            frontier = next;
+        }
+        return false;
+    }
+}
+/** The file an extensionless path names: itself with an extension, or its directory's index. */
+const resolveToFile = (extensionless) => MODULE_EXTENSIONS.map((e) => `${extensionless}${e}`).find(isFile) ?? MODULE_EXTENSIONS.map((e) => join(extensionless, `index${e}`)).find(isFile);
+/** The category of a root-relative path, or undefined when none matches. */
+export const categoryOf = (config, path) => config.categories.find(([, re]) => re.test(toPosix(path)))?.[0];
+export const isExcluded = (config, path) => config.exclude.some((re) => re.test(toPosix(path)));
+/** The test kinds found for one source file: a candidate that exists and reaches it. */
+export const foundKinds = (config, walk, root, path) => {
+    const full = resolve(root, path);
+    const dir = dirname(full);
+    const name = full.slice(dir.length + 1).replace(/\.(ts|tsx)$/, '');
+    const found = new Set();
+    for (const [kind, patterns] of config.tests) {
+        const hit = patterns.some((p) => {
+            // Function replacements: a `$` in a path is text, never a replacement pattern.
+            const candidate = resolve(root, p.replaceAll('{dir}', () => dir).replaceAll('{name}', () => name));
+            return isFile(candidate) && walk.reaches(candidate, full);
+        });
+        if (hit)
+            found.add(kind);
+    }
+    return found;
+};
+/** The gaps among root-relative `paths`: each `.ts`/`.tsx` file, not excluded, in a category, missing a kind. */
+export const findGaps = (ts, config, root, paths) => {
+    const walk = new ImportWalk(ts, config);
+    const gaps = [];
+    let judged = 0;
+    for (const path of paths) {
+        const rel = toPosix(path);
+        if (!/\.(ts|tsx)$/.test(rel) || isExcluded(config, rel))
+            continue;
+        const category = categoryOf(config, rel);
+        if (category === undefined)
+            continue;
+        judged++;
+        const found = foundKinds(config, walk, root, rel);
+        const missing = (config.required.get(category) ?? []).filter((k) => !found.has(k));
+        if (missing.length > 0)
+            gaps.push({ file: rel, category, missing });
+    }
+    return { gaps, judged, listed: paths.length };
+};
+/** A listing's entries: NUL-separated when it holds a NUL, else one per line; a leading BOM dropped. */
+export const entries = (text) => {
+    const body = text.startsWith('') ? text.slice(1) : text;
+    return body.split(body.includes('\0') ? '\0' : /\r?\n/).filter(Boolean);
+};
+/** Every tracked regular file under root: not deleted in the working tree, not a symlink. */
+export const treePaths = (root, listed) => entries(listed).filter((p) => lstatOrUndefined(join(root, p))?.isFile() === true);
+/**
+ * The root-relative path of each listed entry (relative to root, or absolute).
+ * An entry naming nothing, or outside the root, throws: a list that cannot be
+ * read as given is not a list that passed. A symlink is not a source file and
+ * is skipped, as git's own listings do. Directories are resolved through their
+ * real path, so a symlinked checkout prefix still matches `^`-anchored rules.
+ */
+export const listedPaths = (root, text) => {
+    const out = [];
+    for (const entry of entries(text)) {
+        const abs = resolve(root, entry);
+        const stat = lstatOrUndefined(abs);
+        if (stat === undefined)
+            throw new Error(`listed file ${entry} does not exist`);
+        if (stat.isSymbolicLink())
+            continue;
+        const rel = relative(root, join(realpathSync(dirname(abs)), basename(abs)));
+        if (rel === '..' || rel.startsWith(`..${sep}`) || isAbsolute(rel))
+            throw new Error(`listed file ${entry} is outside ${root}`);
+        if (stat.isFile())
+            out.push(toPosix(rel));
+    }
+    return out;
+};
+const lstatOrUndefined = (p) => {
+    try {
+        return lstatSync(p);
+    }
+    catch (e) {
+        if (e.code === 'ENOENT' || e.code === 'ENOTDIR')
+            return undefined;
+        throw e;
+    }
+};
+const P = 'pariksha coverage-by-type:';
+export const formatGaps = (config, findings) => {
+    const { gaps, judged, listed } = findings;
+    if (gaps.length === 0)
+        return { ok: true, out: [`${P} ${judged} of ${listed} listed file(s) judged, each has the tests its category needs`], err: [] };
+    const err = [];
+    const byCategory = new Map();
+    for (const g of gaps)
+        byCategory.set(g.category, [...(byCategory.get(g.category) ?? []), g]);
+    for (const [category, list] of byCategory) {
+        err.push(`${P} ${category} (needs: ${(config.required.get(category) ?? []).join(', ')} tests)`);
+        for (const g of list)
+            err.push(`  ${g.file}: missing ${g.missing.join(', ')}`);
+    }
+    err.push('', `${P} ${gaps.length} file(s) missing required tests. A suite counts only when it imports its subject at runtime.`);
+    if (config.hint !== undefined)
+        err.push(config.hint);
+    return { ok: false, out: [], err };
+};

package/dist/export-deletions.js

@@ -10,7 +10,7 @@
 //   Removes-Export: <symbol> — <why>     covers one symbol
 //   Removes-File: <path> — <why>         covers every export of a file that
 //                                        no longer exists at HEAD
-import { must, PLAIN_DIFF } from './git.js';
+import { must, PLAIN_DIFF } from "./git.js";
 export const SOURCE_GLOBS = ['*.ts', '*.tsx', '*.js', '*.jsx', '*.mjs', '*.cjs', '*.mts', '*.cts'];
 /** Build output and vendored code never count as a source change, or as a use. */
 const SKIPPED = ['node_modules', 'dist', 'build', 'coverage', 'generated'];

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@veda-hq/pariksha",
-  "version": "0.3.2",
-  "description": "Repository checks: doc drift, rule enforcement, test-quality ratchets. Checks: authority-citations, boundary, doc-budgets, export-deletions.",
+  "version": "0.5.1",
+  "description": "Repository checks: doc drift, rule enforcement, test-quality ratchets. Checks: authority-citations, boundary, coverage-by-type, doc-budgets, export-deletions.",
   "keywords": [
     "repository checks",
     "lint",
@@ -30,9 +30,17 @@
   "files": [
     "dist"
   ],
+  "peerDependencies": {
+    "typescript": ">=5.4 <6"
+  },
+  "peerDependenciesMeta": {
+    "typescript": {
+      "optional": true
+    }
+  },
   "devDependencies": {
     "@types/node": "24.19.2",
-    "typescript": "7.0.2"
+    "typescript": "5.9.3"
   },
   "scripts": {
     "build": "tsc -p tsconfig.build.json",