diff --git a/.claude/rules/stack-and-commands.md b/.claude/rules/stack-and-commands.md index dc53ac6..4c4a357 100644 --- a/.claude/rules/stack-and-commands.md +++ b/.claude/rules/stack-and-commands.md @@ -1,19 +1,19 @@ ## Stack - -- **Language:** -- **Key deps:** +- **Language:** JavaScript (ES modules), browser-first; no bundler +- **Key deps:** Vitest, jsdom (dev); static HTML/CSS/SVG templates ## Dev Commands ```bash -# TODO: Fill in the standard commands for this repo +make install # npm install +make test # vitest +make test-watch # vitest watch +make test-coverage # coverage report +make serve # local static server (index.html) +make dist # distribution package +make dist-zip # zip archive for offline/Windows use -# Install dependencies - -# Run tests - -# Lint / type check - -# Build / package (if applicable) +# After workplan edits +statehub fix-consistency ``` diff --git a/SCOPE.md b/SCOPE.md index 65b9357..e537263 100644 --- a/SCOPE.md +++ b/SCOPE.md @@ -1,7 +1,6 @@ # SCOPE -> This file was generated by `statehub register`. Refine it as the repository -> boundaries become clearer. +> Lightweight boundary for agents and contributors. ## One-liner @@ -30,7 +29,8 @@ timeline-svg exists to provide the capability described in INTENT.md. ## Current State -- {"project_description": "TimelineSvg is a client-side, browser-based tool that generates multi-lane SVG timeline graphics from CSV data using an Inkscape-editable SVG template system with no backend or build pipeline.", "intent_markdown": null, "domain_slug": "infotech", "topic_slug": "timeline-svg", "topic_title": "TimelineSvg - CSV-to-SVG Timeline Generator", "repo_slug": "timeline-svg", "workplan_prefix": "TMLN-WP", "in_scope": ["Parsing CSV data into timeline items with configurable field mappings", "Rendering multi-lane SVG timelines via a template-v2 (DOM-based) architecture", "Supporting Inkscape/Illustrator/Figma-editable SVG templates with placeholder substitution", "Providing a browser UI (index.html/engine.js) for loading projects, previewing, and exporting SVGs", "In-browser inline file editing with modification tracking", "Vitest-based test suite covering generator, engine, and integration flows", "Distribution packaging (make dist/dist-zip) for offline/Windows deployment"], "out_of_scope": ["Server-side or backend processing (fully client-side by design)", "Build pipeline or bundler-based tooling", "Non-timeline visualization types (e.g., Gantt-specific scheduling logic beyond basic lanes/items)", "Authentication, multi-user collaboration, or persistence beyond local files"], "current_state": "Actively developed local tool with recent work on a DOM-based prototype template system and inline file editing; test suite and CI smoke workflow (Forgejo) exist; no formal INTENT.md yet."} +- Template-v2 refactoring complete (40+ Vitest tests); Forgejo CI smoke workflow active. +- Bootstrap State Hub integration (TMLN-WP-0001) finished; next: distribution packaging (TMLN-WP-0002). ## Getting Oriented diff --git a/workplans/TMLN-WP-0001-statehub-bootstrap.md b/workplans/TMLN-WP-0001-statehub-bootstrap.md index 3b09281..c11229c 100644 --- a/workplans/TMLN-WP-0001-statehub-bootstrap.md +++ b/workplans/TMLN-WP-0001-statehub-bootstrap.md @@ -4,7 +4,7 @@ type: workplan title: "Bootstrap State Hub integration" domain: infotech repo: timeline-svg -status: ready +status: finished owner: codex topic_slug: custodian created: "2026-07-08" @@ -20,11 +20,13 @@ TimelineSvg is a client-side, browser-based tool that generates multi-lane SVG t ```task id: TMLN-WP-0001-T01 -status: todo +status: done priority: high state_hub_task_id: "6fced395-2061-4c81-b77b-e83bdd0e7aea" ``` +Result 2026-07-08: INTENT.md and SCOPE.md reviewed; removed generated-placeholder noise from SCOPE Current State. + Review `INTENT.md`, `SCOPE.md`, `AGENTS.md`, and `.custodian-brief.md`. Replace generated placeholders with repo-specific facts where needed. @@ -32,11 +34,13 @@ Replace generated placeholders with repo-specific facts where needed. ```task id: TMLN-WP-0001-T02 -status: todo +status: done priority: high state_hub_task_id: "0422d117-cc07-4aa1-82e4-52179e08c790" ``` +Result 2026-07-08: Documented make/npm/vitest workflow in stack-and-commands.md. + Identify the repo's install, test, lint, build, and run commands. Add or refine those commands in the agent instructions so future coding sessions can verify changes confidently. @@ -45,11 +49,13 @@ changes confidently. ```task id: TMLN-WP-0001-T03 -status: todo +status: done priority: medium state_hub_task_id: "3b7c0d8e-6321-470c-b032-9fc0fcfb970c" ``` +Result 2026-07-08: Created TMLN-WP-0002. + Create the first implementation workplan for the repository's most important next change. After workplan file updates, run the sync locally from this repo checkout: diff --git a/workplans/TMLN-WP-0002-distribution-packaging.md b/workplans/TMLN-WP-0002-distribution-packaging.md new file mode 100644 index 0000000..ff6f968 --- /dev/null +++ b/workplans/TMLN-WP-0002-distribution-packaging.md @@ -0,0 +1,26 @@ +--- +id: TMLN-WP-0002 +type: workplan +title: "Distribution packaging and release smoke" +domain: infotech +repo: timeline-svg +status: ready +owner: codex +topic_slug: custodian +created: "2026-07-08" +updated: "2026-07-08" +--- + +# Distribution packaging and release smoke + +Harden offline distribution (`make dist`, `make dist-zip`) and document the Windows/local-server workflow for non-developer users. + +## Distribution smoke checklist + +```task +id: TMLN-WP-0002-T01 +status: todo +priority: high +``` + +Verify dist output, WINDOWS_USAGE.md steps, and example/my-project sample projects; add release checklist to README.