markitect-main/TODO.md

89 lines
5.2 KiB
Markdown
Raw Normal View History

# Todofile
This is a "to do next" file, particularly useful to keep the human and a coding assistant in sync.
The format is based on [Keep a Todofile V0.0.1](https://coulomb.social/open/KeepaTodofile).
The structure organizes **future tasks** by their impact, just as a changelog organizes past changes by their impact.
***
## [Unreleased] - *Active Vibe-Coding State* 💡
This section is for tasks currently being discussed with or worked on by the coding assistant. These are the ephemeral, flow-of-thought tasks.
**📊 STATUS UPDATE (2025-11-02)**: Systematic JavaScript functionality recovery using TDD methodology has made excellent progress. **5 major features** have been successfully implemented and tested:
1. **Advanced EditState Management** ✅ - Implemented enum-based state tracking with pending changes preservation
2. **Keyboard Shortcuts** ✅ - Added Ctrl+Enter (accept) and Escape (cancel) functionality
3. **Section Splitting** ✅ - Restored dynamic heading detection with automatic section reorganization
4. **Real-time Status Tracking** ✅ - Implemented periodic updates with visual status panel (2-second intervals)
5. **Intelligent Filename Generation** ✅ - Added 4-method fallback system (options→title→URL→heading→timestamp)
All implementations include comprehensive TDD test suites and are fully integrated into the existing codebase. The recovery approach has proven highly effective for restoring sophisticated lost functionality.
* **To Add:**
* ✅ Advanced state management with EditState enum and pending changes (CRITICAL) - COMPLETED
* ✅ Keyboard shortcuts (Ctrl+Enter accept, Escape cancel) (CRITICAL) - COMPLETED
* ✅ Section splitting functionality for dynamic heading detection (HIGH) - COMPLETED
* ✅ Real-time status tracking with periodic updates (HIGH) - COMPLETED
* ✅ Intelligent save filename generation with 4-method fallback (MEDIUM) - COMPLETED
* 🚧 Professional message system with color-coded positioning (MEDIUM) - IN PROGRESS
* Multiple concurrent editing sessions support (MEDIUM)
* Enhanced DOM event system with 6 event types (LOW)
* Automatic section type detection (heading, code, list, etc) (LOW)
* Sophisticated section ID generation with hash-based algorithm (LOW)
* **To Fix:**
* Comprehensive status reporting dialog with detailed stats (HIGH)
* Floating global control panel with professional styling (MEDIUM)
* Enhanced setupSectionElement with comprehensive styling (LOW)
* **To Refactor:**
* ✅ stopEditing method with state preservation (CRITICAL) - COMPLETED
* ✅ getAllSections method for section collection management (MEDIUM) - COMPLETED
* ✅ hasChanges detection for unsaved modifications (HIGH) - COMPLETED
* ✅ updateGlobalStatus method with 2-second interval updates (MEDIUM) - COMPLETED
* ✅ handleSectionSplit for dynamic section reorganization (LOW) - COMPLETED
* ✅ checkForSectionSplits automatic heading detection (LOW) - COMPLETED
* **To Remove:**
* None currently identified
***
## Completed Tasks
feat: implement comprehensive asset shipping for md-render command Add automatic asset copying when rendering markdown to different output directories with intelligent defaults and full user control. Key Features: - Environment variable support: MARKITECT_OUTPUT_DIR sets default output directory - Smart defaults: auto-ship assets for directory output, disabled for file output - CLI control flags: --ship-assets and --no-ship-assets for explicit control - Timestamp-based copying: only copies when source newer than destination - Path preservation: maintains relative directory structure in output - Graceful error handling: missing assets logged as warnings, not failures Technical Implementation: - Enhanced asset discovery in markitect/assets/discovery.py with discover_assets_from_markdown() - Added environment variable priority: CLI --output > MARKITECT_OUTPUT_DIR > input directory - Comprehensive asset shipping logic with _ship_assets() function - Directory vs file output detection for intelligent default behavior Examples and Testing: - Added image-assets example directory with 6 sample images and comprehensive README - Created comprehensive TDD test suite with 10 tests covering all functionality - Tests validate environment variables, CLI flags, asset discovery, shipping logic, timestamp handling, missing assets, path preservation, and default behaviors Usage: markitect md-render file.md -o /output/dir/ # Auto-ships assets markitect md-render file.md --no-ship-assets # Suppresses shipping MARKITECT_OUTPUT_DIR=/docs markitect md-render file.md # Uses env var 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
2025-10-29 23:12:44 +01:00
**Asset Shipping for md-render - COMPLETED ✅**:
- ✅ Implemented automatic asset copying when rendering markdown to different output directories
- ✅ Added asset discovery functionality parsing markdown for image/link references
- ✅ Implemented timestamp-based asset copying (only copy if source newer than destination)
- ✅ Added `--ship-assets` and `--no-ship-assets` CLI flags for explicit control
- ✅ Added `MARKITECT_OUTPUT_DIR` environment variable support for default output directory
- ✅ Smart defaults: assets ship automatically when output is directory, disabled for specific files
- ✅ Preserved relative path structure in output directory maintaining markdown link compatibility
- ✅ Graceful handling of missing assets with warning messages
- ✅ Full backward compatibility with existing md-render workflows
- ✅ Comprehensive TDD test suite covering all functionality and edge cases
**Feature Capabilities**:
- Environment variable priority: CLI `--output` > `MARKITECT_OUTPUT_DIR` > input file directory
- Automatic asset discovery from standard markdown syntax: `![alt](path)` and `[text](path)`
- Timestamp-based incremental copying prevents unnecessary file operations
- Directory structure preservation maintains working relative links in output HTML
- Support for images, documents, and other asset types referenced in markdown
**CHANGELOG.md Enhancement - COMPLETED ✅**:
- ✅ Added missing version entries for 0.1.0, 0.2.0, and 0.3.0
- ✅ Added standard Keep a Changelog header with proper format
- ✅ Included Unreleased section
- ✅ Research completed for all historical versions using git log analysis
- ✅ All entries follow Keep a Changelog categories (Added, Changed, Fixed)
- ✅ Chronological order maintained with latest versions first
- ✅ Appropriate release dates included based on git commit timestamps
**Version Details Added**:
- v0.1.0 (2025-10-15): Development infrastructure, TDD workspace, issue management
- v0.2.0 (2025-10-20): Advanced Markdown Engine with GraphQL, search, plugins
- v0.3.0 (2025-10-25): Architectural improvements with kaizen-agentic integration