playwright-logbook 0.2.0

package/dist/reporter.js

@@ -0,0 +1,161 @@
+import path from 'node:path';
+import fs from 'node:fs/promises';
+import { buildShardFile } from './collect.js';
+import { detectEnv } from './env.js';
+import { resolveOptions } from './options.js';
+import { sanitize } from './sanitize.js';
+import { FileShardSink } from './store.js';
+import { FileHistoryStore } from './store.js';
+import { mergeShards } from './merge.js';
+import { toRel, toRelOrNull } from './paths.js';
+import { buildReportModel } from './model.js';
+import { compareRuns, computeFlaky, previousRun } from './history.js';
+import { renderReport } from './render.js';
+import { resolveArtifactAvailability } from './artifacts.js';
+/** Playwright reporter that writes a durable shard without changing the test result. */
+export class LogbookReporter {
+    options;
+    deps;
+    config;
+    suite;
+    startedAt;
+    detected;
+    root;
+    globalErrors = [];
+    warned = false;
+    stepsByResult = new WeakMap();
+    constructor(options = {}, deps = {}) {
+        this.options = resolveOptions(options);
+        this.deps = deps;
+    }
+    printsToStdio() { return false; }
+    write(line) {
+        (this.deps.stderr ?? ((text) => process.stderr.write(text)))(`${line}\n`);
+    }
+    warning(error) {
+        if (this.warned)
+            return;
+        this.warned = true;
+        try {
+            const message = sanitize(error instanceof Error ? error.message : String(error), { projectRoot: this.root, env: this.deps.env, redact: this.options.redact, maxTextLength: this.options.maxTextLength });
+            this.write(`[logbook] warning: ${message}`);
+        }
+        catch { /* Reporter hooks must never throw. */ }
+    }
+    onBegin(config, suite) {
+        try {
+            this.config = config;
+            this.suite = suite;
+            this.root = config.configFile ? path.dirname(config.configFile) : (this.deps.cwd ?? process.cwd)();
+            this.startedAt = (this.deps.clock ?? (() => new Date()))();
+            this.detected = detectEnv({ ...this.deps, root: this.root, runId: this.options.runId });
+        }
+        catch (error) {
+            this.warning(error);
+        }
+    }
+    onError(error) {
+        try {
+            this.globalErrors.push(error);
+        }
+        catch (caught) {
+            this.warning(caught);
+        }
+    }
+    onStepEnd(_test, result, step) {
+        try {
+            const capture = this.options.captureDetails;
+            if (!capture || (capture !== true && !capture.steps))
+                return;
+            if (!['test.step', 'expect', 'pw:api', 'hook', 'fixture'].includes(step.category))
+                return;
+            const steps = this.stepsByResult.get(result) ?? [];
+            if (steps.length >= (this.options.maxSteps ?? 100))
+                return;
+            let depth = 0, parent = step.parent;
+            while (parent && depth < 2) {
+                depth += 1;
+                parent = parent.parent;
+            }
+            steps.push({ title: sanitize(step.title, { projectRoot: this.root, env: this.deps.env ?? process.env, redact: this.options.redact, maxTextLength: this.options.maxTextLength }), category: step.category, durationMs: Math.max(0, step.duration), depth, failed: Boolean(step.error) });
+            this.stepsByResult.set(result, steps);
+        }
+        catch (error) {
+            this.warning(error);
+        }
+    }
+    async captureImages(tests) {
+        const result = new WeakMap();
+        const capture = this.options.captureDetails;
+        if (!capture || (capture !== true && !capture.images) || !this.root)
+            return result;
+        let total = 0;
+        const reader = this.deps.fs?.readFile ?? fs.readFile;
+        const stat = this.deps.fs?.stat ?? fs.stat;
+        for (const test of tests) {
+            if (test.outcome() !== 'unexpected' && test.outcome() !== 'flaky')
+                continue;
+            for (const attempt of test.results)
+                for (const attachment of attempt.attachments) {
+                    if (!attachment.path || !['image/png', 'image/jpeg'].includes(attachment.contentType) || toRelOrNull(this.root, attachment.path) === null)
+                        continue;
+                    try {
+                        const size = (await stat(attachment.path)).size;
+                        if (size > (this.options.maxImageBytes ?? 250000) || total + size > (this.options.maxEmbeddedBytes ?? 5000000))
+                            continue;
+                        const bytes = await reader(attachment.path);
+                        if (bytes.length > (this.options.maxImageBytes ?? 250000) || total + bytes.length > (this.options.maxEmbeddedBytes ?? 5000000))
+                            continue;
+                        result.set(attachment, `data:${attachment.contentType};base64,${bytes.toString('base64')}`);
+                        total += bytes.length;
+                    }
+                    catch { /* Missing images do not break the reporter. */ }
+                }
+        }
+        return result;
+    }
+    async saveReport(run, store, outputDir) {
+        const summaries = await store.listSummaries({ limit: this.options.historyLimit });
+        const current = summaries.find((item) => item.runId === run.runId) ?? { schemaVersion: 1, runId: run.runId, title: run.title, startedAt: run.startedAt, durationMs: run.durationMs, status: run.status, complete: run.complete, summary: run.summary, branch: run.env.git.branch, commit: run.env.git.commit, ciProvider: run.env.ci?.provider ?? null, buildUrl: run.env.ci?.buildUrl ?? null };
+        const previous = previousRun(summaries, current);
+        const previousRecord = previous ? await store.loadRun(previous.runId) : null;
+        const runs = await store.loadRuns(summaries.map((item) => item.runId).reverse());
+        const attachmentAvailability = await resolveArtifactAvailability(run, this.root, { realpath: this.deps.fs?.realpath ?? fs.realpath, stat: this.deps.fs?.stat ?? fs.stat });
+        const model = buildReportModel({ run, summaries, previous, comparison: compareRuns(run, previousRecord), flaky: computeFlaky(runs), recentRuns: runs.filter((item) => item.runId !== run.runId), generatedAt: (this.deps.clock ?? (() => new Date()))().toISOString(), historyLimit: this.options.historyLimit, attachmentAvailability });
+        const target = path.join(outputDir, 'report', 'index.html');
+        const files = this.deps.fs ?? fs;
+        await files.mkdir(path.dirname(target), { recursive: true });
+        await files.writeFile(`${target}.tmp`, renderReport(model), 'utf8');
+        await files.rename(`${target}.tmp`, target);
+    }
+    async onEnd(result) {
+        try {
+            if (!this.config || !this.suite || !this.root || !this.startedAt || !this.detected)
+                throw new Error('reporter was not initialized');
+            const endedAt = result.startTime && result.duration !== undefined
+                ? new Date(result.startTime.getTime() + result.duration)
+                : (this.deps.clock ?? (() => new Date()))();
+            const outputDir = path.resolve(this.root, this.options.outputDir);
+            const tests = this.suite.allTests();
+            const imageData = await this.captureImages(tests);
+            const shard = buildShardFile({ config: this.config, tests, runId: this.detected.runId, title: this.options.title, startedAt: this.startedAt, endedAt, status: result.status, env: { ci: this.detected.ci, git: this.detected.git, machine: this.detected.machine, playwrightVersion: this.config.version, workers: this.config.workers }, globalErrors: this.globalErrors, ctx: { projectRoot: this.root, env: this.deps.env ?? (this.options.captureDetails ? process.env : undefined), redact: this.options.redact, caseIdPatterns: this.options.caseIdPatterns, maxTextLength: this.options.maxTextLength, captureDetails: this.options.captureDetails, maxSteps: this.options.maxSteps, maxOutputLength: this.options.maxOutputLength, stepsByResult: this.stepsByResult, imageData } });
+            await (this.deps.sink ?? new FileShardSink(outputDir, this.deps.fs)).write(shard);
+            if (this.options.autoMerge && (!shard.shard || shard.shard.total === 1)) {
+                const { run } = mergeShards([shard], { outputDir: toRel(this.root, outputDir) });
+                const store = this.deps.historyStore ?? new FileHistoryStore(outputDir);
+                await store.saveRun(run);
+                if (this.options.autoReport)
+                    await this.saveReport(run, store, outputDir);
+            }
+            if (!this.options.quiet) {
+                const count = (outcome) => shard.tests.filter((test) => test.outcome === outcome).length;
+                const reportPath = this.options.autoMerge && this.options.autoReport && (!shard.shard || shard.shard.total === 1) ? ` -> ${toRel(this.root, path.join(outputDir, 'report', 'index.html'))}` : '';
+                this.write(`[logbook] run ${shard.runId}: ${count('expected')} passed, ${count('unexpected')} failed, ${count('flaky')} flaky, ${count('skipped')} skipped${reportPath}`);
+            }
+        }
+        catch (error) {
+            this.warning(error);
+        }
+    }
+}
+//# sourceMappingURL=reporter.js.map

package/dist/reporter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"reporter.js","sourceRoot":"","sources":["../src/reporter.ts"],"names":[],"mappings":"AAAA,OAAO,IAAI,MAAM,WAAW,CAAC;AAC7B,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAElC,OAAO,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAE9C,OAAO,EAAE,SAAS,EAAE,MAAM,UAAU,CAAC;AAErC,OAAO,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAC9C,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAEzC,OAAO,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AAE3C,OAAO,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAC;AAC9C,OAAO,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AACzC,OAAO,EAAE,KAAK,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAChD,OAAO,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAC;AAC9C,OAAO,EAAE,WAAW,EAAE,YAAY,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AACtE,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAE3C,OAAO,EAAE,2BAA2B,EAAE,MAAM,gBAAgB,CAAC;AAY7D,wFAAwF;AACxF,MAAM,OAAO,eAAe;IACT,OAAO,CAAoC;IAC3C,IAAI,CAAe;IAC5B,MAAM,CAAuB;IAC7B,KAAK,CAA4B;IACjC,SAAS,CAAmB;IAC5B,QAAQ,CAA0B;IAClC,IAAI,CAAqB;IACzB,YAAY,GAAc,EAAE,CAAC;IAC7B,MAAM,GAAG,KAAK,CAAC;IACN,aAAa,GAAG,IAAI,OAAO,EAA0B,CAAC;IAEvE,YAAY,UAA0B,EAAE,EAAE,OAAqB,EAAE;QAC/D,IAAI,CAAC,OAAO,GAAG,cAAc,CAAC,OAAO,CAAC,CAAC;QACvC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACnB,CAAC;IAED,aAAa,KAAc,OAAO,KAAK,CAAC,CAAC,CAAC;IAElC,KAAK,CAAC,IAAY;QACxB,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,GAAG,IAAI,IAAI,CAAC,CAAC;IAC5E,CAAC;IAEO,OAAO,CAAC,KAAc;QAC5B,IAAI,IAAI,CAAC,MAAM;YAAE,OAAO;QACxB,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC;QACnB,IAAI,CAAC;YACH,MAAM,OAAO,GAAG,QAAQ,CAAC,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,EAAE,WAAW,EAAE,IAAI,CAAC,IAAI,EAAE,GAAG,EAAE,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,aAAa,EAAE,IAAI,CAAC,OAAO,CAAC,aAAa,EAAE,CAAC,CAAC;YACzM,IAAI,CAAC,KAAK,CAAC,sBAAsB,OAAO,EAAE,CAAC,CAAC;QAC9C,CAAC;QAAC,MAAM,CAAC,CAAC,sCAAsC,CAAC,CAAC;IACpD,CAAC;IAED,OAAO,CAAC,MAAgB,EAAE,KAAoB;QAC5C,IAAI,CAAC;YACH,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;YACrB,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;YACnB,IAAI,CAAC,IAAI,GAAG,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,IAAI,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC;YACnG,IAAI,CAAC,SAAS,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,IAAI,CAAC,GAAG,EAAE,CAAC,IAAI,IAAI,EAAE,CAAC,CAAC,EAAE,CAAC;YAC3D,IAAI,CAAC,QAAQ,GAAG,SAAS,CAAC,EAAE,GAAG,IAAI,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,KAAK,EAAE,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC,CAAC;QAC1F,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QAAC,CAAC;IAC1C,CAAC;IAED,OAAO,CAAC,KAAc;QACpB,IAAI,CAAC;YAAC,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAAC,CAAC;QACtC,OAAO,MAAM,EAAE,CAAC;YAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QAAC,CAAC;IAC1C,CAAC;IAED,SAAS,CAAC,KAAa,EAAE,MAAgB,EAAE,IAAkH;QAC3J,IAAI,CAAC;YACH,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC;YAC5C,IAAI,CAAC,OAAO,IAAI,CAAC,OAAO,KAAK,IAAI,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC;gBAAE,OAAO;YAC7D,IAAI,CAAC,CAAC,WAAW,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,EAAE,SAAS,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC;gBAAE,OAAO;YAC1F,MAAM,KAAK,GAAG,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC;YACnD,IAAI,KAAK,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,IAAI,GAAG,CAAC;gBAAE,OAAO;YAC3D,IAAI,KAAK,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;YACpC,OAAO,MAAM,IAAI,KAAK,GAAG,CAAC,EAAE,CAAC;gBAAC,KAAK,IAAI,CAAC,CAAC;gBAAC,MAAM,GAAG,MAAM,CAAC,MAAuB,CAAC;YAAC,CAAC;YACpF,KAAK,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,QAAQ,CAAC,IAAI,CAAC,KAAK,EAAE,EAAE,WAAW,EAAE,IAAI,CAAC,IAAI,EAAE,GAAG,EAAE,IAAI,CAAC,IAAI,CAAC,GAAG,IAAI,OAAO,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,aAAa,EAAE,IAAI,CAAC,OAAO,CAAC,aAAa,EAAE,CAAC,EAAE,QAAQ,EAAE,IAAI,CAAC,QAAQ,EAAE,UAAU,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,QAAQ,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;YACxR,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;QACxC,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QAAC,CAAC;IAC1C,CAAC;IAEO,KAAK,CAAC,aAAa,CAAC,KAAe;QACzC,MAAM,MAAM,GAAG,IAAI,OAAO,EAAwB,CAAC;QACnD,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC;QAC5C,IAAI,CAAC,OAAO,IAAI,CAAC,OAAO,KAAK,IAAI,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI;YAAE,OAAO,MAAM,CAAC;QACnF,IAAI,KAAK,GAAG,CAAC,CAAC;QACd,MAAM,MAAM,GAAG,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,QAAQ,IAAI,EAAE,CAAC,QAAQ,CAAC;QACrD,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,IAAI,IAAI,EAAE,CAAC,IAAI,CAAC;QAC3C,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;YACzB,IAAI,IAAI,CAAC,OAAO,EAAE,KAAK,YAAY,IAAI,IAAI,CAAC,OAAO,EAAE,KAAK,OAAO;gBAAE,SAAS;YAC5E,KAAK,MAAM,OAAO,IAAI,IAAI,CAAC,OAAO;gBAAE,KAAK,MAAM,UAAU,IAAI,OAAO,CAAC,WAAW,EAAE,CAAC;oBACjF,IAAI,CAAC,UAAU,CAAC,IAAI,IAAI,CAAC,CAAC,WAAW,EAAE,YAAY,CAAC,CAAC,QAAQ,CAAC,UAAU,CAAC,WAAW,CAAC,IAAI,WAAW,CAAC,IAAI,CAAC,IAAI,EAAE,UAAU,CAAC,IAAI,CAAC,KAAK,IAAI;wBAAE,SAAS;oBACpJ,IAAI,CAAC;wBACH,MAAM,IAAI,GAAG,CAAC,MAAM,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC;wBAChD,IAAI,IAAI,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,aAAa,IAAI,MAAM,CAAC,IAAI,KAAK,GAAG,IAAI,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,gBAAgB,IAAI,OAAO,CAAC;4BAAE,SAAS;wBACzH,MAAM,KAAK,GAAG,MAAM,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;wBAC5C,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,aAAa,IAAI,MAAM,CAAC,IAAI,KAAK,GAAG,KAAK,CAAC,MAAM,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,gBAAgB,IAAI,OAAO,CAAC;4BAAE,SAAS;wBACzI,MAAM,CAAC,GAAG,CAAC,UAAU,EAAE,QAAQ,UAAU,CAAC,WAAW,WAAW,KAAK,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;wBAC5F,KAAK,IAAI,KAAK,CAAC,MAAM,CAAC;oBACxB,CAAC;oBAAC,MAAM,CAAC,CAAC,+CAA+C,CAAC,CAAC;gBAC7D,CAAC;QACH,CAAC;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;IAEO,KAAK,CAAC,UAAU,CAAC,GAAoC,EAAE,KAAmB,EAAE,SAAiB;QACnG,MAAM,SAAS,GAAG,MAAM,KAAK,CAAC,aAAa,CAAC,EAAE,KAAK,EAAE,IAAI,CAAC,OAAO,CAAC,YAAY,EAAE,CAAC,CAAC;QAClF,MAAM,OAAO,GAAG,SAAS,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,KAAK,GAAG,CAAC,KAAK,CAAC,IAAI,EAAE,aAAa,EAAE,CAAU,EAAE,KAAK,EAAE,GAAG,CAAC,KAAK,EAAE,KAAK,EAAE,GAAG,CAAC,KAAK,EAAE,SAAS,EAAE,GAAG,CAAC,SAAS,EAAE,UAAU,EAAE,GAAG,CAAC,UAAU,EAAE,MAAM,EAAE,GAAG,CAAC,MAAM,EAAE,QAAQ,EAAE,GAAG,CAAC,QAAQ,EAAE,OAAO,EAAE,GAAG,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,MAAM,EAAE,UAAU,EAAE,GAAG,CAAC,GAAG,CAAC,EAAE,EAAE,QAAQ,IAAI,IAAI,EAAE,QAAQ,EAAE,GAAG,CAAC,GAAG,CAAC,EAAE,EAAE,QAAQ,IAAI,IAAI,EAAE,CAAC;QAC1Y,MAAM,QAAQ,GAAG,WAAW,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;QACjD,MAAM,cAAc,GAAG,QAAQ,CAAC,CAAC,CAAC,MAAM,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;QAC7E,MAAM,IAAI,GAAG,MAAM,KAAK,CAAC,QAAQ,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC;QACjF,MAAM,sBAAsB,GAAG,MAAM,2BAA2B,CAAC,GAAG,EAAE,IAAI,CAAC,IAAK,EAAE,EAAE,QAAQ,EAAE,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,QAAQ,IAAI,EAAE,CAAC,QAAQ,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,IAAI,IAAI,EAAE,CAAC,IAAI,EAAE,CAAC,CAAC;QAC5K,MAAM,KAAK,GAAG,gBAAgB,CAAC,EAAE,GAAG,EAAE,SAAS,EAAE,QAAQ,EAAE,UAAU,EAAE,WAAW,CAAC,GAAG,EAAE,cAAc,CAAC,EAAE,KAAK,EAAE,YAAY,CAAC,IAAI,CAAC,EAAE,UAAU,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,KAAK,GAAG,CAAC,KAAK,CAAC,EAAE,WAAW,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,IAAI,CAAC,GAAG,EAAE,CAAC,IAAI,IAAI,EAAE,CAAC,CAAC,EAAE,CAAC,WAAW,EAAE,EAAE,YAAY,EAAE,IAAI,CAAC,OAAO,CAAC,YAAY,EAAE,sBAAsB,EAAE,CAAC,CAAC;QAC1U,MAAM,MAAM,GAAG,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,QAAQ,EAAE,YAAY,CAAC,CAAC;QAC5D,MAAM,KAAK,GAAG,IAAI,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,CAAC;QACjC,MAAM,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;QAC7D,MAAM,KAAK,CAAC,SAAS,CAAC,GAAG,MAAM,MAAM,EAAE,YAAY,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC,CAAC;QACpE,MAAM,KAAK,CAAC,MAAM,CAAC,GAAG,MAAM,MAAM,EAAE,MAAM,CAAC,CAAC;IAC9C,CAAC;IAED,KAAK,CAAC,KAAK,CAAC,MAAkB;QAC5B,IAAI,CAAC;YACH,IAAI,CAAC,IAAI,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,KAAK,IAAI,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,SAAS,IAAI,CAAC,IAAI,CAAC,QAAQ;gBAAE,MAAM,IAAI,KAAK,CAAC,8BAA8B,CAAC,CAAC;YACpI,MAAM,OAAO,GAAG,MAAM,CAAC,SAAS,IAAI,MAAM,CAAC,QAAQ,KAAK,SAAS;gBAC/D,CAAC,CAAC,IAAI,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,OAAO,EAAE,GAAG,MAAM,CAAC,QAAQ,CAAC;gBACxD,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,IAAI,CAAC,GAAG,EAAE,CAAC,IAAI,IAAI,EAAE,CAAC,CAAC,EAAE,CAAC;YAC9C,MAAM,SAAS,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;YAClE,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC;YACpC,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;YAClD,MAAM,KAAK,GAAG,cAAc,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,KAAK,EAAE,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,SAAS,EAAE,IAAI,CAAC,SAAS,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,EAAE,EAAE,EAAE,EAAE,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,GAAG,EAAE,IAAI,CAAC,QAAQ,CAAC,GAAG,EAAE,OAAO,EAAE,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE,iBAAiB,EAAE,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,OAAO,EAAE,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,EAAE,YAAY,EAAE,IAAI,CAAC,YAAY,EAAE,GAAG,EAAE,EAAE,WAAW,EAAE,IAAI,CAAC,IAAI,EAAE,GAAG,EAAE,IAAI,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,cAAc,EAAE,IAAI,CAAC,OAAO,CAAC,cAAc,EAAE,aAAa,EAAE,IAAI,CAAC,OAAO,CAAC,aAAa,EAAE,cAAc,EAAE,IAAI,CAAC,OAAO,CAAC,cAAc,EAAE,QAAQ,EAAE,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,eAAe,EAAE,IAAI,CAAC,OAAO,CAAC,eAAe,EAAE,aAAa,EAAE,IAAI,CAAC,aAAa,EAAE,SAAS,EAAE,EAAE,CAAC,CAAC;YAC7vB,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,IAAI,IAAI,aAAa,CAAC,SAAS,EAAE,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;YAClF,IAAI,IAAI,CAAC,OAAO,CAAC,SAAS,IAAI,CAAC,CAAC,KAAK,CAAC,KAAK,IAAI,KAAK,CAAC,KAAK,CAAC,KAAK,KAAK,CAAC,CAAC,EAAE,CAAC;gBACxE,MAAM,EAAE,GAAG,EAAE,GAAG,WAAW,CAAC,CAAC,KAAK,CAAC,EAAE,EAAE,SAAS,EAAE,KAAK,CAAC,IAAI,CAAC,IAAI,EAAE,SAAS,CAAC,EAAE,CAAC,CAAC;gBACjF,MAAM,KAAK,GAAG,IAAI,CAAC,IAAI,CAAC,YAAY,IAAI,IAAI,gBAAgB,CAAC,SAAS,CAAC,CAAC;gBACxE,MAAM,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;gBACzB,IAAI,IAAI,CAAC,OAAO,CAAC,UAAU;oBAAE,MAAM,IAAI,CAAC,UAAU,CAAC,GAAG,EAAE,KAAK,EAAE,SAAS,CAAC,CAAC;YAC5E,CAAC;YACD,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC;gBACxB,MAAM,KAAK,GAAG,CAAC,OAAe,EAAU,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,KAAK,OAAO,CAAC,CAAC,MAAM,CAAC;gBACzG,MAAM,UAAU,GAAG,IAAI,CAAC,OAAO,CAAC,SAAS,IAAI,IAAI,CAAC,OAAO,CAAC,UAAU,IAAI,CAAC,CAAC,KAAK,CAAC,KAAK,IAAI,KAAK,CAAC,KAAK,CAAC,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,QAAQ,EAAE,YAAY,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;gBACjM,IAAI,CAAC,KAAK,CAAC,iBAAiB,KAAK,CAAC,KAAK,KAAK,KAAK,CAAC,UAAU,CAAC,YAAY,KAAK,CAAC,YAAY,CAAC,YAAY,KAAK,CAAC,OAAO,CAAC,WAAW,KAAK,CAAC,SAAS,CAAC,WAAW,UAAU,EAAE,CAAC,CAAC;YAC5K,CAAC;QACH,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QAAC,CAAC;IAC1C,CAAC;CACF"}

package/dist/sanitize.d.ts

@@ -0,0 +1,11 @@
+export type RedactPattern = string | RegExp;
+export interface SanitizeOptions {
+    projectRoot?: string;
+    env?: Record<string, string | undefined>;
+    redact?: RedactPattern[];
+    maxTextLength?: number;
+}
+/** Sanitize diagnostic text by stripping terminal codes, paths, secrets, and excess length. */
+export declare function sanitize(text: string, options?: SanitizeOptions): string;
+/** Remove credentials embedded in a URL. */
+export declare function stripUrlUserinfo(value: string): string;

package/dist/sanitize.js

@@ -0,0 +1,33 @@
+// eslint-disable-next-line no-control-regex
+const ANSI = /\u001b\[[0-9;]*[A-Za-z]/g;
+const SECRET_NAME = /(TOKEN|SECRET|PASSWORD|PASSWD|API[_-]?KEY|PRIVATE[_-]?KEY|CREDENTIAL)/i;
+function redactValue(text, value) {
+    return value.length >= 8 ? text.split(value).join('[redacted]') : text;
+}
+/** Sanitize diagnostic text by stripping terminal codes, paths, secrets, and excess length. */
+export function sanitize(text, options = {}) {
+    let result = text.replace(ANSI, '');
+    if (options.projectRoot) {
+        const root = options.projectRoot.replace(/[\\/]$/, '');
+        result = result.split(`${root}/`).join('').split(`${root}\\`).join('');
+    }
+    const values = Object.entries(options.env ?? {}).filter(([name, value]) => SECRET_NAME.test(name) && value && value.length >= 8).map(([, value]) => value).sort((a, b) => b.length - a.length);
+    for (const value of values)
+        result = redactValue(result, value);
+    for (const pattern of options.redact ?? []) {
+        const source = typeof pattern === 'string'
+            ? new RegExp(pattern.replace(/[.*+?^${}()|[\]\\]/g, '\\$&'), 'g')
+            : new RegExp(pattern.source, pattern.flags.includes('g') ? pattern.flags : `${pattern.flags}g`);
+        result = result.replace(source, '[redacted]');
+    }
+    const max = options.maxTextLength ?? Infinity;
+    if (result.length <= max)
+        return result;
+    const removed = result.length - max;
+    return `${result.slice(0, max)}… [truncated ${removed} chars]`;
+}
+/** Remove credentials embedded in a URL. */
+export function stripUrlUserinfo(value) {
+    return value.replace(/(https?:\/\/)(?:[^/@]+)@/gi, '$1');
+}
+//# sourceMappingURL=sanitize.js.map

package/dist/sanitize.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sanitize.js","sourceRoot":"","sources":["../src/sanitize.ts"],"names":[],"mappings":"AAAA,4CAA4C;AAC5C,MAAM,IAAI,GAAG,0BAA0B,CAAC;AACxC,MAAM,WAAW,GAAG,wEAAwE,CAAC;AAW7F,SAAS,WAAW,CAAC,IAAY,EAAE,KAAa;IAC9C,OAAO,KAAK,CAAC,MAAM,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;AACzE,CAAC;AAED,+FAA+F;AAC/F,MAAM,UAAU,QAAQ,CAAC,IAAY,EAAE,UAA2B,EAAE;IAClE,IAAI,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;IACpC,IAAI,OAAO,CAAC,WAAW,EAAE,CAAC;QACxB,MAAM,IAAI,GAAG,OAAO,CAAC,WAAW,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;QACvD,MAAM,GAAG,MAAM,CAAC,KAAK,CAAC,GAAG,IAAI,GAAG,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,KAAK,CAAC,GAAG,IAAI,IAAI,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACzE,CAAC;IACD,MAAM,MAAM,GAAG,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,KAAK,IAAI,KAAK,CAAC,MAAM,IAAI,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,KAAe,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,MAAM,CAAC,CAAC;IACzM,KAAK,MAAM,KAAK,IAAI,MAAM;QAAE,MAAM,GAAG,WAAW,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;IAChE,KAAK,MAAM,OAAO,IAAI,OAAO,CAAC,MAAM,IAAI,EAAE,EAAE,CAAC;QAC3C,MAAM,MAAM,GAAG,OAAO,OAAO,KAAK,QAAQ;YACxC,CAAC,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,qBAAqB,EAAE,MAAM,CAAC,EAAE,GAAG,CAAC;YACjE,CAAC,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,EAAE,OAAO,CAAC,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,KAAK,GAAG,CAAC,CAAC;QAClG,MAAM,GAAG,MAAM,CAAC,OAAO,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC;IAChD,CAAC;IACD,MAAM,GAAG,GAAG,OAAO,CAAC,aAAa,IAAI,QAAQ,CAAC;IAC9C,IAAI,MAAM,CAAC,MAAM,IAAI,GAAG;QAAE,OAAO,MAAM,CAAC;IACxC,MAAM,OAAO,GAAG,MAAM,CAAC,MAAM,GAAG,GAAG,CAAC;IACpC,OAAO,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,GAAG,CAAC,gBAAgB,OAAO,SAAS,CAAC;AACjE,CAAC;AAED,4CAA4C;AAC5C,MAAM,UAAU,gBAAgB,CAAC,KAAa;IAC5C,OAAO,KAAK,CAAC,OAAO,CAAC,4BAA4B,EAAE,IAAI,CAAC,CAAC;AAC3D,CAAC"}