@abseed/spectra-drift-check 0.1.0

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/NOTICE

@@ -0,0 +1,6 @@
+Spectra
+Copyright 2026 lpezet
+
+Licensed under the Apache License, Version 2.0 (the "License"); you may not use
+this project except in compliance with the License. You may obtain a copy of the
+License in the LICENSE file, or at http://www.apache.org/licenses/LICENSE-2.0

package/README.md

@@ -0,0 +1,43 @@
+# @abseed/spectra-drift-check
+
+The offline drift check between a Spectra glossary and the code that implements it.
+
+Your project keeps two things: a `specs.snapshot.json` (written by `@coder`'s `export_specs` tool and
+committed with the code) and `// implements: <Term>` markers in your source. This package checks that
+the two agree — **offline, with no coordinator running** — so the check works in a bare copy of the
+project and inside `@coder`'s sandbox alike.
+
+It catches:
+
+- a marker that isn't comma-separated bare identifiers (put prose on the next line);
+- a marker naming a term the glossary no longer has (renamed or removed);
+- an entity/function/event term that nothing implements (an implementation pass is due).
+
+It cannot catch a term whose spec was *rewritten* — the marker still names it. That's what each term's
+`hash` in the snapshot is for: refresh the file and `git diff specs.snapshot.json` names the terms
+that moved, so the test fails loud for structure and review catches the rest.
+
+## Use it
+
+Add it as a dev-dependency, then write a one-line test in whatever runner you already use:
+
+```ts
+import { driftCheck } from '@abseed/spectra-drift-check'
+import { expect, it } from 'vitest'
+
+it('the glossary and the code are in sync', () => {
+  const { ok, findings } = driftCheck({ srcDir: 'src', snapshotPath: 'specs.snapshot.json' })
+  expect(ok, findings.map((f) => f.message).join('\n')).toBe(true)
+})
+```
+
+`driftCheck` returns `{ ok, findings }`; each finding has a `kind` and a human-readable `message`.
+The reader functions (`readMarkers`, `readSnapshot`, `implementersOf`) and the pure `checkDrift` are
+exported too, if you want to assemble the check differently.
+
+## Keep the snapshot fresh
+
+`specs.snapshot.json` is a pure function of the glossary (no timestamp), so re-exporting when nothing
+changed leaves it byte-identical. Have `@coder` run `export_specs` before an implementation pass and
+commit the result; a stale snapshot is your branch being behind, the way `git status` reports it — a
+signal to refresh, not a wall.

package/dist/check.d.ts

@@ -0,0 +1,23 @@
+import type { Marker, Snapshot } from './implements.js';
+export type DriftFindingKind = 'no-snapshot' | 'no-markers' | 'malformed-marker' | 'unknown-term' | 'unimplemented-term';
+export interface DriftFinding {
+    kind: DriftFindingKind;
+    message: string;
+}
+/**
+ * Compare markers against a snapshot. A null snapshot is itself the finding — a missing committed
+ * file, not a missing service, so it fails hard rather than skipping (a green run that checked
+ * nothing is the outcome worth refusing).
+ */
+export declare function checkDrift(markers: Marker[], snapshot: Snapshot | null): DriftFinding[];
+/**
+ * Read markers from `srcDir` and the snapshot at `snapshotPath`, and run the check. The convenience
+ * a consumer project's test calls: `const { ok, findings } = driftCheck({ srcDir, snapshotPath })`.
+ */
+export declare function driftCheck(opts: {
+    srcDir: string;
+    snapshotPath: string;
+}): {
+    ok: boolean;
+    findings: DriftFinding[];
+};

package/dist/check.js

@@ -0,0 +1,64 @@
+/**
+ * The drift check itself — "do the glossary and the code still agree?" — as pure findings.
+ *
+ * Kept framework-agnostic on purpose: it returns a list of problems rather than asserting, so a
+ * consumer project turns it into a one-line test in whatever runner it already uses (see the README).
+ * Empty list means the code and the committed snapshot are in sync.
+ *
+ * What it catches, and what it deliberately cannot: a malformed marker, a marker naming a term the
+ * glossary no longer has, and a term (entity/function/event) nothing implements. It cannot catch a
+ * term whose *spec was rewritten* — the marker still names it and still looks right. That is what the
+ * per-term `hash` in the snapshot is for: refreshing the file makes `git diff specs.snapshot.json`
+ * name the terms that moved, so the check fails loud for structure and review catches the rest.
+ */
+import { existsSync } from 'node:fs';
+import { implementersOf, readMarkers, readSnapshot } from './implements.js';
+/** Terms that must be implemented by code. attribute-types are value shapes carried by other terms. */
+const NEEDS_IMPLEMENTING = new Set(['entity', 'function', 'event']);
+/**
+ * Compare markers against a snapshot. A null snapshot is itself the finding — a missing committed
+ * file, not a missing service, so it fails hard rather than skipping (a green run that checked
+ * nothing is the outcome worth refusing).
+ */
+export function checkDrift(markers, snapshot) {
+    if (!snapshot) {
+        return [{ kind: 'no-snapshot', message: 'No specs.snapshot.json — run export_specs and commit the result.' }];
+    }
+    const findings = [];
+    if (markers.length === 0) {
+        findings.push({ kind: 'no-markers', message: 'No `// implements:` markers found under the scanned directory.' });
+    }
+    for (const marker of markers) {
+        if (marker.malformed.length > 0) {
+            findings.push({
+                kind: 'malformed-marker',
+                message: `${marker.file}:${marker.line} — not bare identifiers: ${marker.malformed.join(', ')} (put prose on the next line)`,
+            });
+        }
+    }
+    const known = new Set(snapshot.terms.map((term) => term.name));
+    for (const marker of markers) {
+        for (const term of marker.terms) {
+            if (!known.has(term)) {
+                findings.push({ kind: 'unknown-term', message: `${marker.file}:${marker.line} — marker names "${term}", not in the glossary (renamed or removed?)` });
+            }
+        }
+    }
+    const implementers = implementersOf(markers);
+    for (const term of snapshot.terms) {
+        if (NEEDS_IMPLEMENTING.has(term.type) && !implementers.has(term.name)) {
+            findings.push({ kind: 'unimplemented-term', message: `${term.name} (${term.type}) — nothing implements it; an implementation pass is due` });
+        }
+    }
+    return findings;
+}
+/**
+ * Read markers from `srcDir` and the snapshot at `snapshotPath`, and run the check. The convenience
+ * a consumer project's test calls: `const { ok, findings } = driftCheck({ srcDir, snapshotPath })`.
+ */
+export function driftCheck(opts) {
+    const markers = readMarkers(opts.srcDir);
+    const snapshot = existsSync(opts.snapshotPath) ? readSnapshot(opts.snapshotPath) : null;
+    const findings = checkDrift(markers, snapshot);
+    return { ok: findings.length === 0, findings };
+}

package/dist/implements.d.ts

@@ -0,0 +1,39 @@
+export interface Marker {
+    /** Path relative to the scanned root. */
+    file: string;
+    line: number;
+    terms: string[];
+    /** Entries that are not bare identifiers — reported instead of silently ignored. */
+    malformed: string[];
+}
+/** Every `// implements:` marker under `root`, with the terms it names and any malformed entries. */
+export declare function readMarkers(root: string): Marker[];
+export interface TermRecord {
+    name: string;
+    type: string;
+    /** Covers spec text, parent and attributes — what an implementer has to satisfy. */
+    hash: string;
+}
+export interface ExpectationRecord {
+    id: string;
+    kind: string;
+    hash: string;
+}
+export interface Snapshot {
+    /**
+     * One value for the whole glossary. There is deliberately no timestamp: the file is a pure
+     * function of the glossary, so re-exporting when nothing changed leaves it byte-identical.
+     */
+    version: string;
+    terms: TermRecord[];
+    /** Optional so a snapshot exported before expectations existed still reads. */
+    expectations?: ExpectationRecord[];
+}
+/**
+ * The glossary as this project sees it — a committed file (`export_specs` writes it), not a directory
+ * somewhere else. `specs/` is not reachable from a standalone copy of the project, nor from inside
+ * @coder's sandbox; a committed snapshot works in both, a live lookup in neither.
+ */
+export declare function readSnapshot(file: string): Snapshot;
+/** Which files claim each term. */
+export declare function implementersOf(markers: Marker[]): Map<string, string[]>;

package/dist/implements.js

@@ -0,0 +1,74 @@
+/**
+ * Reading the `// implements:` markers and the committed glossary snapshot.
+ *
+ * The markers are the only link from a term back to the code responsible for it, and a comment
+ * nothing checks is a comment that rots. This makes them parseable so a test can fail when the
+ * glossary and the code drift apart — a term with no implementer, or a marker naming a term that no
+ * longer exists.
+ *
+ * The grammar is deliberately strict: `// implements:` followed by comma-separated bare identifiers
+ * and nothing else. Trailing prose would have to be guessed at, so anything that is not an identifier
+ * is reported rather than skipped. Put the prose on the next line.
+ *
+ * (Ported from the reference `app/` on the `backup/todo-app` branch, now a package a consumer project
+ * depends on so the check ships with Spectra rather than being copied per project.)
+ */
+import { readFileSync, readdirSync, statSync } from 'node:fs';
+import path from 'node:path';
+const MARKER = /^\s*(?:\/\/|\*)\s*implements:\s*(.*)$/;
+const IDENTIFIER = /^[A-Za-z_][A-Za-z0-9_]*$/;
+const SOURCE = /\.tsx?$/;
+function sourceFiles(dir, root = dir) {
+    const found = [];
+    for (const entry of readdirSync(dir).sort()) {
+        const full = path.join(dir, entry);
+        if (statSync(full).isDirectory()) {
+            found.push(...sourceFiles(full, root));
+        }
+        else if (SOURCE.test(entry) && !entry.endsWith('.test.ts')) {
+            found.push(path.relative(root, full));
+        }
+    }
+    return found;
+}
+/** Every `// implements:` marker under `root`, with the terms it names and any malformed entries. */
+export function readMarkers(root) {
+    const markers = [];
+    for (const file of sourceFiles(root)) {
+        const lines = readFileSync(path.join(root, file), 'utf8').split('\n');
+        lines.forEach((line, index) => {
+            const match = MARKER.exec(line);
+            if (!match)
+                return;
+            const entries = match[1]
+                .split(',')
+                .map((entry) => entry.trim())
+                .filter(Boolean);
+            markers.push({
+                file,
+                line: index + 1,
+                terms: entries.filter((entry) => IDENTIFIER.test(entry)),
+                malformed: entries.filter((entry) => !IDENTIFIER.test(entry)),
+            });
+        });
+    }
+    return markers;
+}
+/**
+ * The glossary as this project sees it — a committed file (`export_specs` writes it), not a directory
+ * somewhere else. `specs/` is not reachable from a standalone copy of the project, nor from inside
+ * @coder's sandbox; a committed snapshot works in both, a live lookup in neither.
+ */
+export function readSnapshot(file) {
+    return JSON.parse(readFileSync(file, 'utf8'));
+}
+/** Which files claim each term. */
+export function implementersOf(markers) {
+    const byTerm = new Map();
+    for (const marker of markers) {
+        for (const term of marker.terms) {
+            byTerm.set(term, [...(byTerm.get(term) ?? []), marker.file]);
+        }
+    }
+    return byTerm;
+}

package/dist/index.d.ts

@@ -0,0 +1,22 @@
+/**
+ * `@abseed/spectra-drift-check` — the offline drift check between a Spectra glossary and the code that
+ * implements it, as a small package a consumer project depends on.
+ *
+ * A project keeps a `specs.snapshot.json` (written by @coder's `export_specs`, committed with the
+ * code) and `// implements: <Term>` markers in its source. This checks the two agree — offline, with
+ * no coordinator running — so it works both in a bare copy of the project and inside @coder's sandbox.
+ * It replaces the per-project copied files the check used to be (see `backup/todo-app`).
+ *
+ * Usage in a consumer project's test (framework-agnostic core; example in vitest):
+ *
+ *   import { driftCheck } from '@abseed/spectra-drift-check'
+ *   import { expect, it } from 'vitest'
+ *   it('the glossary and the code are in sync', () => {
+ *     const { ok, findings } = driftCheck({ srcDir: 'src', snapshotPath: 'specs.snapshot.json' })
+ *     expect(ok, findings.map((f) => f.message).join('\n')).toBe(true)
+ *   })
+ */
+export { readMarkers, readSnapshot, implementersOf } from './implements.js';
+export type { Marker, Snapshot, TermRecord, ExpectationRecord } from './implements.js';
+export { checkDrift, driftCheck } from './check.js';
+export type { DriftFinding, DriftFindingKind } from './check.js';

package/dist/index.js

@@ -0,0 +1,20 @@
+/**
+ * `@abseed/spectra-drift-check` — the offline drift check between a Spectra glossary and the code that
+ * implements it, as a small package a consumer project depends on.
+ *
+ * A project keeps a `specs.snapshot.json` (written by @coder's `export_specs`, committed with the
+ * code) and `// implements: <Term>` markers in its source. This checks the two agree — offline, with
+ * no coordinator running — so it works both in a bare copy of the project and inside @coder's sandbox.
+ * It replaces the per-project copied files the check used to be (see `backup/todo-app`).
+ *
+ * Usage in a consumer project's test (framework-agnostic core; example in vitest):
+ *
+ *   import { driftCheck } from '@abseed/spectra-drift-check'
+ *   import { expect, it } from 'vitest'
+ *   it('the glossary and the code are in sync', () => {
+ *     const { ok, findings } = driftCheck({ srcDir: 'src', snapshotPath: 'specs.snapshot.json' })
+ *     expect(ok, findings.map((f) => f.message).join('\n')).toBe(true)
+ *   })
+ */
+export { readMarkers, readSnapshot, implementersOf } from './implements.js';
+export { checkDrift, driftCheck } from './check.js';

package/package.json

@@ -0,0 +1,39 @@
+{
+  "name": "@abseed/spectra-drift-check",
+  "version": "0.1.0",
+  "description": "Offline drift check between a Spectra glossary and the code that implements it.",
+  "type": "module",
+  "license": "Apache-2.0",
+  "author": "lpezet",
+  "homepage": "https://github.com/lpezet/spectra/tree/main/packages/drift-check",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/lpezet/spectra.git",
+    "directory": "packages/drift-check"
+  },
+  "keywords": ["spectra", "spec-driven", "glossary", "drift-check", "vitest"],
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    }
+  },
+  "files": ["dist", "NOTICE"],
+  "sideEffects": false,
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "tsc -p tsconfig.build.json",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "typecheck": "tsc --noEmit",
+    "prepublishOnly": "npm run build"
+  },
+  "devDependencies": {
+    "typescript": "^5.7.3",
+    "vitest": "^3.0.5"
+  }
+}