@descent-vtt/spec-guard 0.7.0 → 0.9.0

package/dist/watch.js

@@ -0,0 +1,321 @@
+/**
+ * `spec-guard --watch`: the same report, again, whenever the tree changes.
+ * ADR-0014.
+ *
+ * Two parts. A session answers "what does a run say now" and re-executes a
+ * rule only when its resolved form or something it read has changed; what may
+ * be reused, and why, is in facts.ts and memo.ts. The scheduler around it turns
+ * a watcher's events into batches, never runs two at once, redraws the terminal,
+ * and stops on Ctrl+C.
+ *
+ * The session is held to a fresh run of the same tree by
+ * tests/watch-equivalence.test.ts, and nothing here is trusted beyond that.
+ */
+import path from 'node:path';
+import { createCachedEngine, createJavaScriptEngine } from './engine.js';
+import { createFactCache } from './facts.js';
+import { createImportIndex } from './imports.js';
+import { nodeIo } from './io.js';
+import { createMemo } from './memo.js';
+import { formatReport } from './reporter.js';
+import { createScopeProbe, DEFAULT_CONCURRENCY, DEFAULT_MAX_SNIPPETS, executeAssertion, planRun, reportRun, } from './runner.js';
+import { readSpecs } from './specs.js';
+import { createTreeIndex } from './structure.js';
+/**
+ * A rule's own caches, over its own door.
+ *
+ * Never shared between rules. Each is keyed by path, which makes it a fact
+ * under another name: a second rule served from the first one's walk would skip
+ * the reads, and with them the record of what it depends on.
+ */
+export function ruleCaches(root, door, memo) {
+    const scanner = createJavaScriptEngine(door, memo);
+    return {
+        engine: createCachedEngine(scanner, scanner),
+        imports: createImportIndex(door, memo),
+        hasFiles: createScopeProbe(door),
+        tree: createTreeIndex(root, door),
+    };
+}
+/**
+ * What decides a rule's result besides the tree: its resolved form, and the run
+ * options its execution reads. Two rules with equal identities executed over the
+ * same facts give the same result, which is the whole of what reuse relies on.
+ *
+ * Only the options execution reads. The ones resolution reads - which specs are
+ * excluded, which directories skipped - are already in the resolved form, as the
+ * spec files it leaves out and the scope it walks, and are held there, where a
+ * rule is changed by them, rather than beside it.
+ */
+export function identity(assertion, run) {
+    const { allowMissingTargets, strictTargets, allowEmptyScope, maxSnippets } = run;
+    return JSON.stringify([assertion, allowMissingTargets, strictTargets, allowEmptyScope, maxSnippets], (_key, value) => value instanceof Set ? [...value] : value instanceof Map ? [...value] : value);
+}
+export function createSession(options) {
+    const root = path.resolve(options.root);
+    const facts = createFactCache(root, options.io ?? nodeIo, options.policy);
+    const memo = options.memo ?? createMemo();
+    const identify = options.identify ?? identity;
+    const cachesFor = options.caches ?? ruleCaches;
+    let executed = new Map();
+    /** Facts the settings and the specs were read from. */
+    let planned = new Set();
+    /** Facts whose value changed since the last run. */
+    let changed = new Set();
+    const used = (key) => planned.has(key) || [...executed.values()].some((entry) => entry.reads.has(key));
+    async function execute(assertion, run) {
+        const reads = new Set();
+        const door = facts.view(reads);
+        const result = await executeAssertion(assertion, {
+            ...cachesFor(root, door, memo),
+            root,
+            io: door,
+            allowMissingTargets: run.allowMissingTargets ?? false,
+            strictTargets: run.strictTargets ?? false,
+            allowEmptyScope: run.allowEmptyScope ?? false,
+            maxSnippets: run.maxSnippets ?? DEFAULT_MAX_SNIPPETS,
+        });
+        return { result, reads };
+    }
+    return {
+        get facts() {
+            return facts.size;
+        },
+        async run() {
+            const startedAt = performance.now();
+            const reads = new Set();
+            const door = facts.view(reads);
+            const settings = await options.settings(door);
+            const plan = planRun(await readSpecs(settings.patterns, root, door, memo), root, settings.run);
+            planned = reads;
+            const before = executed;
+            const dirty = changed;
+            changed = new Set();
+            const next = new Map();
+            const results = [];
+            let count = 0;
+            const identities = plan.assertions.map((assertion) => identify(assertion, settings.run));
+            let cursor = 0;
+            const worker = async () => {
+                while (cursor < plan.assertions.length) {
+                    const index = cursor++;
+                    const key = identities[index];
+                    const last = before.get(key);
+                    let entry;
+                    if (last !== undefined && ![...last.reads].some((read) => dirty.has(read))) {
+                        entry = last;
+                    }
+                    else {
+                        entry = await execute(plan.assertions[index], settings.run);
+                        count += 1;
+                    }
+                    next.set(key, entry);
+                    results[index] = entry.result;
+                }
+            };
+            const workers = Math.max(1, Math.min(settings.run.concurrency ?? DEFAULT_CONCURRENCY, plan.assertions.length));
+            await Promise.all(Array.from({ length: workers }, worker));
+            executed = next;
+            memo.sweep();
+            const report = reportRun(plan, results, { name: 'javascript', fallbacks: [] }, startedAt);
+            return {
+                report: { ...report, config: settings.config },
+                maxSnippets: settings.run.maxSnippets ?? DEFAULT_MAX_SNIPPETS,
+                executed: count,
+            };
+        },
+        async observe(events) {
+            const found = await facts.refresh(facts.evict(events), used);
+            for (const key of found)
+                changed.add(key);
+            return found.size;
+        },
+        forget() {
+            facts.evictAll();
+            executed = new Map();
+            changed = new Set();
+        },
+    };
+}
+/* ---------------------------------------------------------------- scheduler */
+/** How long a batch waits for quiet after its last event. */
+export const QUIET_MS = 50;
+/** How long a batch waits after its first event, however noisy the tree stays. */
+export const MAX_WAIT_MS = 500;
+/** The exit code of an interrupted command, as a shell reports one: 128 + SIGINT. */
+export const EXIT_INTERRUPTED = 130;
+export const systemClock = {
+    now: () => Date.now(),
+    setTimeout: (callback, ms) => setTimeout(callback, ms),
+    clearTimeout: (handle) => clearTimeout(handle),
+};
+const CLEAR_SCREEN = '\x1b[2J\x1b[3J\x1b[H';
+/** Up one line, and clear it: the status line a quiet batch rewrites. */
+const REWRITE_LINE = '\x1b[1A\x1b[2K';
+function plural(count, one, many) {
+    return `${count} ${count === 1 ? one : many}`;
+}
+/** A report stripped of how long things took, to tell a new report from the last. */
+function signature(report) {
+    return JSON.stringify(report, (key, value) => (key === 'durationMs' ? undefined : value));
+}
+/** Why a first run cannot become a session, or null when it can. */
+function outsideRoot(report) {
+    const outside = report.specFiles.filter((file) => path.isAbsolute(file) || file === '..' || file.startsWith('../'));
+    return outside.length === 0
+        ? null
+        : `--watch watches ${report.root}, and ${outside.length === 1 ? 'this spec is' : 'these specs are'} outside it: ${outside.join(', ')}`;
+}
+/**
+ * Runs a session until it is interrupted, and resolves to the exit code.
+ *
+ * 130 when stopped, since a session is neither a pass nor a failure. 2 when it
+ * cannot start or its watcher fails, including when the root disappears.
+ */
+export async function runWatch(options) {
+    const clock = options.clock ?? systemClock;
+    const { session, write } = options;
+    let finish = () => { };
+    const finished = new Promise((resolve) => {
+        finish = resolve;
+    });
+    let stopped = false;
+    // From the start: the first run begins before anything can be queued, and a
+    // batch must not begin beside it.
+    let running = true;
+    let everything = false;
+    const pending = [];
+    let firstQueuedAt = 0;
+    let timer;
+    let lastSignature = null;
+    const status = (run, changes, startedAt) => [
+        `watching ${plural(run.report.summary.specs, 'spec', 'specs')}`,
+        changes,
+        `${run.executed} of ${plural(run.report.summary.total, 'rule', 'rules')} ${changes === 'first run' ? 'executed' : 're-executed'}`,
+        `${Math.round(clock.now() - startedAt)} ms`,
+        'Enter re-runs everything, Ctrl+C stops',
+    ].join(' · ');
+    const heading = () => (options.isTTY ? CLEAR_SCREEN : `--- ${new Date(clock.now()).toTimeString().slice(0, 8)} ---\n`);
+    const render = (run, line) => {
+        const current = signature(run.report);
+        if (current === lastSignature) {
+            write(`${options.isTTY ? REWRITE_LINE : ''}${line}\n`);
+            return;
+        }
+        lastSignature = current;
+        const body = run.report.summary.specs === 0
+            ? 'spec-guard: no spec files matched, watching for one to appear'
+            : formatReport(run.report, options.reporter, run.maxSnippets);
+        write(`${heading()}${body}\n\n${line}\n`);
+    };
+    const stop = (code) => {
+        if (stopped)
+            return;
+        stopped = true;
+        clock.clearTimeout(timer);
+        watcher?.close();
+        unregisterInterrupt();
+        unregisterLine?.();
+        finish(code);
+    };
+    // Reached only from the timer `schedule` sets, which it sets only while nothing
+    // runs and the session has not stopped, and which stopping clears.
+    const batch = async () => {
+        running = true;
+        const events = pending.splice(0);
+        const rerunAll = everything;
+        everything = false;
+        const startedAt = clock.now();
+        try {
+            if (rerunAll)
+                session.forget();
+            else
+                await session.observe(events);
+            const run = await session.run();
+            if (stopped)
+                return;
+            // A configuration edited to name specs outside the root is refused the
+            // way a first run refuses it, without ending a session someone is using.
+            const outside = outsideRoot(run.report);
+            if (outside !== null)
+                throw new Error(outside);
+            const changes = rerunAll ? 'every rule, on request' : plural(new Set(events.map((event) => event.filename)).size, 'change', 'changes');
+            render(run, status(run, changes, startedAt));
+        }
+        catch (error) {
+            if (stopped)
+                return;
+            lastSignature = null;
+            write(`${heading()}spec-guard: ${error instanceof Error ? error.message : String(error)}\n\nwatching · waiting for a change · Ctrl+C stops\n`);
+        }
+        finally {
+            running = false;
+        }
+        schedule();
+    };
+    /** Sets the timer for the next batch, if there is anything for one to do and it may start. */
+    const schedule = () => {
+        if (stopped || running || (pending.length === 0 && !everything))
+            return;
+        clock.clearTimeout(timer);
+        const waited = clock.now() - firstQueuedAt;
+        timer = clock.setTimeout(() => void batch(), everything ? 0 : Math.max(0, Math.min(QUIET_MS, MAX_WAIT_MS - waited)));
+    };
+    const queue = (event) => {
+        if (pending.length === 0)
+            firstQueuedAt = clock.now();
+        pending.push(event);
+        schedule();
+    };
+    let watcher;
+    const unregisterInterrupt = options.onInterrupt(() => stop(EXIT_INTERRUPTED));
+    const unregisterLine = options.onLine?.(() => {
+        everything = true;
+        schedule();
+    });
+    const cannot = (message) => {
+        write(`spec-guard: ${message}\n`);
+        stop(2);
+        return 2;
+    };
+    // The watcher first, so nothing that changes during the first run is missed.
+    try {
+        watcher = options.watch(queue, (error) => {
+            if (stopped)
+                return;
+            write(`spec-guard: the watch on ${options.root} failed: ${describeWatchError(error)}\n`);
+            stop(2);
+        });
+    }
+    catch (error) {
+        return cannot(`cannot watch ${options.root}: ${describeWatchError(error)}`);
+    }
+    const startedAt = clock.now();
+    try {
+        const first = await session.run();
+        if (stopped)
+            return finished;
+        const outside = outsideRoot(first.report);
+        if (outside !== null)
+            return cannot(outside);
+        render(first, status(first, 'first run', startedAt));
+    }
+    catch (error) {
+        if (stopped)
+            return finished;
+        return cannot(error instanceof Error ? error.message : String(error));
+    }
+    finally {
+        running = false;
+    }
+    schedule();
+    return finished;
+}
+/** A watcher's error, with what to do about the one a person can fix. */
+export function describeWatchError(error) {
+    const code = error.code;
+    return code === 'ENOSPC'
+        ? `${error.message} (the system's limit on watched directories was reached; raise fs.inotify.max_user_watches)`
+        : error.message;
+}
+//# sourceMappingURL=watch.js.map

package/dist/watch.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"watch.js","sourceRoot":"","sources":["../src/watch.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AAEH,OAAO,IAAI,MAAM,WAAW,CAAC;AAE7B,OAAO,EAAE,kBAAkB,EAAE,sBAAsB,EAAE,MAAM,aAAa,CAAC;AACzE,OAAO,EAAE,eAAe,EAAkD,MAAM,YAAY,CAAC;AAC7F,OAAO,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAC;AACjD,OAAO,EAAE,MAAM,EAA6B,MAAM,SAAS,CAAC;AAC5D,OAAO,EAAE,UAAU,EAA+B,MAAM,WAAW,CAAC;AACpE,OAAO,EAAE,YAAY,EAAwB,MAAM,eAAe,CAAC;AACnE,OAAO,EACL,gBAAgB,EAChB,mBAAmB,EACnB,oBAAoB,EACpB,gBAAgB,EAChB,OAAO,EACP,SAAS,GAIV,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AACvC,OAAO,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAC;AA+CjD;;;;;;GAMG;AACH,MAAM,UAAU,UAAU,CAAC,IAAY,EAAE,IAAQ,EAAE,IAAU;IAC3D,MAAM,OAAO,GAAG,sBAAsB,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IACnD,OAAO;QACL,MAAM,EAAE,kBAAkB,CAAC,OAAO,EAAE,OAAO,CAAC;QAC5C,OAAO,EAAE,iBAAiB,CAAC,IAAI,EAAE,IAAI,CAAC;QACtC,QAAQ,EAAE,gBAAgB,CAAC,IAAI,CAAC;QAChC,IAAI,EAAE,eAAe,CAAC,IAAI,EAAE,IAAI,CAAC;KAClC,CAAC;AACJ,CAAC;AA2BD;;;;;;;;;GASG;AACH,MAAM,UAAU,QAAQ,CAAC,SAAoB,EAAE,GAAsB;IACnE,MAAM,EAAE,mBAAmB,EAAE,aAAa,EAAE,eAAe,EAAE,WAAW,EAAE,GAAG,GAAG,CAAC;IACjF,OAAO,IAAI,CAAC,SAAS,CAAC,CAAC,SAAS,EAAE,mBAAmB,EAAE,aAAa,EAAE,eAAe,EAAE,WAAW,CAAC,EAAE,CAAC,IAAI,EAAE,KAAc,EAAE,EAAE,CAC5H,KAAK,YAAY,GAAG,CAAC,CAAC,CAAC,CAAC,GAAI,KAAqB,CAAC,CAAC,CAAC,CAAC,KAAK,YAAY,GAAG,CAAC,CAAC,CAAC,CAAC,GAAI,KAA8B,CAAC,CAAC,CAAC,CAAC,KAAK,CACzH,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,aAAa,CAAC,OAAuB;IACnD,MAAM,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IACxC,MAAM,KAAK,GAAG,eAAe,CAAC,IAAI,EAAE,OAAO,CAAC,EAAE,IAAI,MAAM,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC;IAC1E,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,IAAI,UAAU,EAAE,CAAC;IAC1C,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,IAAI,QAAQ,CAAC;IAC9C,MAAM,SAAS,GAAG,OAAO,CAAC,MAAM,IAAI,UAAU,CAAC;IAC/C,IAAI,QAAQ,GAAG,IAAI,GAAG,EAAoB,CAAC;IAC3C,uDAAuD;IACvD,IAAI,OAAO,GAAG,IAAI,GAAG,EAAW,CAAC;IACjC,oDAAoD;IACpD,IAAI,OAAO,GAAG,IAAI,GAAG,EAAW,CAAC;IAEjC,MAAM,IAAI,GAAG,CAAC,GAAY,EAAW,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC;IAEzH,KAAK,UAAU,OAAO,CAAC,SAAoB,EAAE,GAAsB;QACjE,MAAM,KAAK,GAAG,IAAI,GAAG,EAAW,CAAC;QACjC,MAAM,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAC/B,MAAM,MAAM,GAAG,MAAM,gBAAgB,CAAC,SAAS,EAAE;YAC/C,GAAG,SAAS,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC;YAC9B,IAAI;YACJ,EAAE,EAAE,IAAI;YACR,mBAAmB,EAAE,GAAG,CAAC,mBAAmB,IAAI,KAAK;YACrD,aAAa,EAAE,GAAG,CAAC,aAAa,IAAI,KAAK;YACzC,eAAe,EAAE,GAAG,CAAC,eAAe,IAAI,KAAK;YAC7C,WAAW,EAAE,GAAG,CAAC,WAAW,IAAI,oBAAoB;SACrD,CAAC,CAAC;QACH,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC;IAC3B,CAAC;IAED,OAAO;QACL,IAAI,KAAK;YACP,OAAO,KAAK,CAAC,IAAI,CAAC;QACpB,CAAC;QAED,KAAK,CAAC,GAAG;YACP,MAAM,SAAS,GAAG,WAAW,CAAC,GAAG,EAAE,CAAC;YACpC,MAAM,KAAK,GAAG,IAAI,GAAG,EAAW,CAAC;YACjC,MAAM,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YAC/B,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YAC9C,MAAM,IAAI,GAAG,OAAO,CAAC,MAAM,SAAS,CAAC,QAAQ,CAAC,QAAQ,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,EAAE,IAAI,EAAE,QAAQ,CAAC,GAAG,CAAC,CAAC;YAC/F,OAAO,GAAG,KAAK,CAAC;YAEhB,MAAM,MAAM,GAAG,QAAQ,CAAC;YACxB,MAAM,KAAK,GAAG,OAAO,CAAC;YACtB,OAAO,GAAG,IAAI,GAAG,EAAE,CAAC;YACpB,MAAM,IAAI,GAAG,IAAI,GAAG,EAAoB,CAAC;YACzC,MAAM,OAAO,GAAsB,EAAE,CAAC;YACtC,IAAI,KAAK,GAAG,CAAC,CAAC;YAEd,MAAM,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,QAAQ,CAAC,SAAS,EAAE,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC;YACzF,IAAI,MAAM,GAAG,CAAC,CAAC;YACf,MAAM,MAAM,GAAG,KAAK,IAAmB,EAAE;gBACvC,OAAO,MAAM,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE,CAAC;oBACvC,MAAM,KAAK,GAAG,MAAM,EAAE,CAAC;oBACvB,MAAM,GAAG,GAAG,UAAU,CAAC,KAAK,CAAW,CAAC;oBACxC,MAAM,IAAI,GAAG,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;oBAC7B,IAAI,KAAe,CAAC;oBACpB,IAAI,IAAI,KAAK,SAAS,IAAI,CAAC,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC;wBAC3E,KAAK,GAAG,IAAI,CAAC;oBACf,CAAC;yBAAM,CAAC;wBACN,KAAK,GAAG,MAAM,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,KAAK,CAAc,EAAE,QAAQ,CAAC,GAAG,CAAC,CAAC;wBACzE,KAAK,IAAI,CAAC,CAAC;oBACb,CAAC;oBACD,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;oBACrB,OAAO,CAAC,KAAK,CAAC,GAAG,KAAK,CAAC,MAAM,CAAC;gBAChC,CAAC;YACH,CAAC,CAAC;YACF,MAAM,OAAO,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,WAAW,IAAI,mBAAmB,EAAE,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC;YAC/G,MAAM,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,OAAO,EAAE,EAAE,MAAM,CAAC,CAAC,CAAC;YAE3D,QAAQ,GAAG,IAAI,CAAC;YAChB,IAAI,CAAC,KAAK,EAAE,CAAC;YACb,MAAM,MAAM,GAAG,SAAS,CAAC,IAAI,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,YAAY,EAAE,SAAS,EAAE,EAAE,EAAE,EAAE,SAAS,CAAC,CAAC;YAC1F,OAAO;gBACL,MAAM,EAAE,EAAE,GAAG,MAAM,EAAE,MAAM,EAAE,QAAQ,CAAC,MAAM,EAAE;gBAC9C,WAAW,EAAE,QAAQ,CAAC,GAAG,CAAC,WAAW,IAAI,oBAAoB;gBAC7D,QAAQ,EAAE,KAAK;aAChB,CAAC;QACJ,CAAC;QAED,KAAK,CAAC,OAAO,CAAC,MAA6B;YACzC,MAAM,KAAK,GAAG,MAAM,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,IAAI,CAAC,CAAC;YAC7D,KAAK,MAAM,GAAG,IAAI,KAAK;gBAAE,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;YAC1C,OAAO,KAAK,CAAC,IAAI,CAAC;QACpB,CAAC;QAED,MAAM;YACJ,KAAK,CAAC,QAAQ,EAAE,CAAC;YACjB,QAAQ,GAAG,IAAI,GAAG,EAAE,CAAC;YACrB,OAAO,GAAG,IAAI,GAAG,EAAE,CAAC;QACtB,CAAC;KACF,CAAC;AACJ,CAAC;AAED,gFAAgF;AAEhF,6DAA6D;AAC7D,MAAM,CAAC,MAAM,QAAQ,GAAG,EAAE,CAAC;AAC3B,kFAAkF;AAClF,MAAM,CAAC,MAAM,WAAW,GAAG,GAAG,CAAC;AAC/B,qFAAqF;AACrF,MAAM,CAAC,MAAM,gBAAgB,GAAG,GAAG,CAAC;AASpC,MAAM,CAAC,MAAM,WAAW,GAAU;IAChC,GAAG,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,GAAG,EAAE;IACrB,UAAU,EAAE,CAAC,QAAQ,EAAE,EAAE,EAAE,EAAE,CAAC,UAAU,CAAC,QAAQ,EAAE,EAAE,CAAC;IACtD,YAAY,EAAE,CAAC,MAAM,EAAE,EAAE,CAAC,YAAY,CAAC,MAAuC,CAAC;CAChF,CAAC;AAmBF,MAAM,YAAY,GAAG,sBAAsB,CAAC;AAC5C,yEAAyE;AACzE,MAAM,YAAY,GAAG,gBAAgB,CAAC;AAEtC,SAAS,MAAM,CAAC,KAAa,EAAE,GAAW,EAAE,IAAY;IACtD,OAAO,GAAG,KAAK,IAAI,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;AAChD,CAAC;AAED,qFAAqF;AACrF,SAAS,SAAS,CAAC,MAAiB;IAClC,OAAO,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,KAAc,EAAE,EAAE,CAAC,CAAC,GAAG,KAAK,YAAY,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC;AACrG,CAAC;AAED,oEAAoE;AACpE,SAAS,WAAW,CAAC,MAAiB;IACpC,MAAM,OAAO,GAAG,MAAM,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,IAAI,KAAK,IAAI,IAAI,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC;IACpH,OAAO,OAAO,CAAC,MAAM,KAAK,CAAC;QACzB,CAAC,CAAC,IAAI;QACN,CAAC,CAAC,mBAAmB,MAAM,CAAC,IAAI,SAAS,OAAO,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC,iBAAiB,gBAAgB,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;AAC3I,CAAC;AAED;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,QAAQ,CAAC,OAAqB;IAClD,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,IAAI,WAAW,CAAC;IAC3C,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,GAAG,OAAO,CAAC;IACnC,IAAI,MAAM,GAA2B,GAAG,EAAE,GAAE,CAAC,CAAC;IAC9C,MAAM,QAAQ,GAAG,IAAI,OAAO,CAAS,CAAC,OAAO,EAAE,EAAE;QAC/C,MAAM,GAAG,OAAO,CAAC;IACnB,CAAC,CAAC,CAAC;IAEH,IAAI,OAAO,GAAG,KAAK,CAAC;IACpB,4EAA4E;IAC5E,kCAAkC;IAClC,IAAI,OAAO,GAAG,IAAI,CAAC;IACnB,IAAI,UAAU,GAAG,KAAK,CAAC;IACvB,MAAM,OAAO,GAAiB,EAAE,CAAC;IACjC,IAAI,aAAa,GAAG,CAAC,CAAC;IACtB,IAAI,KAAc,CAAC;IACnB,IAAI,aAAa,GAAkB,IAAI,CAAC;IAExC,MAAM,MAAM,GAAG,CAAC,GAAe,EAAE,OAAe,EAAE,SAAiB,EAAU,EAAE,CAC7E;QACE,YAAY,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,OAAO,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE;QAC/D,OAAO;QACP,GAAG,GAAG,CAAC,QAAQ,OAAO,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,OAAO,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,IAAI,OAAO,KAAK,WAAW,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,aAAa,EAAE;QACjI,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,GAAG,EAAE,GAAG,SAAS,CAAC,KAAK;QAC3C,wCAAwC;KACzC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAEhB,MAAM,OAAO,GAAG,GAAW,EAAE,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,OAAO,IAAI,IAAI,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,CAAC,YAAY,EAAE,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC;IAE/H,MAAM,MAAM,GAAG,CAAC,GAAe,EAAE,IAAY,EAAQ,EAAE;QACrD,MAAM,OAAO,GAAG,SAAS,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QACtC,IAAI,OAAO,KAAK,aAAa,EAAE,CAAC;YAC9B,KAAK,CAAC,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE,GAAG,IAAI,IAAI,CAAC,CAAC;YACvD,OAAO;QACT,CAAC;QACD,aAAa,GAAG,OAAO,CAAC;QACxB,MAAM,IAAI,GACR,GAAG,CAAC,MAAM,CAAC,OAAO,CAAC,KAAK,KAAK,CAAC;YAC5B,CAAC,CAAC,+DAA+D;YACjE,CAAC,CAAC,YAAY,CAAC,GAAG,CAAC,MAAM,EAAE,OAAO,CAAC,QAAQ,EAAE,GAAG,CAAC,WAAW,CAAC,CAAC;QAClE,KAAK,CAAC,GAAG,OAAO,EAAE,GAAG,IAAI,OAAO,IAAI,IAAI,CAAC,CAAC;IAC5C,CAAC,CAAC;IAEF,MAAM,IAAI,GAAG,CAAC,IAAY,EAAQ,EAAE;QAClC,IAAI,OAAO;YAAE,OAAO;QACpB,OAAO,GAAG,IAAI,CAAC;QACf,KAAK,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC;QAC1B,OAAO,EAAE,KAAK,EAAE,CAAC;QACjB,mBAAmB,EAAE,CAAC;QACtB,cAAc,EAAE,EAAE,CAAC;QACnB,MAAM,CAAC,IAAI,CAAC,CAAC;IACf,CAAC,CAAC;IAEF,gFAAgF;IAChF,mEAAmE;IACnE,MAAM,KAAK,GAAG,KAAK,IAAmB,EAAE;QACtC,OAAO,GAAG,IAAI,CAAC;QACf,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;QACjC,MAAM,QAAQ,GAAG,UAAU,CAAC;QAC5B,UAAU,GAAG,KAAK,CAAC;QACnB,MAAM,SAAS,GAAG,KAAK,CAAC,GAAG,EAAE,CAAC;QAC9B,IAAI,CAAC;YACH,IAAI,QAAQ;gBAAE,OAAO,CAAC,MAAM,EAAE,CAAC;;gBAC1B,MAAM,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;YACnC,MAAM,GAAG,GAAG,MAAM,OAAO,CAAC,GAAG,EAAE,CAAC;YAChC,IAAI,OAAO;gBAAE,OAAO;YACpB,uEAAuE;YACvE,yEAAyE;YACzE,MAAM,OAAO,GAAG,WAAW,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;YACxC,IAAI,OAAO,KAAK,IAAI;gBAAE,MAAM,IAAI,KAAK,CAAC,OAAO,CAAC,CAAC;YAC/C,MAAM,OAAO,GAAG,QAAQ,CAAC,CAAC,CAAC,wBAAwB,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,EAAE,QAAQ,EAAE,SAAS,CAAC,CAAC;YACvI,MAAM,CAAC,GAAG,EAAE,MAAM,CAAC,GAAG,EAAE,OAAO,EAAE,SAAS,CAAC,CAAC,CAAC;QAC/C,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,OAAO;gBAAE,OAAO;YACpB,aAAa,GAAG,IAAI,CAAC;YACrB,KAAK,CAAC,GAAG,OAAO,EAAE,eAAe,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,sDAAsD,CAAC,CAAC;QACjJ,CAAC;gBAAS,CAAC;YACT,OAAO,GAAG,KAAK,CAAC;QAClB,CAAC;QACD,QAAQ,EAAE,CAAC;IACb,CAAC,CAAC;IAEF,8FAA8F;IAC9F,MAAM,QAAQ,GAAG,GAAS,EAAE;QAC1B,IAAI,OAAO,IAAI,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC;YAAE,OAAO;QACxE,KAAK,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC;QAC1B,MAAM,MAAM,GAAG,KAAK,CAAC,GAAG,EAAE,GAAG,aAAa,CAAC;QAC3C,KAAK,GAAG,KAAK,CAAC,UAAU,CAAC,GAAG,EAAE,CAAC,KAAK,KAAK,EAAE,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,GAAG,CAAC,QAAQ,EAAE,WAAW,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC;IACvH,CAAC,CAAC;IAEF,MAAM,KAAK,GAAG,CAAC,KAAiB,EAAQ,EAAE;QACxC,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC;YAAE,aAAa,GAAG,KAAK,CAAC,GAAG,EAAE,CAAC;QACtD,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACpB,QAAQ,EAAE,CAAC;IACb,CAAC,CAAC;IAEF,IAAI,OAAgC,CAAC;IACrC,MAAM,mBAAmB,GAAG,OAAO,CAAC,WAAW,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC,CAAC;IAC9E,MAAM,cAAc,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE;QAC3C,UAAU,GAAG,IAAI,CAAC;QAClB,QAAQ,EAAE,CAAC;IACb,CAAC,CAAC,CAAC;IAEH,MAAM,MAAM,GAAG,CAAC,OAAe,EAAU,EAAE;QACzC,KAAK,CAAC,eAAe,OAAO,IAAI,CAAC,CAAC;QAClC,IAAI,CAAC,CAAC,CAAC,CAAC;QACR,OAAO,CAAC,CAAC;IACX,CAAC,CAAC;IAEF,6EAA6E;IAC7E,IAAI,CAAC;QACH,OAAO,GAAG,OAAO,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC,KAAK,EAAE,EAAE;YACvC,IAAI,OAAO;gBAAE,OAAO;YACpB,KAAK,CAAC,4BAA4B,OAAO,CAAC,IAAI,YAAY,kBAAkB,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;YACzF,IAAI,CAAC,CAAC,CAAC,CAAC;QACV,CAAC,CAAC,CAAC;IACL,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,MAAM,CAAC,gBAAgB,OAAO,CAAC,IAAI,KAAK,kBAAkB,CAAC,KAAc,CAAC,EAAE,CAAC,CAAC;IACvF,CAAC;IAED,MAAM,SAAS,GAAG,KAAK,CAAC,GAAG,EAAE,CAAC;IAC9B,IAAI,CAAC;QACH,MAAM,KAAK,GAAG,MAAM,OAAO,CAAC,GAAG,EAAE,CAAC;QAClC,IAAI,OAAO;YAAE,OAAO,QAAQ,CAAC;QAC7B,MAAM,OAAO,GAAG,WAAW,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QAC1C,IAAI,OAAO,KAAK,IAAI;YAAE,OAAO,MAAM,CAAC,OAAO,CAAC,CAAC;QAC7C,MAAM,CAAC,KAAK,EAAE,MAAM,CAAC,KAAK,EAAE,WAAW,EAAE,SAAS,CAAC,CAAC,CAAC;IACvD,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,OAAO;YAAE,OAAO,QAAQ,CAAC;QAC7B,OAAO,MAAM,CAAC,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;IACxE,CAAC;YAAS,CAAC;QACT,OAAO,GAAG,KAAK,CAAC;IAClB,CAAC;IACD,QAAQ,EAAE,CAAC;IAEX,OAAO,QAAQ,CAAC;AAClB,CAAC;AAED,yEAAyE;AACzE,MAAM,UAAU,kBAAkB,CAAC,KAAY;IAC7C,MAAM,IAAI,GAAI,KAA4B,CAAC,IAAI,CAAC;IAChD,OAAO,IAAI,KAAK,QAAQ;QACtB,CAAC,CAAC,GAAG,KAAK,CAAC,OAAO,6FAA6F;QAC/G,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC;AACpB,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@descent-vtt/spec-guard",
-  "version": "0.7.0",
+  "version": "0.9.0",
   "description": "Executable architecture assertions for Markdown specs & ADRs.",
   "keywords": [
     "adr",
@@ -47,7 +47,7 @@
     "test:watch": "vitest",
     "test:coverage": "vitest run --coverage",
     "test:mutation": "stryker run",
-    "selfcheck": "node ./bin/spec-guard.js \"docs/**/*.md\" \"README.md\" --verbose",
+    "selfcheck": "node ./bin/spec-guard.js --verbose",
     "prepublishOnly": "npm run clean && npm run build"
   },
   "devDependencies": {
@@ -67,6 +67,12 @@
     "url": "https://github.com/DescentVTT/spec-guard/issues"
   },
   "homepage": "https://github.com/DescentVTT/spec-guard#readme",
+  "specGuard": {
+    "specs": [
+      "docs/**/*.md",
+      "README.md"
+    ]
+  },
   "overrides": {
     "qs": "^6.16.0"
   }