docguard-cli 0.41.3 → 0.41.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +33 -0
- package/README.md +10 -4
- package/cli/docguard.mjs +1 -1
- package/cli/findings.mjs +1 -1
- package/cli/scanners/instruction-audit.mjs +20 -3
- package/cli/scanners/spec-registry.mjs +26 -0
- package/cli/shared-ignore.mjs +49 -0
- package/cli/shared-validator-surface.mjs +17 -0
- package/cli/validators/canonical-sync.mjs +13 -18
- package/cli/validators/metrics-consistency.mjs +19 -7
- package/cli/validators/todo-tracking.mjs +3 -2
- package/cli/validators/traceability.mjs +14 -5
- package/docs/quickstart.md +1 -1
- package/extensions/spec-kit-docguard/extension.yml +1 -1
- package/extensions/spec-kit-docguard/skills/docguard-fix/SKILL.md +2 -2
- package/extensions/spec-kit-docguard/skills/docguard-guard/SKILL.md +2 -2
- package/extensions/spec-kit-docguard/skills/docguard-review/SKILL.md +2 -2
- package/extensions/spec-kit-docguard/skills/docguard-score/SKILL.md +2 -2
- package/extensions/spec-kit-docguard/skills/docguard-sync/SKILL.md +2 -2
- package/extensions/spec-kit-docguard/templates/github-workflows/docguard-autofix.yml +1 -1
- package/extensions/spec-kit-docguard/templates/github-workflows/docguard-guard.yml +1 -1
- package/package.json +1 -1
- package/templates/ci/github-actions.yml +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -7,6 +7,39 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
|
|
7
7
|
|
|
8
8
|
## [Unreleased]
|
|
9
9
|
|
|
10
|
+
## [0.41.4] - 2026-09-17
|
|
11
|
+
|
|
12
|
+
Automated weekly release — batches everything merged since `v0.41.3`.
|
|
13
|
+
|
|
14
|
+
### Changed
|
|
15
|
+
|
|
16
|
+
- fix: correct the validator-surface claim and document DOCGUARD_API_KEY (#408)
|
|
17
|
+
- fix: harden adoption precision boundaries (#406)
|
|
18
|
+
|
|
19
|
+
|
|
20
|
+
### Fixed
|
|
21
|
+
|
|
22
|
+
- Document `DOCGUARD_API_KEY` in the canonical environment doc. `ENVIRONMENT.md`
|
|
23
|
+
claimed DocGuard uses "no API keys" and needs no environment variables, which
|
|
24
|
+
contradicted `SECURITY.md` and the HTTP MCP server, where the variable is
|
|
25
|
+
required to bind a non-loopback host. Core CLI commands still need no credential.
|
|
26
|
+
- Enforce the published validator count in `npm test`. Canonical-Sync and
|
|
27
|
+
Metrics-Consistency already detect a stale "N validators" claim, but they emit
|
|
28
|
+
warnings and the CI self-scan deliberately tolerates guard's warnings-only exit,
|
|
29
|
+
so a wrong count could reach `main` with every check green. The count is now
|
|
30
|
+
asserted against the shipped `cli/validators/*.mjs` modules, and README explains
|
|
31
|
+
why guard prints 30 result rows for 29 validators.
|
|
32
|
+
- Count DocGuard validator claims from one shared source of truth: the
|
|
33
|
+
validator modules shipped in the installed package. A consumer's intentionally
|
|
34
|
+
disabled validators and extra guard checks cannot create a false MET001 or
|
|
35
|
+
CSY003 finding, or an unsafe count rewrite.
|
|
36
|
+
- Keep instruction-pointer basename resolution out of Git-ignored directories
|
|
37
|
+
and nested Git checkouts, including linked worktree copies.
|
|
38
|
+
- Keep planned lifecycle registries that are new, removed from the Git index,
|
|
39
|
+
or modified pending commit non-authoritative for TRC004 while explaining how
|
|
40
|
+
to restore or commit the registry and current spec artifacts; the remediation
|
|
41
|
+
no longer suggests adding an artificial `@req` marker.
|
|
42
|
+
|
|
10
43
|
## [0.41.3] - 2026-09-15
|
|
11
44
|
|
|
12
45
|
Automated weekly release — batches everything merged since `v0.41.2`.
|
package/README.md
CHANGED
|
@@ -77,7 +77,7 @@ graph TD
|
|
|
77
77
|
Commands --> setup["setup wizard"]
|
|
78
78
|
Commands --> other["diff · init · fix · trace · impact · sync · reconcile · retire · specs<br/>explain · memory · upgrade · agents · hooks · badge · ci · watch"]
|
|
79
79
|
|
|
80
|
-
guard --> Validators["Validators (
|
|
80
|
+
guard --> Validators["Validators (29)"]
|
|
81
81
|
generate --> Scanners["Scanners (4)<br/>routes · schemas · doc-tools · speckit"]
|
|
82
82
|
score --> Scoring["Weighted Scoring<br/>8 categories"]
|
|
83
83
|
diagnose --> Validators
|
|
@@ -275,7 +275,7 @@ DocGuard ships **23 commands** (the "Daily 5" + 18 situational tools, including
|
|
|
275
275
|
| Command | What It Does |
|
|
276
276
|
|:--------|:-------------|
|
|
277
277
|
| `init` | Bootstrap a project (`--wizard` for interactive · `--with <name>` for scaffolders) |
|
|
278
|
-
| `guard` | Validate against canonical docs —
|
|
278
|
+
| `guard` | Validate against canonical docs — 29 validators |
|
|
279
279
|
| `diff` | Show gaps between docs and code (`--since <ref>` for impact mode) |
|
|
280
280
|
| `sync` | Refresh code-truth doc sections — keeps memory always up to date |
|
|
281
281
|
| `score` | Structural CDD maturity score (0-100; not a guard verdict; `--diff` for delta between refs) |
|
|
@@ -411,7 +411,13 @@ $ npx docguard-cli generate
|
|
|
411
411
|
|
|
412
412
|
## 🔍 Validators
|
|
413
413
|
|
|
414
|
-
DocGuard runs **
|
|
414
|
+
DocGuard runs **29 automated validators** on every `guard` check. Source-facing validators are language-aware where their evidence model applies; repository and document validators operate independently of source language.
|
|
415
|
+
|
|
416
|
+
> **Counting note:** `guard` prints 30 result rows, not 29. `Structure` emits a
|
|
417
|
+
> second check result (`Doc Sections`) under the same validator key, so rows are
|
|
418
|
+
> checks, not validators. The published number is the count of shipped
|
|
419
|
+
> `cli/validators/*.mjs` modules and is enforced by tests — don't derive it by
|
|
420
|
+
> counting output rows.
|
|
415
421
|
|
|
416
422
|
| # | Validator | What It Checks | Default |
|
|
417
423
|
|:--|:----------|:--------------|:--------|
|
|
@@ -544,7 +550,7 @@ DocGuard provides AI agent slash commands for integrated workflows. Installed au
|
|
|
544
550
|
| Command | What It Does |
|
|
545
551
|
|:--------|:-------------|
|
|
546
552
|
| `/docguard.init` | Initialize Canonical-Driven Development in a new or existing project |
|
|
547
|
-
| `/docguard.guard` | Run quality validation — check all
|
|
553
|
+
| `/docguard.guard` | Run quality validation — check all 29 validators |
|
|
548
554
|
| `/docguard.review` | Analyze doc quality and suggest improvements |
|
|
549
555
|
| `/docguard.fix` | Generate targeted fix prompts for specific issues |
|
|
550
556
|
| `/docguard.update` | Update canonical docs after code changes — detect drift and sync documentation |
|
package/cli/docguard.mjs
CHANGED
|
@@ -341,7 +341,7 @@ const COMMAND_HELP = {
|
|
|
341
341
|
summary: 'Maintain the deterministic spec lifecycle and evidence registry.',
|
|
342
342
|
usage: 'docguard specs [--check|--write] | docguard specs preflight [--path <spec>] | docguard specs complete --id <spec-id> [--since <ref>] [--write --reason <text>]',
|
|
343
343
|
flags: [
|
|
344
|
-
['--check', 'Exit 2 when the committed registry is missing, stale, or inconsistent'],
|
|
344
|
+
['--check', 'Exit 2 when the committed registry is missing, stale, or inconsistent; planned lifecycle deferral requires a clean tracked registry'],
|
|
345
345
|
['--write', 'Refresh observed evidence while preserving reviewed lifecycle fields'],
|
|
346
346
|
['preflight', 'Brief prior specs, or gate a generated draft with --path'],
|
|
347
347
|
['complete', 'Plan or apply the implemented→verified evidence transaction'],
|
package/cli/findings.mjs
CHANGED
|
@@ -425,7 +425,7 @@ export const CODES = {
|
|
|
425
425
|
CSY003: {
|
|
426
426
|
validator: 'canonicalSync',
|
|
427
427
|
title: 'Stale "N validators" claim',
|
|
428
|
-
help:
|
|
428
|
+
help: 'A surface doc (README.md/AGENTS.md) states a validator count that does not match the validator modules shipped in the package. Guard can emit multiple check results from one module; those do not increase the public validator count. Update the claim.',
|
|
429
429
|
suppress: null,
|
|
430
430
|
},
|
|
431
431
|
CSY004: {
|
|
@@ -34,7 +34,13 @@
|
|
|
34
34
|
import { readFileSync, readdirSync, lstatSync, realpathSync } from 'node:fs';
|
|
35
35
|
import { resolve, join, dirname, relative, isAbsolute, sep } from 'node:path';
|
|
36
36
|
import { fileURLToPath } from 'node:url';
|
|
37
|
-
import {
|
|
37
|
+
import {
|
|
38
|
+
buildIgnoreFilter,
|
|
39
|
+
loadDocguardIgnore,
|
|
40
|
+
loadGitIgnoredFilter,
|
|
41
|
+
DEFAULT_IGNORE_DIRS,
|
|
42
|
+
relPosix,
|
|
43
|
+
} from '../shared-ignore.mjs';
|
|
38
44
|
|
|
39
45
|
const __dirname = dirname(fileURLToPath(import.meta.url));
|
|
40
46
|
|
|
@@ -165,6 +171,7 @@ function basenameIndex(projectDir, wanted, config = {}) {
|
|
|
165
171
|
let root;
|
|
166
172
|
try { root = realpathSync(projectDir); }
|
|
167
173
|
catch { return { matches, complete: false, visited: 0, reason: 'repository-unavailable' }; }
|
|
174
|
+
const gitIgnored = loadGitIgnoredFilter(root);
|
|
168
175
|
let visited = 0;
|
|
169
176
|
let complete = true;
|
|
170
177
|
let reason = null;
|
|
@@ -177,12 +184,22 @@ function basenameIndex(projectDir, wanted, config = {}) {
|
|
|
177
184
|
if (DEFAULT_IGNORE_DIRS.has(entry.name) || entry.name === '.local' || /^\.env(?:\.|$)/i.test(entry.name)) continue;
|
|
178
185
|
const full = resolve(dir, entry.name);
|
|
179
186
|
const rel = relPosix(root, full);
|
|
180
|
-
if (ignored(rel)) continue;
|
|
187
|
+
if (ignored(rel) || (gitIgnored && gitIgnored(rel))) continue;
|
|
181
188
|
let stat;
|
|
182
189
|
try { stat = lstatSync(full); }
|
|
183
190
|
catch { complete = false; reason ||= 'unreadable-entry'; continue; }
|
|
184
191
|
if (stat.isSymbolicLink()) continue;
|
|
185
|
-
if (stat.isDirectory()) {
|
|
192
|
+
if (stat.isDirectory()) {
|
|
193
|
+
// A linked Git worktree has a `.git` FILE; a nested checkout has a
|
|
194
|
+
// `.git` directory. Neither is part of this repository's primary
|
|
195
|
+
// instruction-pointer namespace, even when its parent was not added
|
|
196
|
+
// to .gitignore. Stop before reading duplicate checkout contents.
|
|
197
|
+
try {
|
|
198
|
+
if (lstatSync(join(full, '.git')).isFile() || lstatSync(join(full, '.git')).isDirectory()) continue;
|
|
199
|
+
} catch { /* ordinary directory: keep walking */ }
|
|
200
|
+
walk(full);
|
|
201
|
+
if (reason === 'entry-budget') return;
|
|
202
|
+
}
|
|
186
203
|
else if (stat.isFile() && matches.has(entry.name)) matches.get(entry.name).push(rel);
|
|
187
204
|
}
|
|
188
205
|
};
|
|
@@ -288,6 +288,32 @@ export function trustedSpecLifecycleIndex(projectDir) {
|
|
|
288
288
|
return trusted;
|
|
289
289
|
}
|
|
290
290
|
|
|
291
|
+
/**
|
|
292
|
+
* Planned lifecycle entries that are structurally current but cannot defer
|
|
293
|
+
* traceability because the registry is not a clean, tracked Git artifact.
|
|
294
|
+
* This includes a new registry, a registry removed from the index, and a
|
|
295
|
+
* modified registry awaiting a commit. It is advisory-only: callers may
|
|
296
|
+
* explain the state, never use it as evidence.
|
|
297
|
+
*/
|
|
298
|
+
export function uncommittedPlannedSpecLifecycleIndex(projectDir) {
|
|
299
|
+
const candidates = new Map();
|
|
300
|
+
const loaded = readSpecRegistry(projectDir);
|
|
301
|
+
if (loaded.error || loaded.value?.schemaVersion !== SPEC_REGISTRY_SCHEMA_VERSION) return candidates;
|
|
302
|
+
if (trackedAndClean(projectDir, SPEC_REGISTRY_PATH)) return candidates;
|
|
303
|
+
for (const entry of loaded.value.specs) {
|
|
304
|
+
if (entry?.reviewed?.lifecycle?.delivery !== 'planned' || !entry.specId || !entry.path) continue;
|
|
305
|
+
if (!trackedAndClean(projectDir, entry.path)) continue;
|
|
306
|
+
let content;
|
|
307
|
+
try { content = readFileSync(resolve(projectDir, entry.path), 'utf8'); } catch { continue; }
|
|
308
|
+
if (parseSpecId(content) !== entry.specId) continue;
|
|
309
|
+
const artifact = entry.observed?.artifacts?.find(item => item.path === entry.path);
|
|
310
|
+
if (!artifact || artifact.digest !== digest(content)) continue;
|
|
311
|
+
if (entry.reviewed.lifecycle.context !== 'current' || entry.reviewed.lifecycle.storage !== 'working_tree') continue;
|
|
312
|
+
candidates.set(`${entry.specId}\0${entry.path}`, entry.reviewed.lifecycle);
|
|
313
|
+
}
|
|
314
|
+
return candidates;
|
|
315
|
+
}
|
|
316
|
+
|
|
291
317
|
function taskCompletion(path) {
|
|
292
318
|
if (!path || !existsSync(path)) return { checked: 0, total: 0 };
|
|
293
319
|
const content = readFileSync(path, 'utf8');
|
package/cli/shared-ignore.mjs
CHANGED
|
@@ -91,6 +91,7 @@ export function isNonProductPath(relPath, config = {}) {
|
|
|
91
91
|
* Returns [] if the file is missing or unreadable — never throws.
|
|
92
92
|
*/
|
|
93
93
|
import { readFileSync, existsSync, readdirSync, statSync } from 'node:fs';
|
|
94
|
+
import { spawnSync } from 'node:child_process';
|
|
94
95
|
import { resolve as resolvePath, relative as relativePath, join as joinPath, sep } from 'node:path';
|
|
95
96
|
|
|
96
97
|
/**
|
|
@@ -122,6 +123,54 @@ export function loadDocguardIgnore(projectDir) {
|
|
|
122
123
|
}
|
|
123
124
|
}
|
|
124
125
|
|
|
126
|
+
/**
|
|
127
|
+
* Return a predicate for paths Git currently classifies as ignored.
|
|
128
|
+
*
|
|
129
|
+
* This deliberately delegates pattern semantics (including nested
|
|
130
|
+
* `.gitignore` files and negation) to Git instead of maintaining a second,
|
|
131
|
+
* incomplete gitignore parser. `--directory` lets callers prune a wholly
|
|
132
|
+
* ignored directory before reading its descendants. A missing Git repository
|
|
133
|
+
* or an unreadable/overflowing result returns null so callers can retain their
|
|
134
|
+
* existing conservative traversal behavior.
|
|
135
|
+
*
|
|
136
|
+
* Only untracked ignored paths are returned by Git, which is intentional:
|
|
137
|
+
* tracked source remains part of the repository even if a later ignore rule
|
|
138
|
+
* happens to mention its name.
|
|
139
|
+
*
|
|
140
|
+
* @param {string} projectDir
|
|
141
|
+
* @returns {((relPath: string) => boolean)|null}
|
|
142
|
+
*/
|
|
143
|
+
export function loadGitIgnoredFilter(projectDir) {
|
|
144
|
+
let result;
|
|
145
|
+
try {
|
|
146
|
+
result = spawnSync('git', [
|
|
147
|
+
'ls-files', '--others', '--ignored', '--exclude-standard', '--directory', '-z',
|
|
148
|
+
], {
|
|
149
|
+
cwd: projectDir,
|
|
150
|
+
encoding: 'utf8',
|
|
151
|
+
maxBuffer: 8 * 1024 * 1024,
|
|
152
|
+
windowsHide: true,
|
|
153
|
+
});
|
|
154
|
+
} catch {
|
|
155
|
+
return null;
|
|
156
|
+
}
|
|
157
|
+
if (result.status !== 0 || result.error || typeof result.stdout !== 'string') return null;
|
|
158
|
+
|
|
159
|
+
const exact = new Set();
|
|
160
|
+
const directories = [];
|
|
161
|
+
for (const raw of result.stdout.split('\0')) {
|
|
162
|
+
const path = raw.replace(/\\/g, '/').replace(/^\.\//, '');
|
|
163
|
+
if (!path) continue;
|
|
164
|
+
if (path.endsWith('/')) directories.push(path);
|
|
165
|
+
else exact.add(path);
|
|
166
|
+
}
|
|
167
|
+
if (exact.size === 0 && directories.length === 0) return () => false;
|
|
168
|
+
return relPath => {
|
|
169
|
+
const path = String(relPath || '').replace(/\\/g, '/').replace(/^\.\//, '');
|
|
170
|
+
return exact.has(path) || directories.some(directory => path.startsWith(directory));
|
|
171
|
+
};
|
|
172
|
+
}
|
|
173
|
+
|
|
125
174
|
/**
|
|
126
175
|
* Merge `.docguardignore` patterns into a config object's `ignore` array.
|
|
127
176
|
*
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Validator Surface — package capability facts shared by self-governance
|
|
3
|
+
* validators. A validator module is one shipped `cli/validators/*.mjs` file;
|
|
4
|
+
* guard may emit additional check results from a module, but those are not
|
|
5
|
+
* extra public validator modules.
|
|
6
|
+
*/
|
|
7
|
+
|
|
8
|
+
import { readdirSync } from 'node:fs';
|
|
9
|
+
|
|
10
|
+
/** Return the number of validator modules in one package directory, or null. */
|
|
11
|
+
export function countValidatorModules(validatorsDir) {
|
|
12
|
+
try {
|
|
13
|
+
return readdirSync(validatorsDir).filter(name => name.endsWith('.mjs')).length;
|
|
14
|
+
} catch {
|
|
15
|
+
return null;
|
|
16
|
+
}
|
|
17
|
+
}
|
|
@@ -15,9 +15,9 @@
|
|
|
15
15
|
*
|
|
16
16
|
* What it checks:
|
|
17
17
|
* 1. README "ships N commands" matches `cli/commands/*.mjs` file count
|
|
18
|
-
* 2. README "N validators" matches `
|
|
19
|
-
*
|
|
20
|
-
*
|
|
18
|
+
* 2. README "N validators" matches the shipped `cli/validators/*.mjs`
|
|
19
|
+
* module count. Guard may emit multiple check results from one module;
|
|
20
|
+
* those are not extra public validator modules.
|
|
21
21
|
* 3. Validator names enumerated inline in README appear in guard output
|
|
22
22
|
*
|
|
23
23
|
* What it explicitly skips:
|
|
@@ -41,6 +41,7 @@
|
|
|
41
41
|
import { existsSync, readFileSync, readdirSync } from 'node:fs';
|
|
42
42
|
import { resolve, join } from 'node:path';
|
|
43
43
|
import { mkFinding, resultFromFindings } from '../findings.mjs';
|
|
44
|
+
import { countValidatorModules } from '../shared-validator-surface.mjs';
|
|
44
45
|
|
|
45
46
|
/**
|
|
46
47
|
* Validate that README count claims about DocGuard's surface match code-truth.
|
|
@@ -118,19 +119,13 @@ export function validateCanonicalSync(projectDir, config, guardResults) {
|
|
|
118
119
|
}
|
|
119
120
|
const actualCommandCount = actualUserFacingCount;
|
|
120
121
|
|
|
121
|
-
// Validator count
|
|
122
|
-
//
|
|
123
|
-
//
|
|
124
|
-
//
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
// Names list (currently unused for warnings, but kept for future Check 3
|
|
130
|
-
// where the README enumerates validator names inline).
|
|
131
|
-
let actualValidatorNames = [];
|
|
132
|
-
if (Array.isArray(guardResults) && guardResults.length > 0) {
|
|
133
|
-
actualValidatorNames = guardResults.map(r => r.name).filter(Boolean);
|
|
122
|
+
// Validator count is the package capability count used by
|
|
123
|
+
// Metrics-Consistency too. It is run-order independent and excludes extra
|
|
124
|
+
// sub-check results emitted by a validator module (for example, Doc Sections
|
|
125
|
+
// from structure.mjs), which are checks rather than shipped validators.
|
|
126
|
+
const actualValidatorCount = countValidatorModules(validatorsDir);
|
|
127
|
+
if (actualValidatorCount === null) {
|
|
128
|
+
return compose({ na: true, naReason: 'cli/validators could not be read' });
|
|
134
129
|
}
|
|
135
130
|
|
|
136
131
|
// ── Read surface docs (README.md + AGENTS.md) ──────────────────────
|
|
@@ -204,9 +199,9 @@ export function validateCanonicalSync(projectDir, config, guardResults) {
|
|
|
204
199
|
code: 'CSY003',
|
|
205
200
|
validator: 'canonicalSync',
|
|
206
201
|
severity: 'warn',
|
|
207
|
-
message: `A surface doc (README.md/AGENTS.md) claims ${uniqueWrong.map(n => `"${n} validators"`).join(' / ')} but
|
|
202
|
+
message: `A surface doc (README.md/AGENTS.md) claims ${uniqueWrong.map(n => `"${n} validators"`).join(' / ')} but DocGuard ships ${actualValidatorCount} validator modules. Update it.`,
|
|
208
203
|
location: null,
|
|
209
|
-
suggestion: { kind: 'fix', text: 'Update the "N validators" claim in README.md/AGENTS.md to match
|
|
204
|
+
suggestion: { kind: 'fix', text: 'Update the "N validators" claim in README.md/AGENTS.md to match DocGuard\'s shipped validator modules' },
|
|
210
205
|
}));
|
|
211
206
|
}
|
|
212
207
|
} else {
|
|
@@ -7,8 +7,10 @@
|
|
|
7
7
|
*/
|
|
8
8
|
|
|
9
9
|
import { existsSync, readFileSync, readdirSync, statSync } from 'node:fs';
|
|
10
|
-
import { resolve, join, relative } from 'node:path';
|
|
10
|
+
import { resolve, join, relative, dirname } from 'node:path';
|
|
11
|
+
import { fileURLToPath } from 'node:url';
|
|
11
12
|
import { loadIgnorePatterns, resolveDocDirs } from '../shared.mjs';
|
|
13
|
+
import { countValidatorModules } from '../shared-validator-surface.mjs';
|
|
12
14
|
// v0.29 consolidation: walker + glob counting live in shared-ignore.mjs (the
|
|
13
15
|
// single implementations) — this file previously carried private copies.
|
|
14
16
|
import { walkFiles, countGlobFiles } from '../shared-ignore.mjs';
|
|
@@ -33,18 +35,19 @@ export function validateMetricsConsistency(projectDir, config, guardResults) {
|
|
|
33
35
|
// ── Collect actual metrics ──
|
|
34
36
|
const actuals = {};
|
|
35
37
|
|
|
36
|
-
// Guard check count
|
|
38
|
+
// Guard check count is configuration-dependent, so it comes from this run.
|
|
39
|
+
// Validator count is a package capability: it must not shrink when a project
|
|
40
|
+
// disables a validator. Resolve this module's installed directory rather
|
|
41
|
+
// than projectDir, which points at the consumer repository.
|
|
37
42
|
if (guardResults && Array.isArray(guardResults)) {
|
|
38
43
|
const totalChecks = guardResults.reduce((sum, r) => {
|
|
39
44
|
if (r.status === 'skipped') return sum;
|
|
40
45
|
return sum + (r.total || 0);
|
|
41
46
|
}, 0);
|
|
42
|
-
// +1 because Metrics-Consistency itself hasn't been added to results yet
|
|
43
|
-
const validatorCount = guardResults.filter(r => r.status !== 'skipped').length + 1;
|
|
44
|
-
|
|
45
47
|
actuals.checks = totalChecks;
|
|
46
|
-
actuals.validators = validatorCount;
|
|
47
48
|
}
|
|
49
|
+
const shippedValidatorCount = countShippedValidators();
|
|
50
|
+
if (shippedValidatorCount !== null) actuals.validators = shippedValidatorCount;
|
|
48
51
|
|
|
49
52
|
// Test count — count test files on disk
|
|
50
53
|
const testFiles = findTestFiles(projectDir);
|
|
@@ -68,7 +71,7 @@ export function validateMetricsConsistency(projectDir, config, guardResults) {
|
|
|
68
71
|
// subject before overwriting.
|
|
69
72
|
const patterns = [
|
|
70
73
|
{ key: 'checks', regex: /(?<!\d\/)\b(\d{2,})\s+(?:automated\s+)?checks?\b/gi, label: 'checks', requireBind: true, subject: "DocGuard's own", actualSource: 'docguard.guard.checks' },
|
|
71
|
-
{ key: 'validators', regex: /(?<!\d\/)\b(\d{2,})\s+validators?\b/gi, label: 'validators', requireBind: true, subject: "DocGuard's
|
|
74
|
+
{ key: 'validators', regex: /(?<!\d\/)\b(\d{2,})\s+validators?\b/gi, label: 'validators', requireBind: true, subject: "DocGuard's shipped", actualSource: 'docguard.package.validators' },
|
|
72
75
|
];
|
|
73
76
|
|
|
74
77
|
// v0.29 (field report #6): project-declared collections. `config.collections`
|
|
@@ -245,6 +248,15 @@ function isHistoricalMetricContext(content, index) {
|
|
|
245
248
|
return /<!--\s*docguard:status\s+(?:historical|superseded|deprecated|archived)\s*-->/i.test(prefix);
|
|
246
249
|
}
|
|
247
250
|
|
|
251
|
+
/**
|
|
252
|
+
* Count validator modules shipped beside this file. This is deliberately
|
|
253
|
+
* package-local: a consumer's disabled validators or repository layout cannot
|
|
254
|
+
* alter a statement about DocGuard's own capability surface.
|
|
255
|
+
*/
|
|
256
|
+
function countShippedValidators() {
|
|
257
|
+
return countValidatorModules(dirname(fileURLToPath(import.meta.url)));
|
|
258
|
+
}
|
|
259
|
+
|
|
248
260
|
function findTestFiles(dir) {
|
|
249
261
|
const tests = [];
|
|
250
262
|
const testDirs = ['tests', 'test', '__tests__', 'spec', 'e2e'];
|
|
@@ -1,8 +1,9 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* TODO/FIXME Tracking Validator — Ensures code annotations are documented
|
|
3
3
|
*
|
|
4
|
-
* Scans source files for
|
|
5
|
-
* if they are tracked in documentation
|
|
4
|
+
* Scans source files for debt tags (todo / fixme / hack / xxx, with a
|
|
5
|
+
* trailing colon or paren) and checks if they are tracked in documentation
|
|
6
|
+
* (ROADMAP.md, CURRENT-STATE.md, etc.).
|
|
6
7
|
*
|
|
7
8
|
* Also detects skipped tests without explanation.
|
|
8
9
|
*
|
|
@@ -33,7 +33,11 @@ import {
|
|
|
33
33
|
requirementPatterns,
|
|
34
34
|
} from '../shared-requirements.mjs';
|
|
35
35
|
import { readRetirementManifest } from '../scanners/retirement-manifest.mjs';
|
|
36
|
-
import {
|
|
36
|
+
import {
|
|
37
|
+
parseSpecId,
|
|
38
|
+
trustedSpecLifecycleIndex,
|
|
39
|
+
uncommittedPlannedSpecLifecycleIndex,
|
|
40
|
+
} from '../scanners/spec-registry.mjs';
|
|
37
41
|
|
|
38
42
|
/**
|
|
39
43
|
* Optional graphify interop (github.com/Graphify-Labs/graphify, MIT).
|
|
@@ -278,6 +282,7 @@ function validateRequirementTraceability(projectDir, config, projectFiles) {
|
|
|
278
282
|
const reqIds = collectRequirementIds(projectDir, config, patterns);
|
|
279
283
|
const retiredReqIds = loadRetiredRequirementIds(projectDir);
|
|
280
284
|
const lifecycleIndex = trustedSpecLifecycleIndex(projectDir);
|
|
285
|
+
const uncommittedPlannedIndex = uncommittedPlannedSpecLifecycleIndex(projectDir);
|
|
281
286
|
|
|
282
287
|
// ── Step 2: Scan test files for requirement ID references ──
|
|
283
288
|
const testRefs = scanTestFilesForReferences(projectDir, projectFiles, patterns);
|
|
@@ -305,11 +310,13 @@ function validateRequirementTraceability(projectDir, config, projectFiles) {
|
|
|
305
310
|
// digest-current reviewed lifecycle can defer their test linkage.
|
|
306
311
|
for (const [key, location] of reqIds) {
|
|
307
312
|
const reqId = location.id;
|
|
308
|
-
const
|
|
313
|
+
const lifecycleKey = location.specId ? `${location.specId}\0${location.file}` : null;
|
|
314
|
+
const lifecycle = lifecycleKey ? lifecycleIndex.get(lifecycleKey) : null;
|
|
309
315
|
if (lifecycle?.delivery === 'planned') {
|
|
310
316
|
deferred++;
|
|
311
317
|
continue;
|
|
312
318
|
}
|
|
319
|
+
const uncommittedPlanned = lifecycleKey && uncommittedPlannedIndex.has(lifecycleKey);
|
|
313
320
|
if (location.specId && !lifecycle) lifecycleUnknown++;
|
|
314
321
|
total++;
|
|
315
322
|
if (resolvedRefs.has(key)) {
|
|
@@ -317,10 +324,12 @@ function validateRequirementTraceability(projectDir, config, projectFiles) {
|
|
|
317
324
|
} else {
|
|
318
325
|
// Try to recover a likely-but-unannotated test via TF-IDF cosine.
|
|
319
326
|
let softHint = '';
|
|
320
|
-
let softText =
|
|
327
|
+
let softText = uncommittedPlanned
|
|
328
|
+
? 'The on-disk lifecycle registry says this requirement is planned, but .docguard-specs.json is not a clean tracked Git artifact. Restore it to its committed state, or commit the registry and its current spec artifacts, before treating the requirement as deferred; do not add an @req marker merely to silence this warning.'
|
|
329
|
+
: `Review existing tests for this requirement. If a test verifies it, add an @req ${key} annotation or requirement ID test label; write a test only if behavioral coverage is actually missing.`;
|
|
321
330
|
const queryText = location.text && location.text.length > reqId.length ? location.text : reqId;
|
|
322
|
-
if (testCorpus === null) testCorpus = buildTestCorpus(projectDir, projectFiles);
|
|
323
|
-
if (testCorpus.length > 0) {
|
|
331
|
+
if (!uncommittedPlanned && testCorpus === null) testCorpus = buildTestCorpus(projectDir, projectFiles);
|
|
332
|
+
if (!uncommittedPlanned && testCorpus.length > 0) {
|
|
324
333
|
const ranked = rankBySimilarity(tokenize(queryText), testCorpus);
|
|
325
334
|
const top = ranked[0];
|
|
326
335
|
if (top && top.score >= softThreshold) {
|
package/docs/quickstart.md
CHANGED
|
@@ -68,7 +68,7 @@ diagnose → AI reads prompts → AI fixes docs → guard verifies
|
|
|
68
68
|
## Verify
|
|
69
69
|
|
|
70
70
|
```bash
|
|
71
|
-
npx docguard-cli guard # Pass/fail check (
|
|
71
|
+
npx docguard-cli guard # Pass/fail check (29 validators)
|
|
72
72
|
npx docguard-cli score # 0-100 maturity score
|
|
73
73
|
```
|
|
74
74
|
|
|
@@ -3,7 +3,7 @@ schema_version: "1.0"
|
|
|
3
3
|
extension:
|
|
4
4
|
id: "docguard"
|
|
5
5
|
name: "DocGuard — CDD Enforcement"
|
|
6
|
-
version: "0.41.
|
|
6
|
+
version: "0.41.4"
|
|
7
7
|
description: "Documentation integrity for AI-assisted repositories: lifecycle registry, drift validation, traceability, safe archival, SARIF/JUnit, MCP, GitHub Actions, and Spec Kit hooks."
|
|
8
8
|
author: "Ricardo Accioly"
|
|
9
9
|
repository: "https://github.com/raccioly/docguard"
|
|
@@ -6,10 +6,10 @@ description: AI-driven documentation repair with structured research workflow, t
|
|
|
6
6
|
compatibility: Requires DocGuard CLI installed (npm i -g docguard-cli or npx docguard-cli)
|
|
7
7
|
metadata:
|
|
8
8
|
author: docguard
|
|
9
|
-
version: 0.41.
|
|
9
|
+
version: 0.41.4
|
|
10
10
|
source: extensions/spec-kit-docguard/skills/docguard-fix
|
|
11
11
|
---
|
|
12
|
-
<!-- docguard:version: 0.41.
|
|
12
|
+
<!-- docguard:version: 0.41.4 -->
|
|
13
13
|
|
|
14
14
|
# DocGuard Fix Skill
|
|
15
15
|
|
|
@@ -7,10 +7,10 @@ description: Run DocGuard guard validation against Canonical-Driven Development
|
|
|
7
7
|
compatibility: Requires DocGuard CLI installed (npm i -g docguard-cli or npx docguard-cli)
|
|
8
8
|
metadata:
|
|
9
9
|
author: docguard
|
|
10
|
-
version: 0.41.
|
|
10
|
+
version: 0.41.4
|
|
11
11
|
source: extensions/spec-kit-docguard/skills/docguard-guard
|
|
12
12
|
---
|
|
13
|
-
<!-- docguard:version: 0.41.
|
|
13
|
+
<!-- docguard:version: 0.41.4 -->
|
|
14
14
|
|
|
15
15
|
# DocGuard Guard Skill
|
|
16
16
|
|
|
@@ -6,10 +6,10 @@ description: Cross-document consistency analysis and quality assessment. Perform
|
|
|
6
6
|
compatibility: Requires DocGuard CLI installed (npm i -g docguard-cli or npx docguard-cli)
|
|
7
7
|
metadata:
|
|
8
8
|
author: docguard
|
|
9
|
-
version: 0.41.
|
|
9
|
+
version: 0.41.4
|
|
10
10
|
source: extensions/spec-kit-docguard/skills/docguard-review
|
|
11
11
|
---
|
|
12
|
-
<!-- docguard:version: 0.41.
|
|
12
|
+
<!-- docguard:version: 0.41.4 -->
|
|
13
13
|
|
|
14
14
|
# DocGuard Review Skill
|
|
15
15
|
|
|
@@ -6,10 +6,10 @@ description: CDD maturity assessment with category-aware improvement roadmap. Ru
|
|
|
6
6
|
compatibility: Requires DocGuard CLI installed (npm i -g docguard-cli or npx docguard-cli)
|
|
7
7
|
metadata:
|
|
8
8
|
author: docguard
|
|
9
|
-
version: 0.41.
|
|
9
|
+
version: 0.41.4
|
|
10
10
|
source: extensions/spec-kit-docguard/skills/docguard-score
|
|
11
11
|
---
|
|
12
|
-
<!-- docguard:version: 0.41.
|
|
12
|
+
<!-- docguard:version: 0.41.4 -->
|
|
13
13
|
|
|
14
14
|
# DocGuard Score Skill
|
|
15
15
|
|
|
@@ -4,10 +4,10 @@ description: Keep canonical documentation ALWAYS UP TO DATE. Refreshes code-trut
|
|
|
4
4
|
compatibility: Requires DocGuard CLI installed (npm i -g docguard-cli or npx docguard-cli)
|
|
5
5
|
metadata:
|
|
6
6
|
author: docguard
|
|
7
|
-
version: 0.41.
|
|
7
|
+
version: 0.41.4
|
|
8
8
|
source: extensions/spec-kit-docguard/skills/docguard-sync
|
|
9
9
|
---
|
|
10
|
-
<!-- docguard:version: 0.41.
|
|
10
|
+
<!-- docguard:version: 0.41.4 -->
|
|
11
11
|
|
|
12
12
|
# DocGuard Sync Skill
|
|
13
13
|
|
package/package.json
CHANGED