Cover provider seed markers

Recognize both slash- and dollar-prefixed prescribed seed markers and exercise each variant in coverage tests.

AI assistance: Codex addressed Cursor and Copilot review feedback and reran validation under maintainer authorization.
This commit is contained in:
Paul Bakaus
2026-07-31 17:32:57 -07:00
parent c91047d66a
commit a3d7b247aa
2 changed files with 32 additions and 25 deletions
+6 -3
View File
@@ -129,8 +129,10 @@ function hasCoverageValue(value) {
return false;
}
const SEED_DESIGN_MARKER = '<!-- SEED: established with the user before implementation; '
+ "re-run /impeccable document once there's code to capture the actual tokens and components. -->";
const SEED_DESIGN_MARKERS = ['/', '$'].map((prefix) =>
'<!-- SEED: established with the user before implementation; '
+ `re-run ${prefix}impeccable document once there's code to capture the actual tokens and components. -->`
);
export function checkDesignCoverage({ design, designPath, parseDesignMd }) {
if (!design || typeof parseDesignMd !== 'function') return [];
@@ -140,7 +142,8 @@ export function checkDesignCoverage({ design, designPath, parseDesignMd }) {
} catch {
return [];
}
const requiredSections = design.includes(SEED_DESIGN_MARKER)
const isSeed = SEED_DESIGN_MARKERS.some((marker) => design.includes(marker));
const requiredSections = isSeed
? ['colors', 'typography']
: ['colors', 'typography', 'components'];
const missing = requiredSections
+26 -22
View File
@@ -173,31 +173,35 @@ describe('checkDesignCoverage', () => {
});
it('allows Components to be absent from a marked seed document', () => {
const design = [
'<!-- SEED: established with the user before implementation; re-run /impeccable document once there\'s code to capture the actual tokens and components. -->',
'',
'# Design System: X',
'',
'## Colors', '', '### Primary', '- **Ink** (#111): Text.', '',
'## Typography', '', '**Body Font:** Inter', '',
'### Hierarchy', '- **Body** (400, 16px, 1.5): Paragraphs.', '',
].join('\n');
assert.deepEqual(checkDesignCoverage({ design, designPath: 'DESIGN.md', parseDesignMd }), []);
for (const command of ['/impeccable', '$impeccable']) {
const design = [
`<!-- SEED: established with the user before implementation; re-run ${command} document once there's code to capture the actual tokens and components. -->`,
'',
'# Design System: X',
'',
'## Colors', '', '### Primary', '- **Ink** (#111): Text.', '',
'## Typography', '', '**Body Font:** Inter', '',
'### Hierarchy', '- **Body** (400, 16px, 1.5): Paragraphs.', '',
].join('\n');
assert.deepEqual(checkDesignCoverage({ design, designPath: 'DESIGN.md', parseDesignMd }), []);
}
});
it('still requires seed documents to cover Colors and Typography', () => {
const design = [
'<!-- SEED: established with the user before implementation; re-run /impeccable document once there\'s code to capture the actual tokens and components. -->',
'',
'# Design System: X',
'',
'## Typography', '', '**Body Font:** Inter', '',
'### Hierarchy', '- **Body** (400, 16px, 1.5): Paragraphs.', '',
].join('\n');
const findings = checkDesignCoverage({ design, designPath: 'DESIGN.md', parseDesignMd });
assert.deepEqual(ids(findings), ['design-md-coverage']);
assert.match(findings[0].summary, /no colors section/);
assert.doesNotMatch(findings[0].summary, /components/);
for (const command of ['/impeccable', '$impeccable']) {
const design = [
`<!-- SEED: established with the user before implementation; re-run ${command} document once there's code to capture the actual tokens and components. -->`,
'',
'# Design System: X',
'',
'## Typography', '', '**Body Font:** Inter', '',
'### Hierarchy', '- **Body** (400, 16px, 1.5): Paragraphs.', '',
].join('\n');
const findings = checkDesignCoverage({ design, designPath: 'DESIGN.md', parseDesignMd });
assert.deepEqual(ids(findings), ['design-md-coverage']);
assert.match(findings[0].summary, /no colors section/);
assert.doesNotMatch(findings[0].summary, /components/);
}
});
it('counts machine-readable frontmatter as section coverage', () => {