PLOW-37 - trckr

← PLOW-37

feature

Created: 2025-12-21 • Updated: 2025-12-21

Relationships Loading...

## Summary

Add `@mermaid-js/mermaid-cli` (mmdc) as an optional dependency for rendering Mermaid diagrams to SVG.

## Tasks

1. Create `scripts/install-mermaid.sh` that installs mermaid-cli globally via npm:
   ```bash
   npm install -g @mermaid-js/mermaid-cli
   ```

2. Update `trckr-plow init` to check for `mmdc` binary and warn if missing (but don't fail - it's optional)

3. Document in README.md:
   - Mermaid visualization requires mmdc to be installed
   - How to install: `npm install -g @mermaid-js/mermaid-cli`
   - Note that it requires Node.js 18.19+ or 20+

## Acceptance Criteria

- [ ] `scripts/install-mermaid.sh` exists and installs mermaid-cli
- [ ] `trckr-plow init` checks for mmdc and shows helpful message if missing
- [ ] README documents mermaid-cli installation
- [ ] Running `mmdc --version` works after following setup instructions

## Notes

- mermaid-cli uses puppeteer for rendering, which downloads Chromium
- This is a prerequisite for the Mermaid visualization feature

Pull Requests (comma-separated URLs)

Attachments

Comments (1)

agent · 2025-12-21

## Implementation Summary ### Changes Made 1. **Created `scripts/install-mermaid.sh`** - Checks for Node.js presence and version (18.19+ or 20+ required) - Checks for npm presence - Installs `@mermaid-js/mermaid-cli` globally - Verifies installation and provides helpful PATH guidance if mmdc not found 2. **Updated `trckr-plow init`** (cli.py:96-104) - Added mmdc binary check using `shutil.which('mmdc')` - Shows friendly message when mmdc is found or not found - Provides installation instructions when missing - Does NOT fail - this is an optional dependency 3. **Updated README.md** (lines 229-253) - Added new section 'Optional: Mermaid Diagram Visualization' - Documents requirements (Node.js 18.19+ or 20+, npm) - Shows both install methods (script and npm command) - Notes Chromium download (~300MB) ### Verification - All 739 tests pass - `trckr-plow init` correctly shows mmdc warning when not installed - Install script has valid bash syntax - README documentation is clear and actionable