open/ktg-plugin-marketplace
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity Actions

feat(voyage): vendor markdown-it/highlight.js + playground render-pipeline + scripts/render-artifact.mjs CLI — v4.2 Step 8 [skip-docs]

Browse source 
Vendored libs (locked headless via scripts/vendor-playground-libs.mjs;
plan-critic B3 — never use highlightjs.org website builder):
  - playground/lib/markdown-it.min.js           — markdown-it@14.1.0 UMD bundle
  - playground/lib/markdown-it-front-matter.min.js — markdown-it-front-matter@0.2.4 IIFE-wrapped
  - playground/lib/highlight.min.js             — highlight.js@11.11.1 (5-lang bundle:
                                                   yaml/json/javascript/bash/markdown/diff)
  - playground/lib/VENDOR-MANIFEST.json         — pin record + audit trail

scripts/vendor-playground-libs.mjs implements the reproducible
CommonJS-to-IIFE wrapping. Re-vendoring requires only:
  node scripts/vendor-playground-libs.mjs

Render pipeline in playground/voyage-playground.html (~330 LoC total):
  - inline <script src=lib/...> for the three vendored bundles
  - markdown-it init with html: true (preserves voyage:anchor comments)
  - front-matter plugin with pre-render-then-wrap pattern (research/03)
  - paste-import-row textarea + Render/Sample/Clear buttons
  - voyage-viewport region with role + aria-live for A11Y
  - localStorage key pattern: voyage_ann_<project>__<slug> (risk-assessor H7)
  - inline sample plan (mirrors annotation-plan.md fixture)

scripts/render-artifact.mjs CLI (~200 LoC) — brief SC1 + SC11:
  - reads input.md, runs same vendored pipeline server-side
  - inlines DS CSS + (URL-stripped) highlight.js into output
  - zero http://https:// URLs in output (verified by test)
  - deterministic: two invocations -> byte-identical sha256
  - default output: <input>.html next to input

Test coverage:
  - tests/scripts/render-artifact.test.mjs — 5 cases (SC1/SC11)
  - tests/playground/voyage-playground.test.mjs — +5 cases (Step 8 extension)

Verify: node --test tests/playground/voyage-playground.test.mjs
       tests/scripts/render-artifact.test.mjs -> 18 pass / 0 fail.
Full npm test: 587 pass / 0 fail / 2 skipped (Docker).

Refs plan.md Step 8 + plan-critic B3 + scope-guardian B1.
This commit is contained in:
Kjell Tore Guttormsen 2026-05-09 15:20:17 +02:00
commit 249142df2f
9 changed files with 996 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

30
plugins/voyage/tests/playground/voyage-playground.test.mjs
View file

@ -65,3 +65,33 @@ test('playground/vendor/playground-design-system/ contains expected DS files', (
}
assert.ok(files.includes('fonts'), 'fonts/ subdirectory expected');
});
// --- Step 8 — render pipeline + vendored libs ---------------------------
const PLAYGROUND_LIB = join(PLAYGROUND, 'lib');
test('voyage-playground.html references markdown-it (Step 8 render pipeline)', () => {
const text = readFileSync(HTML, 'utf-8');
assert.match(text, /markdown-it/, 'voyage-playground.html should load/initialize markdown-it');
});
test('voyage-playground.html references highlight.js (Step 8 syntax highlighting)', () => {
const text = readFileSync(HTML, 'utf-8');
assert.match(text, /highlight/, 'voyage-playground.html should load highlight.js');
});
test('voyage-playground.html includes paste-import-row (Step 8 import affordance)', () => {
const text = readFileSync(HTML, 'utf-8');
assert.match(text, /paste-import-row/, 'voyage-playground.html should include the paste-import-row pattern');
});
test('voyage-playground.html declares voyage_ann_ localStorage key prefix (Step 8 risk-assessor H7)', () => {
const text = readFileSync(HTML, 'utf-8');
assert.match(text, /voyage_ann_/, 'localStorage key prefix voyage_ann_<project>__<file> must appear');
});
test('playground/lib/ contains vendored markdown-it + front-matter + highlight bundles', () => {
for (const f of ['markdown-it.min.js', 'markdown-it-front-matter.min.js', 'highlight.min.js', 'VENDOR-MANIFEST.json']) {
assert.ok(existsSync(join(PLAYGROUND_LIB, f)), `playground/lib/${f} expected from vendor-playground-libs.mjs`);
}
});