* chore(#604): rename get-shit-done/ runtime directory to gsd-core/ Renames the installed runtime directory `get-shit-done/` to `gsd-core/` so the on-disk name matches the package (`@opengsd/gsd-core`), repo, and binary (`gsd-tools`). The npm package name and binary are unchanged; npx/npm consumers are unaffected. Mechanical (bulk, ~90% of the diff): - `git mv get-shit-done gsd-core` - Swept path/identifier references across the repo via `perl -pe 's/get-shit-done(?!-\w)/gsd-core/g'`. The negative lookahead preserves the five legitimate slug variants that are NOT the directory: get-shit-done-{OLD,cc,classic,cli,redux} (old package/repo names). - Build/manifest wiring: package.json (bin, files, coverage globs), tsconfig.build.json (outDir), ~86 .gitignore build-output entries, stryker.config.mjs, scan-ignore files, install.js path strings. - Frozen (not rewritten): CHANGELOG.md history; translated docs (README.<locale>.md and docs/{ja-JP,ko-KR,pt-BR,zh-CN}/). New logic (review here): - src/installer-migrations/003-rename-get-shit-done-to-gsd-core.cts: a proper ADR-0008 installer migration. On upgrade it walks the legacy `~/.claude/get-shit-done/` tree, classifies each file via the prior install manifest, and emits remove-managed / backup-and-remove for managed files while PRESERVING unknown user-added files. Symlink-safe (skips a symlinked root and symlinked entries; bounds-checks every path under configDir). The framework rolls back on install failure. Emptied dirs may remain (framework has no recursive dir-removal primitive) — documented. - scripts/lint-legacy-dir-name.cjs: CI regression guard forbidding the bare `get-shit-done` directory token (split token to avoid self-match; case- insensitive; `(?!-\w)` lookahead allows the slug variants; allowlists CHANGELOG, translated docs, and `gsd-allow-legacy-name` marker lines). Wired into the lint-tests CI job. - Restored scripts/lint-package-identity-drift.cjs detection regexes (the mechanical sweep had wrongly rewritten the old-name patterns it exists to detect) and marked them as intentional legacy references. - TDD tests for the migration and the guard; do.md slash-command guard regex tightened so a `/gsd-core/bin` path segment is not mistaken for a command; changeset + docs/installer-migrations.md row added. Breaking: the installed runtime path moves `~/.claude/get-shit-done/` -> `~/.claude/gsd-core/`. Migration 003 removes the stale legacy dir's managed files (preserving user files) on upgrade. Users with custom hooks/configs hardcoding the old path must update them. Closes #604 Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> * fix(#604): unsweep pending changesets + allowlist injection-example docs CI fixes for the rename PR: - Do not sweep pending .changeset/*.md (ephemeral release-note fragments, like CHANGELOG); reverted those body edits so 5 pre-existing malformed fragments (missing type/pr) no longer enter the PR diff and trip docs-lint. Allowlisted .changeset/ in the legacy-name guard accordingly. - Allowlisted TEST-EXAMPLES.md and docs/explanation/security-model.md in prompt-injection-scan.sh: they contain intentional injection examples / security-model prose; the path-reference rewrites are kept. CodeQL alerts on this PR are pre-existing (alert lines unchanged by this PR; none in the new migration/guard) and are out of scope for the rename. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> * fix(#604): resolve CodeQL alerts surfaced on this PR The rename diff touched files carrying pre-existing CodeQL findings; per the no-pre-existing-dismissal rule, fixing every surfaced alert rather than waving them off. All behavior-preserving: - scripts/ci-test-scope.cjs: build the config-path match from string .includes() instead of a RegExp over an arg-derived value (js/regex-injection). - src/profile-output.cts: escape backslashes before pipe-escaping desc/safeName so the table-cell escape is complete (js/incomplete-sanitization). - tests/{bug-2643,bug-2808,docs-parity-live-registry}: two-pass HTML-comment strip so a bare/unclosed `<!--` cannot survive (js/incomplete-multi-character-sanitization). - tests/inline-plan-threshold: drop the no-op `\s`->`\s` identity replace, keep the meaningful POSIX-class conversion (js/identity-replacement). Verified: build:lib green; the touched test files + ci-test-scope + profile-output suites pass; lint:legacy-name clean. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> * fix(#604): correctly resolve remaining CodeQL alerts (regex-injection + sanitization) The prior commit's fixes for two alerts were ineffective: - ci-test-scope.cjs js/regex-injection: the alert is the CLI-arg-derived `file` reaching static regex `.test(file)` calls (not the config rule). Removed ALL regex over file/t — startsWith/includes/=== string checks + an isWindowsHint helper — so there is no regex sink for the tainted value. - js/incomplete-multi-character-sanitization (3 test files): a single `.replace(/<!--...-->/g,'')` can let `<!--` re-form. Replaced with a fixpoint loop (replace until stable) plus a final bare-opener strip. Verified: no regex over file/t remains; ci-test-scope + the 3 test suites pass; lint:legacy-name clean. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> * fix(#604): make ci-test-scope + comment-strippers regex-free to clear CodeQL CodeQL flags the regex PATTERNS syntactically (regex-injection on the --files arg split; incomplete-multi-character-sanitization on the <!--...--> replace), so loop fixes do not satisfy it. Made these paths regex-free: - ci-test-scope.cjs splitFiles: char-by-char separator tokenizer (no /[,\\s]+/). - 3 test files: indexOf/slice HTML-comment stripper (no .replace(/<!--/)). Behavior preserved; ci-test-scope + the 3 suites pass; guard clean. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> * fix(#604): unblock security base64 scan on the large rename diff The security job hit its 10m timeout: base64-scan.sh choked on the binary test fixture tests/feat-3594-parser-property-style.test.cjs (embedded NUL/ non-UTF8 bytes -> thousands of bogus blobs + "ignored null byte" warnings), and the ~800-file rename diff is slow to scan regardless. - scripts/base64-scan.sh: skip binary-by-content files (grep -Iq .) — they can't carry base64-obfuscated *text* and feeding NUL bytes through the per-line scanner is pathologically slow. collect_files already filtered binary *extensions*; this catches binary *content* in text extensions. - .github/workflows/security-scan.yml: raise the security job timeout 10m->30m to accommodate very large diffs (the scan itself is unchanged). Verified locally: scan skips the fixture, 0 "ignored null byte" warnings, 0 findings, exit 0. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> * fix(#604): sweep get-shit-done refs introduced by merging next The branch was updated with next (#614/#384/#618 etc.), which reference the get-shit-done/ dir (still named that on next). Swept the stale references in the merged files to gsd-core so the rename stays consistent and lint:legacy-name passes: - commands/gsd/discuss-phase.md (runtime-launcher shim paths) - src/core.cts (getAgentsDir layout comments) - tests/bug-384-agents-runtime-aware.test.cjs (require path to runtime lib) Verified: guard 0 violations; build green. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> * fix(#604): exclude gsd-core/ path segments from bug-3683 command cross-ref invariant The #614 runtime-launcher shim added to discuss-phase.md references `${_GSD_RUNTIME_ROOT}/gsd-core/bin/...`. bug-3683's REF_PATTERN excluded path-y refs only via lookbehind, but `}` precedes `/gsd-core/` in the shim, so it mis-read the directory path as a dangling `/gsd-core` command ref (same class as the #604 bug-2954 fix). Added a trailing `(?![\w-]*\/)` so `/gsd-<x>/...` path segments are not treated as slash-command references. Verified locally on BOTH platforms before pushing: - mac (node 26) full suite: 0 failures - gsd-test-runner (linux, node22 image) full suite: 0 failures - bug-3683 + bug-2954 pass. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> * fix(#604): lazily resolve findProjectRoot in gsd-tools (harden flaky CI) CI intermittently failed state.test's gsd-tools subprocess with "findProjectRoot is not a function" (flip-flopping across legs; not reproducible on mac full suite, gsd-test linux full suite, test:unit, or state.test x8). findProjectRoot is a re-export from core.cjs (sourced from project-root.cjs); binding it via destructure at module-load can be undefined under a load-ordering edge. Resolve it lazily at call time via a small wrapper so the lookup happens after core.cjs is fully initialized. Verified green on BOTH platforms before pushing: - mac (node 26) full suite: 0 failures - gsd-test-runner (linux, node22) full suite: 0 failures - state.test.cjs: 106/106; gsd-tools loads cleanly. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> * fix(#604): allowlist verification-patterns.md placeholder examples in secret scan The rename git-mv'd references/verification-patterns.md into gsd-core/, pulling it into the secret-scan diff. It documents stub/placeholder RED-FLAG env-var examples (illustrative Stripe test-key / database-URL / API-key placeholders) — not real credentials. Added it to .secretscanignore with the strict annotation, mirroring the existing gsd-core/workflows/plan-phase.md exception. Verified locally: secret-scan-lint --strict OK; secret-scan --diff origin/next exits 0 with 0 findings. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com>
1126 lines
38 KiB
JavaScript
1126 lines
38 KiB
JavaScript
'use strict';
|
|
|
|
/**
|
|
* Unit tests for frontmatter.cjs
|
|
*
|
|
* Module: gsd-core/bin/lib/frontmatter.cjs
|
|
*
|
|
* Covers:
|
|
* - extractFrontmatter: all scalar types, quoted, arrays, nested, edge cases
|
|
* - reconstructFrontmatter: exact output for every branch
|
|
* - spliceFrontmatter: with/without existing frontmatter
|
|
* - parseMustHavesBlock: all branches
|
|
* - FRONTMATTER_SCHEMAS: exact keys
|
|
*/
|
|
|
|
const { describe, test } = require('node:test');
|
|
const assert = require('node:assert/strict');
|
|
|
|
const {
|
|
extractFrontmatter,
|
|
reconstructFrontmatter,
|
|
spliceFrontmatter,
|
|
parseMustHavesBlock,
|
|
FRONTMATTER_SCHEMAS,
|
|
} = require('../gsd-core/bin/lib/frontmatter.cjs');
|
|
|
|
// ─── extractFrontmatter ───────────────────────────────────────────────────────
|
|
|
|
describe('extractFrontmatter: no frontmatter', () => {
|
|
test('plain text returns {}', () => {
|
|
assert.deepEqual(extractFrontmatter('just plain text'), {});
|
|
});
|
|
|
|
test('empty string returns {}', () => {
|
|
assert.deepEqual(extractFrontmatter(''), {});
|
|
});
|
|
|
|
test('--- not at start returns {}', () => {
|
|
assert.deepEqual(extractFrontmatter('content\n---\nkey: val\n---\n'), {});
|
|
});
|
|
|
|
test('--- block without closing delimiter returns {}', () => {
|
|
assert.deepEqual(extractFrontmatter('---\ntitle: Hello\nauthor: World\n'), {});
|
|
});
|
|
|
|
test('only --- returns {}', () => {
|
|
assert.deepEqual(extractFrontmatter('---\n---'), {});
|
|
});
|
|
|
|
test('empty frontmatter block returns {}', () => {
|
|
assert.deepEqual(extractFrontmatter('---\n\n---\nBody'), {});
|
|
});
|
|
|
|
test('heading only returns {}', () => {
|
|
assert.deepEqual(extractFrontmatter('# Just a heading\ncontent'), {});
|
|
});
|
|
});
|
|
|
|
describe('extractFrontmatter: simple scalar values', () => {
|
|
test('single string key-value', () => {
|
|
const result = extractFrontmatter('---\ntitle: Hello\n---\nBody');
|
|
assert.deepEqual(result, { title: 'Hello' });
|
|
});
|
|
|
|
test('multiple string key-values', () => {
|
|
const result = extractFrontmatter('---\ntitle: Hello\nauthor: World\n---\n');
|
|
assert.deepEqual(result, { title: 'Hello', author: 'World' });
|
|
});
|
|
|
|
test('numeric string value preserved as string', () => {
|
|
const result = extractFrontmatter('---\ncount: 42\n---');
|
|
assert.deepEqual(result, { count: '42' });
|
|
assert.equal(result.count, '42');
|
|
});
|
|
|
|
test('boolean string value preserved as string', () => {
|
|
const result = extractFrontmatter('---\nflag: true\n---');
|
|
assert.deepEqual(result, { flag: 'true' });
|
|
assert.equal(result.flag, 'true');
|
|
});
|
|
|
|
test('null string value preserved as string', () => {
|
|
const result = extractFrontmatter('---\nnone: null\n---');
|
|
assert.deepEqual(result, { none: 'null' });
|
|
assert.equal(result.none, 'null');
|
|
});
|
|
|
|
test('false string value preserved as string', () => {
|
|
const result = extractFrontmatter('---\ndone: false\n---');
|
|
assert.deepEqual(result, { done: 'false' });
|
|
});
|
|
|
|
test('value with internal spaces preserved', () => {
|
|
const result = extractFrontmatter('---\nphase: phase one\n---');
|
|
assert.deepEqual(result, { phase: 'phase one' });
|
|
});
|
|
|
|
test('trailing whitespace in value is trimmed', () => {
|
|
const result = extractFrontmatter('---\ntitle: Hello \n---');
|
|
assert.deepEqual(result, { title: 'Hello' });
|
|
});
|
|
|
|
test('key with underscore', () => {
|
|
const result = extractFrontmatter('---\nmy_key: val\n---');
|
|
assert.deepEqual(result, { my_key: 'val' });
|
|
});
|
|
|
|
test('key with hyphen', () => {
|
|
const result = extractFrontmatter('---\nmy-key: val\n---');
|
|
assert.deepEqual(result, { 'my-key': 'val' });
|
|
});
|
|
|
|
test('key with digits', () => {
|
|
const result = extractFrontmatter('---\nkey123: val\n---');
|
|
assert.deepEqual(result, { key123: 'val' });
|
|
});
|
|
|
|
test('empty line in frontmatter is skipped', () => {
|
|
const result = extractFrontmatter('---\nkey1: val1\n\nkey2: val2\n---');
|
|
assert.deepEqual(result, { key1: 'val1', key2: 'val2' });
|
|
});
|
|
|
|
test('body content after closing delimiter is ignored', () => {
|
|
const result = extractFrontmatter('---\ntitle: Hello\n---\n# Heading\nContent here');
|
|
assert.deepEqual(result, { title: 'Hello' });
|
|
assert.equal(Object.keys(result).length, 1);
|
|
});
|
|
});
|
|
|
|
describe('extractFrontmatter: quoted values', () => {
|
|
test('double-quoted value strips quotes', () => {
|
|
const result = extractFrontmatter('---\ntitle: "Hello World"\n---');
|
|
assert.deepEqual(result, { title: 'Hello World' });
|
|
});
|
|
|
|
test('single-quoted value strips quotes', () => {
|
|
const result = extractFrontmatter("---\ntitle: 'Hello World'\n---");
|
|
assert.deepEqual(result, { title: 'Hello World' });
|
|
});
|
|
|
|
test('double-quoted value containing colon', () => {
|
|
const result = extractFrontmatter('---\nurl: "http://example.com"\n---');
|
|
assert.deepEqual(result, { url: 'http://example.com' });
|
|
});
|
|
|
|
test('unquoted value with no special chars', () => {
|
|
const result = extractFrontmatter('---\nname: simple\n---');
|
|
assert.deepEqual(result, { name: 'simple' });
|
|
assert.equal(result.name, 'simple');
|
|
});
|
|
});
|
|
|
|
describe('extractFrontmatter: CRLF line endings', () => {
|
|
test('CRLF frontmatter parses correctly', () => {
|
|
const result = extractFrontmatter('---\r\ntitle: Hello\r\nauthor: World\r\n---\r\nBody');
|
|
assert.deepEqual(result, { title: 'Hello', author: 'World' });
|
|
});
|
|
|
|
test('CRLF with array values', () => {
|
|
const result = extractFrontmatter('---\r\ntags: [a, b, c]\r\n---\r\n');
|
|
assert.deepEqual(result, { tags: ['a', 'b', 'c'] });
|
|
});
|
|
});
|
|
|
|
describe('extractFrontmatter: inline arrays', () => {
|
|
test('empty inline array []', () => {
|
|
const result = extractFrontmatter('---\ntags: []\n---');
|
|
assert.deepEqual(result, { tags: [] });
|
|
assert.ok(Array.isArray(result.tags));
|
|
assert.equal(result.tags.length, 0);
|
|
});
|
|
|
|
test('single item inline array', () => {
|
|
const result = extractFrontmatter('---\ntags: [only]\n---');
|
|
assert.deepEqual(result, { tags: ['only'] });
|
|
assert.equal(result.tags.length, 1);
|
|
});
|
|
|
|
test('two item inline array', () => {
|
|
const result = extractFrontmatter('---\ntags: [a, b]\n---');
|
|
assert.deepEqual(result, { tags: ['a', 'b'] });
|
|
});
|
|
|
|
test('three item inline array', () => {
|
|
const result = extractFrontmatter('---\ntags: [a, b, c]\n---');
|
|
assert.deepEqual(result, { tags: ['a', 'b', 'c'] });
|
|
});
|
|
|
|
test('inline array with spaces around items', () => {
|
|
const result = extractFrontmatter('---\ntags: [ a , b , c ]\n---');
|
|
assert.deepEqual(result, { tags: ['a', 'b', 'c'] });
|
|
});
|
|
|
|
test('inline array with double-quoted item containing comma', () => {
|
|
const result = extractFrontmatter('---\ntags: ["a, b", c]\n---');
|
|
assert.deepEqual(result, { tags: ['a, b', 'c'] });
|
|
});
|
|
|
|
test('inline array with single-quoted item containing comma', () => {
|
|
const result = extractFrontmatter("---\ntags: ['a, b', c]\n---");
|
|
assert.deepEqual(result, { tags: ['a, b', 'c'] });
|
|
});
|
|
|
|
test('inline array with quoted item plus more items', () => {
|
|
const result = extractFrontmatter('---\ntags: ["a, b", c, d]\n---');
|
|
assert.deepEqual(result, { tags: ['a, b', 'c', 'd'] });
|
|
});
|
|
|
|
test('consecutive commas (empty items filtered)', () => {
|
|
const result = extractFrontmatter('---\ntags: [a,,b]\n---');
|
|
assert.deepEqual(result, { tags: ['a', 'b'] });
|
|
});
|
|
|
|
test('whitespace-only items filtered', () => {
|
|
const result = extractFrontmatter('---\ntags: [ , ]\n---');
|
|
assert.deepEqual(result, { tags: [] });
|
|
});
|
|
|
|
test('opening bracket only becomes empty array/object', () => {
|
|
const result = extractFrontmatter('---\ntags: [\n---');
|
|
assert.deepEqual(result, { tags: [] });
|
|
assert.ok(Array.isArray(result.tags));
|
|
});
|
|
});
|
|
|
|
describe('extractFrontmatter: dashed list arrays', () => {
|
|
test('two-item dashed list', () => {
|
|
const result = extractFrontmatter('---\ntags:\n - a\n - b\n---');
|
|
assert.deepEqual(result, { tags: ['a', 'b'] });
|
|
assert.ok(Array.isArray(result.tags));
|
|
});
|
|
|
|
test('single-item dashed list', () => {
|
|
const result = extractFrontmatter('---\ntags:\n - solo\n---');
|
|
assert.deepEqual(result, { tags: ['solo'] });
|
|
});
|
|
|
|
test('dashed list with double-quoted item', () => {
|
|
const result = extractFrontmatter('---\ntags:\n - "quoted value"\n---');
|
|
assert.deepEqual(result, { tags: ['quoted value'] });
|
|
});
|
|
|
|
test('dashed list with single-quoted item', () => {
|
|
const result = extractFrontmatter("---\ntags:\n - 'single quoted'\n---");
|
|
assert.deepEqual(result, { tags: ['single quoted'] });
|
|
});
|
|
|
|
test('opening bracket followed by dashed list', () => {
|
|
const result = extractFrontmatter('---\ntags: [\n - a\n - b\n---');
|
|
assert.deepEqual(result, { tags: ['a', 'b'] });
|
|
});
|
|
});
|
|
|
|
describe('extractFrontmatter: empty / missing values', () => {
|
|
test('empty value becomes empty object {}', () => {
|
|
const result = extractFrontmatter('---\ntitle:\n---');
|
|
assert.deepEqual(result, { title: {} });
|
|
assert.equal(typeof result.title, 'object');
|
|
assert.ok(!Array.isArray(result.title));
|
|
});
|
|
|
|
test('empty value followed by next key', () => {
|
|
const result = extractFrontmatter('---\ntitle:\nother: val\n---');
|
|
assert.equal(typeof result.title, 'object');
|
|
assert.equal(result.other, 'val');
|
|
});
|
|
});
|
|
|
|
describe('extractFrontmatter: nested objects', () => {
|
|
test('one level of nesting', () => {
|
|
const result = extractFrontmatter('---\nmeta:\n key: val\n count: 10\n---');
|
|
assert.deepEqual(result, { meta: { key: 'val', count: '10' } });
|
|
});
|
|
|
|
test('nested then back to top level', () => {
|
|
const result = extractFrontmatter('---\nmeta:\n sub: val\ntop: parent\n---');
|
|
assert.deepEqual(result, { meta: { sub: 'val' }, top: 'parent' });
|
|
});
|
|
|
|
test('multiple nested objects', () => {
|
|
const result = extractFrontmatter('---\na:\n k1: v1\nb:\n k2: v2\n---');
|
|
assert.deepEqual(result, { a: { k1: 'v1' }, b: { k2: 'v2' } });
|
|
});
|
|
|
|
test('two levels of nesting', () => {
|
|
const result = extractFrontmatter('---\ntop:\n mid:\n deep: value\n---');
|
|
assert.deepEqual(result, { top: { mid: { deep: 'value' } } });
|
|
});
|
|
|
|
test('nested numeric-string value', () => {
|
|
const result = extractFrontmatter('---\nmeta:\n count: 42\n---');
|
|
assert.deepEqual(result, { meta: { count: '42' } });
|
|
});
|
|
});
|
|
|
|
describe('extractFrontmatter: return type invariants', () => {
|
|
test('always returns plain object', () => {
|
|
const result = extractFrontmatter('random content');
|
|
assert.equal(typeof result, 'object');
|
|
assert.ok(result !== null);
|
|
assert.ok(!Array.isArray(result));
|
|
});
|
|
|
|
test('return value is not null', () => {
|
|
const result = extractFrontmatter('');
|
|
assert.ok(result !== null);
|
|
});
|
|
|
|
test('top-level dash item (no parent key) is ignored', () => {
|
|
const result = extractFrontmatter('---\n- item\n---');
|
|
assert.deepEqual(result, {});
|
|
});
|
|
|
|
test('key starting with digit still matches key pattern', () => {
|
|
const result = extractFrontmatter('---\n123key: val\n---');
|
|
assert.equal(result['123key'], 'val');
|
|
});
|
|
});
|
|
|
|
// ─── reconstructFrontmatter ───────────────────────────────────────────────────
|
|
|
|
describe('reconstructFrontmatter: empty input', () => {
|
|
test('empty object returns empty string', () => {
|
|
assert.equal(reconstructFrontmatter({}), '');
|
|
});
|
|
});
|
|
|
|
describe('reconstructFrontmatter: scalar values', () => {
|
|
test('simple string value', () => {
|
|
assert.equal(reconstructFrontmatter({ title: 'Hello' }), 'title: Hello');
|
|
});
|
|
|
|
test('numeric string value', () => {
|
|
assert.equal(reconstructFrontmatter({ count: '42' }), 'count: 42');
|
|
});
|
|
|
|
test('boolean string value', () => {
|
|
assert.equal(reconstructFrontmatter({ flag: 'true' }), 'flag: true');
|
|
});
|
|
|
|
test('null value is skipped', () => {
|
|
assert.equal(reconstructFrontmatter({ title: null }), '');
|
|
});
|
|
|
|
test('undefined value is skipped', () => {
|
|
assert.equal(reconstructFrontmatter({ title: undefined }), '');
|
|
});
|
|
|
|
test('value containing colon is double-quoted', () => {
|
|
assert.equal(reconstructFrontmatter({ url: 'http://example.com' }), 'url: "http://example.com"');
|
|
});
|
|
|
|
test('value containing hash is double-quoted', () => {
|
|
assert.equal(reconstructFrontmatter({ name: 'test#1' }), 'name: "test#1"');
|
|
});
|
|
|
|
test('value starting with [ is double-quoted', () => {
|
|
assert.equal(reconstructFrontmatter({ val: '[thing]' }), 'val: "[thing]"');
|
|
});
|
|
|
|
test('value starting with { is double-quoted', () => {
|
|
assert.equal(reconstructFrontmatter({ val: '{thing}' }), 'val: "{thing}"');
|
|
});
|
|
|
|
test('plain value without special chars is unquoted', () => {
|
|
assert.equal(reconstructFrontmatter({ name: 'simple' }), 'name: simple');
|
|
});
|
|
|
|
test('multiple keys produce newline-joined output', () => {
|
|
assert.equal(
|
|
reconstructFrontmatter({ title: 'Hello', author: 'World' }),
|
|
'title: Hello\nauthor: World'
|
|
);
|
|
});
|
|
});
|
|
|
|
describe('reconstructFrontmatter: arrays', () => {
|
|
test('empty array produces key: []', () => {
|
|
assert.equal(reconstructFrontmatter({ tags: [] }), 'tags: []');
|
|
});
|
|
|
|
test('two-item short array uses inline format', () => {
|
|
assert.equal(reconstructFrontmatter({ tags: ['a', 'b'] }), 'tags: [a, b]');
|
|
});
|
|
|
|
test('three-item short array uses inline format', () => {
|
|
assert.equal(reconstructFrontmatter({ tags: ['a', 'b', 'c'] }), 'tags: [a, b, c]');
|
|
});
|
|
|
|
test('three items whose join is exactly < 60 chars uses inline format', () => {
|
|
const tags = ['aaa', 'bbb', 'ccc'];
|
|
// 'aaa, bbb, ccc' = 13 chars
|
|
assert.equal(reconstructFrontmatter({ tags }), 'tags: [aaa, bbb, ccc]');
|
|
});
|
|
|
|
test('three items whose join >= 60 chars uses block format', () => {
|
|
const tags = ['aaaaaaaaaaaaaaaaaaa', 'bbbbbbbbbbbbbbbbbbb', 'cccccccccccccccccccc'];
|
|
// join is 61+ chars
|
|
assert.equal(
|
|
reconstructFrontmatter({ tags }),
|
|
'tags:\n - aaaaaaaaaaaaaaaaaaa\n - bbbbbbbbbbbbbbbbbbb\n - cccccccccccccccccccc'
|
|
);
|
|
});
|
|
|
|
test('four-item array uses block format', () => {
|
|
assert.equal(
|
|
reconstructFrontmatter({ tags: ['a', 'b', 'c', 'd'] }),
|
|
'tags:\n - a\n - b\n - c\n - d'
|
|
);
|
|
});
|
|
|
|
test('array item with colon is double-quoted in block format', () => {
|
|
// Need >3 items to force block format where quoting applies
|
|
const result = reconstructFrontmatter({ tags: ['a:b', 'c', 'd', 'e'] });
|
|
assert.ok(result.includes(' - "a:b"'), `Expected quoted item, got: ${result}`);
|
|
});
|
|
|
|
test('array item with hash is double-quoted in block format', () => {
|
|
// Need >3 items to force block format where quoting applies
|
|
const result = reconstructFrontmatter({ tags: ['a#b', 'c', 'd', 'e'] });
|
|
assert.ok(result.includes(' - "a#b"'), `Expected quoted hash item, got: ${result}`);
|
|
});
|
|
|
|
test('two-item array uses inline regardless of special chars', () => {
|
|
// Note: inline format for <=3 items uses join without quoting
|
|
assert.equal(reconstructFrontmatter({ tags: ['a:b', 'c'] }), 'tags: [a:b, c]');
|
|
});
|
|
|
|
test('array item without colon or hash is unquoted in block format', () => {
|
|
const result = reconstructFrontmatter({ tags: ['plain', 'also', 'here', 'fourth'] });
|
|
assert.equal(result, 'tags:\n - plain\n - also\n - here\n - fourth');
|
|
});
|
|
});
|
|
|
|
describe('reconstructFrontmatter: nested objects', () => {
|
|
test('simple nested object', () => {
|
|
assert.equal(
|
|
reconstructFrontmatter({ meta: { key: 'val', num: '42' } }),
|
|
'meta:\n key: val\n num: 42'
|
|
);
|
|
});
|
|
|
|
test('nested null subvalue is skipped', () => {
|
|
assert.equal(reconstructFrontmatter({ meta: { key: null } }), 'meta:');
|
|
});
|
|
|
|
test('nested undefined subvalue is skipped', () => {
|
|
assert.equal(reconstructFrontmatter({ meta: { key: undefined } }), 'meta:');
|
|
});
|
|
|
|
test('nested subvalue with colon is double-quoted', () => {
|
|
assert.equal(reconstructFrontmatter({ meta: { url: 'http://x' } }), 'meta:\n url: "http://x"');
|
|
});
|
|
|
|
test('nested subvalue with hash is double-quoted', () => {
|
|
assert.equal(reconstructFrontmatter({ meta: { name: 'x#y' } }), 'meta:\n name: "x#y"');
|
|
});
|
|
|
|
test('nested empty sub-array', () => {
|
|
assert.equal(reconstructFrontmatter({ meta: { items: [] } }), 'meta:\n items: []');
|
|
});
|
|
|
|
test('nested two-item short sub-array uses inline format', () => {
|
|
assert.equal(reconstructFrontmatter({ meta: { items: ['a', 'b'] } }), 'meta:\n items: [a, b]');
|
|
});
|
|
|
|
test('nested four-item sub-array uses block format', () => {
|
|
assert.equal(
|
|
reconstructFrontmatter({ meta: { items: ['a', 'b', 'c', 'd'] } }),
|
|
'meta:\n items:\n - a\n - b\n - c\n - d'
|
|
);
|
|
});
|
|
|
|
test('nested three-item short sub-array uses inline', () => {
|
|
assert.equal(
|
|
reconstructFrontmatter({ meta: { items: ['a', 'b', 'c'] } }),
|
|
'meta:\n items: [a, b, c]'
|
|
);
|
|
});
|
|
|
|
test('nested three-item long sub-array uses block', () => {
|
|
const items = ['aaaaaaaaaaaaaaaaaaa', 'bbbbbbbbbbbbbbbbbbb', 'cccccccccccccccccccc'];
|
|
assert.equal(
|
|
reconstructFrontmatter({ meta: { items } }),
|
|
'meta:\n items:\n - aaaaaaaaaaaaaaaaaaa\n - bbbbbbbbbbbbbbbbbbb\n - cccccccccccccccccccc'
|
|
);
|
|
});
|
|
|
|
test('nested nested object (3 levels)', () => {
|
|
assert.equal(
|
|
reconstructFrontmatter({ top: { mid: { deep: 'value' } } }),
|
|
'top:\n mid:\n deep: value'
|
|
);
|
|
});
|
|
|
|
test('deeply nested null subvalue skipped', () => {
|
|
assert.equal(
|
|
reconstructFrontmatter({ top: { mid: { key: null } } }),
|
|
'top:\n mid:'
|
|
);
|
|
});
|
|
|
|
test('deeply nested empty array', () => {
|
|
assert.equal(
|
|
reconstructFrontmatter({ top: { mid: { items: [] } } }),
|
|
'top:\n mid:\n items: []'
|
|
);
|
|
});
|
|
|
|
test('deeply nested array with items', () => {
|
|
assert.equal(
|
|
reconstructFrontmatter({ top: { mid: { items: ['a', 'b'] } } }),
|
|
'top:\n mid:\n items:\n - a\n - b'
|
|
);
|
|
});
|
|
});
|
|
|
|
// ─── spliceFrontmatter ────────────────────────────────────────────────────────
|
|
|
|
describe('spliceFrontmatter: no existing frontmatter', () => {
|
|
test('prepends frontmatter to plain body', () => {
|
|
assert.equal(
|
|
spliceFrontmatter('body text', { title: 'Test' }),
|
|
'---\ntitle: Test\n---\n\nbody text'
|
|
);
|
|
});
|
|
|
|
test('prepends frontmatter to empty string', () => {
|
|
assert.equal(
|
|
spliceFrontmatter('', { title: 'Test' }),
|
|
'---\ntitle: Test\n---\n\n'
|
|
);
|
|
});
|
|
|
|
test('prepends frontmatter with empty object', () => {
|
|
assert.equal(
|
|
spliceFrontmatter('body text', {}),
|
|
'---\n\n---\n\nbody text'
|
|
);
|
|
});
|
|
|
|
test('prepends multi-key frontmatter', () => {
|
|
const result = spliceFrontmatter('# Body', { title: 'T', author: 'A' });
|
|
assert.equal(result, '---\ntitle: T\nauthor: A\n---\n\n# Body');
|
|
});
|
|
});
|
|
|
|
describe('spliceFrontmatter: existing frontmatter', () => {
|
|
test('replaces existing frontmatter, preserves body', () => {
|
|
const input = '---\ntitle: Old\n---\n\nBody here';
|
|
assert.equal(
|
|
spliceFrontmatter(input, { title: 'New' }),
|
|
'---\ntitle: New\n---\n\nBody here'
|
|
);
|
|
});
|
|
|
|
test('replaces existing multi-key frontmatter', () => {
|
|
const input = '---\ntitle: Old\ncount: 5\n---\n\nBody text here';
|
|
assert.equal(
|
|
spliceFrontmatter(input, { title: 'New', count: '5' }),
|
|
'---\ntitle: New\ncount: 5\n---\n\nBody text here'
|
|
);
|
|
});
|
|
|
|
test('CRLF existing frontmatter: body CRLF preserved', () => {
|
|
const input = '---\r\ntitle: Old\r\n---\r\nBody';
|
|
const result = spliceFrontmatter(input, { title: 'New' });
|
|
assert.equal(result, '---\ntitle: New\n---\r\nBody');
|
|
});
|
|
|
|
test('new frontmatter uses LF even if original was CRLF', () => {
|
|
const input = '---\r\ntitle: Old\r\n---\r\nBody';
|
|
const result = spliceFrontmatter(input, { title: 'New' });
|
|
assert.ok(result.startsWith('---\ntitle: New\n---'));
|
|
});
|
|
|
|
test('return type is always string', () => {
|
|
const result = spliceFrontmatter('hello', { k: 'v' });
|
|
assert.equal(typeof result, 'string');
|
|
});
|
|
});
|
|
|
|
// ─── parseMustHavesBlock ──────────────────────────────────────────────────────
|
|
|
|
describe('parseMustHavesBlock: no frontmatter / no block', () => {
|
|
test('no frontmatter returns []', () => {
|
|
assert.deepEqual(parseMustHavesBlock('just content', 'artifacts'), []);
|
|
});
|
|
|
|
test('empty string returns []', () => {
|
|
assert.deepEqual(parseMustHavesBlock('', 'artifacts'), []);
|
|
});
|
|
|
|
test('frontmatter without must_haves returns []', () => {
|
|
const doc = '---\ntitle: Hello\n---\nbody';
|
|
assert.deepEqual(parseMustHavesBlock(doc, 'artifacts'), []);
|
|
});
|
|
|
|
test('must_haves present but requested block absent returns []', () => {
|
|
const doc = '---\nmust_haves:\n other:\n - val\n---';
|
|
assert.deepEqual(parseMustHavesBlock(doc, 'artifacts'), []);
|
|
});
|
|
|
|
test('block at same indent as must_haves is rejected', () => {
|
|
const doc = '---\nmust_haves:\nartifacts:\n - val\n---';
|
|
assert.deepEqual(parseMustHavesBlock(doc, 'artifacts'), []);
|
|
});
|
|
});
|
|
|
|
describe('parseMustHavesBlock: string items', () => {
|
|
test('two plain string items', () => {
|
|
const doc = '---\nmust_haves:\n truths:\n - simple string\n - another string\n---';
|
|
assert.deepEqual(parseMustHavesBlock(doc, 'truths'), ['simple string', 'another string']);
|
|
});
|
|
|
|
test('single string item', () => {
|
|
const doc = '---\nmust_haves:\n truths:\n - only one\n---';
|
|
assert.deepEqual(parseMustHavesBlock(doc, 'truths'), ['only one']);
|
|
});
|
|
|
|
test('double-quoted string items strip quotes', () => {
|
|
const doc = '---\nmust_haves:\n truths:\n - "contains: colon"\n - "another: one"\n---';
|
|
const result = parseMustHavesBlock(doc, 'truths');
|
|
assert.deepEqual(result, ['contains: colon', 'another: one']);
|
|
});
|
|
|
|
test('single-quoted string items strip quotes', () => {
|
|
const doc = "---\nmust_haves:\n truths:\n - 'single quoted'\n---";
|
|
assert.deepEqual(parseMustHavesBlock(doc, 'truths'), ['single quoted']);
|
|
});
|
|
|
|
test('item without colon treated as plain string', () => {
|
|
const doc = '---\nmust_haves:\n truths:\n - plain text here\n---';
|
|
assert.deepEqual(parseMustHavesBlock(doc, 'truths'), ['plain text here']);
|
|
});
|
|
|
|
test('item with colon but no space (Class::Method) is plain string', () => {
|
|
const doc = '---\nmust_haves:\n truths:\n - Class::Method is used\n---';
|
|
assert.deepEqual(parseMustHavesBlock(doc, 'truths'), ['Class::Method is used']);
|
|
});
|
|
|
|
test('item with db:seed (no space after colon) is plain string', () => {
|
|
const doc = '---\nmust_haves:\n truths:\n - db:seed task should run\n---';
|
|
assert.deepEqual(parseMustHavesBlock(doc, 'truths'), ['db:seed task should run']);
|
|
});
|
|
});
|
|
|
|
describe('parseMustHavesBlock: key-value object items', () => {
|
|
test('simple kv item on dash line', () => {
|
|
const doc = '---\nmust_haves:\n artifacts:\n - path: file.ts\n---';
|
|
assert.deepEqual(parseMustHavesBlock(doc, 'artifacts'), [{ path: 'file.ts' }]);
|
|
});
|
|
|
|
test('two kv items', () => {
|
|
const doc = '---\nmust_haves:\n artifacts:\n - path: file.ts\n - path: other.ts\n---';
|
|
assert.deepEqual(parseMustHavesBlock(doc, 'artifacts'), [{ path: 'file.ts' }, { path: 'other.ts' }]);
|
|
});
|
|
|
|
test('kv item with continuation keys', () => {
|
|
const doc = [
|
|
'---',
|
|
'must_haves:',
|
|
' artifacts:',
|
|
' - path: file.ts',
|
|
' provides: something',
|
|
'---',
|
|
].join('\n');
|
|
assert.deepEqual(parseMustHavesBlock(doc, 'artifacts'), [{ path: 'file.ts', provides: 'something' }]);
|
|
});
|
|
|
|
test('kv item with multiple continuation keys', () => {
|
|
const doc = [
|
|
'---',
|
|
'must_haves:',
|
|
' artifacts:',
|
|
' - path: file.ts',
|
|
' provides: exports X',
|
|
' confidence: 90',
|
|
'---',
|
|
].join('\n');
|
|
const result = parseMustHavesBlock(doc, 'artifacts');
|
|
assert.equal(result.length, 1);
|
|
assert.deepEqual(result[0], { path: 'file.ts', provides: 'exports X', confidence: 90 });
|
|
});
|
|
|
|
test('numeric value in continuation key is parsed as integer', () => {
|
|
const doc = [
|
|
'---',
|
|
'must_haves:',
|
|
' artifacts:',
|
|
' - path: file.ts',
|
|
' line: 42',
|
|
'---',
|
|
].join('\n');
|
|
const result = parseMustHavesBlock(doc, 'artifacts');
|
|
assert.equal(result[0].line, 42);
|
|
assert.equal(typeof result[0].line, 'number');
|
|
});
|
|
|
|
test('non-numeric continuation value stays string', () => {
|
|
const doc = [
|
|
'---',
|
|
'must_haves:',
|
|
' artifacts:',
|
|
' - path: file.ts',
|
|
' provides: some text',
|
|
'---',
|
|
].join('\n');
|
|
const result = parseMustHavesBlock(doc, 'artifacts');
|
|
assert.equal(typeof result[0].provides, 'string');
|
|
assert.equal(result[0].provides, 'some text');
|
|
});
|
|
|
|
test('two full kv items with continuations', () => {
|
|
const doc = [
|
|
'---',
|
|
'must_haves:',
|
|
' artifacts:',
|
|
' - path: file.ts',
|
|
' provides: something',
|
|
' - path: other.ts',
|
|
' provides: other',
|
|
'---',
|
|
].join('\n');
|
|
assert.deepEqual(parseMustHavesBlock(doc, 'artifacts'), [
|
|
{ path: 'file.ts', provides: 'something' },
|
|
{ path: 'other.ts', provides: 'other' },
|
|
]);
|
|
});
|
|
});
|
|
|
|
describe('parseMustHavesBlock: nested arrays in items', () => {
|
|
test('item with array continuation', () => {
|
|
const doc = [
|
|
'---',
|
|
'must_haves:',
|
|
' artifacts:',
|
|
' - path: file.ts',
|
|
' tags:',
|
|
' - tag1',
|
|
' - tag2',
|
|
'---',
|
|
].join('\n');
|
|
const result = parseMustHavesBlock(doc, 'artifacts');
|
|
assert.equal(result.length, 1);
|
|
assert.deepEqual(result[0].tags, ['tag1', 'tag2']);
|
|
});
|
|
|
|
test('item with three array elements in continuation', () => {
|
|
const doc = [
|
|
'---',
|
|
'must_haves:',
|
|
' artifacts:',
|
|
' - path: file.ts',
|
|
' tags:',
|
|
' - tag1',
|
|
' - tag2',
|
|
' - tag3',
|
|
'---',
|
|
].join('\n');
|
|
const result = parseMustHavesBlock(doc, 'artifacts');
|
|
assert.deepEqual(result[0].tags, ['tag1', 'tag2', 'tag3']);
|
|
});
|
|
|
|
test('two items where first has array continuation', () => {
|
|
const doc = [
|
|
'---',
|
|
'must_haves:',
|
|
' artifacts:',
|
|
' - path: file.ts',
|
|
' tags:',
|
|
' - tag1',
|
|
' - path: other.ts',
|
|
'---',
|
|
].join('\n');
|
|
const result = parseMustHavesBlock(doc, 'artifacts');
|
|
assert.equal(result.length, 2);
|
|
assert.deepEqual(result[0].tags, ['tag1']);
|
|
assert.equal(result[1].path, 'other.ts');
|
|
});
|
|
});
|
|
|
|
describe('parseMustHavesBlock: return type', () => {
|
|
test('always returns an array', () => {
|
|
const result = parseMustHavesBlock('no content', 'anything');
|
|
assert.ok(Array.isArray(result));
|
|
});
|
|
|
|
test('empty content returns array', () => {
|
|
const result = parseMustHavesBlock('', 'anything');
|
|
assert.ok(Array.isArray(result));
|
|
assert.equal(result.length, 0);
|
|
});
|
|
});
|
|
|
|
// ─── FRONTMATTER_SCHEMAS ──────────────────────────────────────────────────────
|
|
|
|
describe('FRONTMATTER_SCHEMAS', () => {
|
|
test('plan schema has required field', () => {
|
|
assert.ok('required' in FRONTMATTER_SCHEMAS.plan);
|
|
});
|
|
|
|
test('plan schema has exactly 8 required fields', () => {
|
|
assert.equal(FRONTMATTER_SCHEMAS.plan.required.length, 8);
|
|
});
|
|
|
|
test('plan schema required fields are exact', () => {
|
|
assert.deepEqual(FRONTMATTER_SCHEMAS.plan.required, [
|
|
'phase', 'plan', 'type', 'wave', 'depends_on', 'files_modified', 'autonomous', 'must_haves',
|
|
]);
|
|
});
|
|
|
|
test('summary schema has exactly 6 required fields', () => {
|
|
assert.equal(FRONTMATTER_SCHEMAS.summary.required.length, 6);
|
|
});
|
|
|
|
test('summary schema required fields are exact', () => {
|
|
assert.deepEqual(FRONTMATTER_SCHEMAS.summary.required, [
|
|
'phase', 'plan', 'subsystem', 'tags', 'duration', 'completed',
|
|
]);
|
|
});
|
|
|
|
test('verification schema has exactly 4 required fields', () => {
|
|
assert.equal(FRONTMATTER_SCHEMAS.verification.required.length, 4);
|
|
});
|
|
|
|
test('verification schema required fields are exact', () => {
|
|
assert.deepEqual(FRONTMATTER_SCHEMAS.verification.required, [
|
|
'phase', 'verified', 'status', 'score',
|
|
]);
|
|
});
|
|
|
|
test('three schemas exist: plan, summary, verification', () => {
|
|
assert.deepEqual(Object.keys(FRONTMATTER_SCHEMAS).sort(), ['plan', 'summary', 'verification']);
|
|
});
|
|
|
|
test('plan includes phase field', () => {
|
|
assert.ok(FRONTMATTER_SCHEMAS.plan.required.includes('phase'));
|
|
});
|
|
|
|
test('plan includes must_haves field', () => {
|
|
assert.ok(FRONTMATTER_SCHEMAS.plan.required.includes('must_haves'));
|
|
});
|
|
|
|
test('summary includes completed field', () => {
|
|
assert.ok(FRONTMATTER_SCHEMAS.summary.required.includes('completed'));
|
|
});
|
|
|
|
test('verification includes score field', () => {
|
|
assert.ok(FRONTMATTER_SCHEMAS.verification.required.includes('score'));
|
|
});
|
|
|
|
test('plan does not include score field', () => {
|
|
assert.ok(!FRONTMATTER_SCHEMAS.plan.required.includes('score'));
|
|
});
|
|
|
|
test('verification does not include completed field', () => {
|
|
assert.ok(!FRONTMATTER_SCHEMAS.verification.required.includes('completed'));
|
|
});
|
|
});
|
|
|
|
// ─── Tight branch / boundary tests ───────────────────────────────────────────
|
|
|
|
describe('reconstructFrontmatter: array length boundary (<=3 vs >3)', () => {
|
|
test('exactly 3 items: uses inline format', () => {
|
|
const result = reconstructFrontmatter({ x: ['a', 'b', 'c'] });
|
|
assert.equal(result, 'x: [a, b, c]');
|
|
assert.ok(!result.includes('\n - '));
|
|
});
|
|
|
|
test('exactly 4 items: uses block format', () => {
|
|
const result = reconstructFrontmatter({ x: ['a', 'b', 'c', 'd'] });
|
|
assert.ok(result.includes(' - a'));
|
|
assert.ok(result.includes(' - b'));
|
|
assert.ok(result.includes(' - c'));
|
|
assert.ok(result.includes(' - d'));
|
|
});
|
|
|
|
test('exactly 1 item: uses inline format', () => {
|
|
const result = reconstructFrontmatter({ x: ['only'] });
|
|
assert.equal(result, 'x: [only]');
|
|
});
|
|
});
|
|
|
|
describe('reconstructFrontmatter: array join length boundary (< 60)', () => {
|
|
test('3 items joining to exactly 59 chars uses inline', () => {
|
|
// 59 chars: 'aaaaaaaaaaaaaaaaaaa, bbbbbbbbbbbbbbbbbbb, ccccccccccccccccccc' = 60 chars, need 59
|
|
const a = 'aaaaaaaaaaaaaaaaaa'; // 18
|
|
const b = 'bbbbbbbbbbbbbbbbbb'; // 18
|
|
const c = 'ccccccccccccccccccc'; // 19 => join = 18+18+19 + 4 (', ', ', ') = 18+2+18+2+19 = 59
|
|
const joined = [a, b, c].join(', ');
|
|
assert.equal(joined.length, 59);
|
|
const result = reconstructFrontmatter({ x: [a, b, c] });
|
|
assert.equal(result, `x: [${joined}]`);
|
|
});
|
|
|
|
test('3 items joining to exactly 60 chars uses block', () => {
|
|
// 'x' repeated: 19, 19, 18 = 56 + 4 = 60
|
|
const x = 'aaaaaaaaaaaaaaaaaaa'; // 19
|
|
const y = 'bbbbbbbbbbbbbbbbbbb'; // 19
|
|
const z = 'cccccccccccccccccc'; // 18 => 19+2+19+2+18 = 60
|
|
const joined2 = [x, y, z].join(', ');
|
|
assert.equal(joined2.length, 60);
|
|
const result2 = reconstructFrontmatter({ x: [x, y, z] });
|
|
// 60 is NOT < 60, so should use block format
|
|
assert.ok(result2.startsWith('x:\n - '), `Expected block format, got: ${result2}`);
|
|
});
|
|
});
|
|
|
|
describe('reconstructFrontmatter: subarray length boundary', () => {
|
|
test('nested 3 items short uses inline', () => {
|
|
const result = reconstructFrontmatter({ meta: { x: ['a', 'b', 'c'] } });
|
|
assert.equal(result, 'meta:\n x: [a, b, c]');
|
|
});
|
|
|
|
test('nested 4 items uses block', () => {
|
|
const result = reconstructFrontmatter({ meta: { x: ['a', 'b', 'c', 'd'] } });
|
|
assert.equal(result, 'meta:\n x:\n - a\n - b\n - c\n - d');
|
|
});
|
|
});
|
|
|
|
describe('spliceFrontmatter: exact delimiter handling', () => {
|
|
test('output always starts with ---', () => {
|
|
const result = spliceFrontmatter('', { k: 'v' });
|
|
assert.ok(result.startsWith('---\n'));
|
|
});
|
|
|
|
test('existing frontmatter: output uses LF delimiters', () => {
|
|
const input = '---\ntitle: Old\n---\nbody';
|
|
const result = spliceFrontmatter(input, { title: 'New' });
|
|
assert.ok(result.startsWith('---\ntitle: New\n---'));
|
|
});
|
|
|
|
test('no existing frontmatter: body follows after double newline', () => {
|
|
const result = spliceFrontmatter('body', { title: 'T' });
|
|
assert.equal(result, '---\ntitle: T\n---\n\nbody');
|
|
});
|
|
|
|
test('existing frontmatter: body immediately follows closing ---', () => {
|
|
const input = '---\ntitle: T\n---\nbody line';
|
|
const result = spliceFrontmatter(input, { k: 'v' });
|
|
assert.equal(result, '---\nk: v\n---\nbody line');
|
|
});
|
|
});
|
|
|
|
describe('extractFrontmatter: complex real-world documents', () => {
|
|
test('plan document', () => {
|
|
const doc = [
|
|
'---',
|
|
'phase: 1',
|
|
'plan: my-plan',
|
|
'type: feature',
|
|
'wave: 1',
|
|
'depends_on: []',
|
|
'files_modified: []',
|
|
'autonomous: true',
|
|
'must_haves:',
|
|
' artifacts:',
|
|
' - path: src/foo.ts',
|
|
' provides: foo',
|
|
'---',
|
|
'# Plan body',
|
|
].join('\n');
|
|
const result = extractFrontmatter(doc);
|
|
assert.equal(result.phase, '1');
|
|
assert.equal(result.plan, 'my-plan');
|
|
assert.equal(result.type, 'feature');
|
|
assert.equal(result.wave, '1');
|
|
assert.ok(Array.isArray(result.depends_on));
|
|
assert.equal(result.depends_on.length, 0);
|
|
assert.ok(Array.isArray(result.files_modified));
|
|
assert.equal(result.autonomous, 'true');
|
|
});
|
|
|
|
test('summary document', () => {
|
|
const doc = [
|
|
'---',
|
|
'phase: 2',
|
|
'plan: my-plan',
|
|
'subsystem: auth',
|
|
'tags: [security, backend]',
|
|
'duration: 120',
|
|
'completed: true',
|
|
'---',
|
|
].join('\n');
|
|
const result = extractFrontmatter(doc);
|
|
assert.equal(result.phase, '2');
|
|
assert.equal(result.subsystem, 'auth');
|
|
assert.deepEqual(result.tags, ['security', 'backend']);
|
|
assert.equal(result['duration'], '120');
|
|
assert.equal(result.completed, 'true');
|
|
});
|
|
|
|
test('verification document', () => {
|
|
const doc = [
|
|
'---',
|
|
'phase: 3',
|
|
'verified: true',
|
|
'status: pass',
|
|
'score: 95',
|
|
'---',
|
|
].join('\n');
|
|
const result = extractFrontmatter(doc);
|
|
assert.equal(result.verified, 'true');
|
|
assert.equal(result.status, 'pass');
|
|
assert.equal(result.score, '95');
|
|
});
|
|
});
|
|
|
|
describe('reconstructFrontmatter: round-trip', () => {
|
|
test('simple key-value round-trip', () => {
|
|
const original = { title: 'Hello', author: 'World' };
|
|
const reconstructed = reconstructFrontmatter(original);
|
|
const doc = `---\n${reconstructed}\n---\n`;
|
|
const parsed = extractFrontmatter(doc);
|
|
assert.equal(parsed.title, 'Hello');
|
|
assert.equal(parsed.author, 'World');
|
|
});
|
|
|
|
test('value with colon round-trips through quoting', () => {
|
|
const original = { url: 'http://example.com' };
|
|
const reconstructed = reconstructFrontmatter(original);
|
|
assert.equal(reconstructed, 'url: "http://example.com"');
|
|
const doc = `---\n${reconstructed}\n---\n`;
|
|
const parsed = extractFrontmatter(doc);
|
|
assert.equal(parsed.url, 'http://example.com');
|
|
});
|
|
|
|
test('array round-trip (inline)', () => {
|
|
const original = { tags: ['a', 'b', 'c'] };
|
|
const reconstructed = reconstructFrontmatter(original);
|
|
const doc = `---\n${reconstructed}\n---\n`;
|
|
const parsed = extractFrontmatter(doc);
|
|
assert.deepEqual(parsed.tags, ['a', 'b', 'c']);
|
|
});
|
|
|
|
test('empty array round-trip', () => {
|
|
const original = { tags: [] };
|
|
const reconstructed = reconstructFrontmatter(original);
|
|
assert.equal(reconstructed, 'tags: []');
|
|
const doc = `---\n${reconstructed}\n---\n`;
|
|
const parsed = extractFrontmatter(doc);
|
|
assert.ok(Array.isArray(parsed.tags));
|
|
assert.equal(parsed.tags.length, 0);
|
|
});
|
|
});
|
|
|
|
describe('extractFrontmatter: boundary — dash at start of file', () => {
|
|
test('--- at byte 0 is treated as frontmatter', () => {
|
|
const result = extractFrontmatter('---\nkey: val\n---\n');
|
|
assert.deepEqual(result, { key: 'val' });
|
|
});
|
|
|
|
test('content before --- means no frontmatter', () => {
|
|
const result = extractFrontmatter(' ---\nkey: val\n---\n');
|
|
assert.deepEqual(result, {});
|
|
});
|
|
|
|
test('newline before --- means no frontmatter', () => {
|
|
const result = extractFrontmatter('\n---\nkey: val\n---\n');
|
|
assert.deepEqual(result, {});
|
|
});
|
|
});
|
|
|
|
describe('parseMustHavesBlock: item accumulation', () => {
|
|
test('last item pushed after loop ends', () => {
|
|
const doc = '---\nmust_haves:\n truths:\n - only item\n---';
|
|
const result = parseMustHavesBlock(doc, 'truths');
|
|
assert.equal(result.length, 1);
|
|
assert.equal(result[0], 'only item');
|
|
});
|
|
|
|
test('items are pushed in order', () => {
|
|
const doc = '---\nmust_haves:\n truths:\n - first\n - second\n - third\n---';
|
|
const result = parseMustHavesBlock(doc, 'truths');
|
|
assert.equal(result[0], 'first');
|
|
assert.equal(result[1], 'second');
|
|
assert.equal(result[2], 'third');
|
|
});
|
|
|
|
test('three items total count', () => {
|
|
const doc = '---\nmust_haves:\n truths:\n - a\n - b\n - c\n---';
|
|
assert.equal(parseMustHavesBlock(doc, 'truths').length, 3);
|
|
});
|
|
});
|
|
|
|
describe('parseMustHavesBlock: indent stopping logic', () => {
|
|
test('items after block ends at same/lower indent are not included', () => {
|
|
const doc = [
|
|
'---',
|
|
'must_haves:',
|
|
' truths:',
|
|
' - item one',
|
|
'other_key: val',
|
|
'---',
|
|
].join('\n');
|
|
const result = parseMustHavesBlock(doc, 'truths');
|
|
assert.equal(result.length, 1);
|
|
assert.equal(result[0], 'item one');
|
|
});
|
|
});
|
|
|
|
describe('reconstructFrontmatter: deeply nested subsubval null/undefined', () => {
|
|
test('3rd level null subsubval skipped', () => {
|
|
const result = reconstructFrontmatter({ top: { mid: { key: null } } });
|
|
assert.equal(result, 'top:\n mid:');
|
|
});
|
|
});
|
|
|
|
describe('reconstructFrontmatter: nested subval plain string', () => {
|
|
test('nested subval without special chars unquoted', () => {
|
|
const result = reconstructFrontmatter({ meta: { name: 'plain' } });
|
|
assert.equal(result, 'meta:\n name: plain');
|
|
});
|
|
|
|
test('nested subval with colon quoted', () => {
|
|
const result = reconstructFrontmatter({ meta: { ref: 'type: value' } });
|
|
assert.equal(result, 'meta:\n ref: "type: value"');
|
|
});
|
|
|
|
test('nested subval with hash quoted', () => {
|
|
const result = reconstructFrontmatter({ meta: { tag: 'issue#42' } });
|
|
assert.equal(result, 'meta:\n tag: "issue#42"');
|
|
});
|
|
});
|