@peaske7/readit 0.3.0-rc.0 → 0.3.0-rc.2

package/.claude/commands/review.md

@@ -1,120 +0,0 @@
-# Code Review: 本質的な課題発見と解決
-
-Review code in $ARGUMENTS for **fundamental design issues**, not surface-level cleanup. Use extended thinking (ultrathink).
-
-**Philosophy**: Find root causes, but respect the codebase's simplicity-first approach. From `style-guide.md`:
-
-- "Obvious over clever" - Can you understand it in 5 seconds?
-- "Duplication over wrong abstraction" - Write it twice, abstract on the third
-- "Simple over complex" - Prefer imperative solutions over abstractions
-- "Do not model state machines or data with classes" - Use discriminated unions sparingly
-
-**CRITICAL**: Do NOT suggest new abstractions (state machines, wrapper classes, generic utilities) unless the same pattern appears 3+ times. Prefer inline, obvious code.
-
-## What to Look For
-
-Reference `.claude/rules/style-guide.md` for detailed examples.
-
-### 1. Abstractions & Decomposition
-
-- §9.2 Refactoring & Anti-Patterns - Premature abstraction, wrong boundaries
-- §3.2 Balanced Function Decomposition - When to extract vs inline
-
-### 2. Type Design
-
-- §2.1 Parse, Don't Validate - Transform at boundaries, don't re-validate
-- §2.2 Discriminated Unions Over Classes - Exhaustive checking, no inheritance
-- §6.3 No Enums - Use const object pattern
-
-### 3. Control Flow
-
-- §3.3 Early Returns and Guard Clauses - Happy path at root indentation
-- §3.3.1 Prefer Early Returns Over `let` Accumulation
-- §7.2 Sequential vs Parallel Processing - Right async pattern for the job
-- §4.1 Single Try-Catch for Related Operations
-
-### 4. Function Design
-
-- §3.5 Object Destructuring for Opaque Parameters
-- §3.1 Simple Over Complex - Prefer imperative over functional abstractions
-
-### 5. Code Hygiene (Always Check)
-
-- §3.4 Naming Conventions - No generic names, Hungarian notation, abbreviations
-- §3.2 Superfluous abstractions - Inline trivial one-liners
-- Comments - Delete restating JSDoc, commented-out code, TODOs without tickets
-- Dead code - Remove unused imports, uncalled methods, unread variables
-
-## Review Process
-
-1. **Understand the use case** - What is this code trying to accomplish?
-2. **Trace the data flow** - Follow the data from input to output
-3. **Question abstractions** - Does this class/function earn its existence? Could it be simpler?
-4. **Resist adding complexity** - The fix should simplify, not add layers
-
-## Output Format
-
-```markdown
-## 本質的な課題 (Fundamental Issues)
-
-### [Critical/High/Medium] Issue Title
-**Root Cause**: Why this problem exists at the design level
-**Symptom**: What you observe in the code
-**Location**: `path/to/file.ts:123`
-**Proposed Fix**: How to simplify (prefer removal/inlining over adding new abstractions)
-
-## Surface Issues (Lower Priority)
-- Brief list of naming, formatting, comment issues (fix these only after fundamental issues)
-```
-
-## Fix Approach
-
-**For fundamental issues:**
-
-1. Propose the simplest fix first (often: inline, remove, or merge)
-2. Ask for confirmation if the change affects multiple files or public interfaces
-3. Implement the fix
-
-**For surface issues:**
-
-1. Fix silently after addressing fundamental issues
-2. Run `bun run check:fix` to format
-
-## Anti-patterns to Flag
-
-- **Adding abstraction to fix a bug** - Symptom-fixing vs root cause
-- **Creating a "utils" function** - Find the right home or inline it
-- **Wrapper functions that just pass through** - No value added, remove them
-- **Extracting trivial operations** - `name.replace(/_id_seq$/, "")` should stay inline
-- **Boolean parameters** - Should often be two separate functions
-
-## When Abstractions ARE Appropriate
-
-**State machines** - Use when:
-
-- There are distinct, named states (e.g., VOID → EVENT_CREATED → BOT_SCHEDULED)
-- Transitions between states have specific actions
-- The switch statement covers all state combinations exhaustively
-
-**Don't use** state machines for:
-
-- Simple if/else that can be early returns
-- Boolean flags that don't represent true states
-- "Just in case" future flexibility
-
-**New types/classes** - Use when:
-
-- Pattern repeats 3+ times
-- Encapsulates meaningful domain complexity
-- Makes invalid states unrepresentable
-
-## Anti-patterns to AVOID Suggesting
-
-- Generic utility wrappers
-- New abstraction layers for 1-2 use cases
-- "Future-proofing" changes
-- State machines for simple conditional logic
-
----
-
-Now analyze: $ARGUMENTS

package/.claude/commands/sync-docs.md

@@ -1,71 +0,0 @@
----
-description: Sync documentation with current codebase implementation
-allowed-tools: Read, Grep, Glob, Edit
----
-
-# Sync Documentation
-
-Compare documentation files against the actual codebase and fix discrepancies.
-
-## Files to Sync
-
-| File | What to verify |
-|------|----------------|
-| `CLAUDE.md` | Architecture diagram, component list, tech stack, CLI options |
-| `README.md` | Node.js version, usage examples, requirements, feature descriptions |
-| `.claude/user-stories.md` | Implementation status, acceptance criteria accuracy |
-| `.claude/roadmap.md` | Completed vs planned features, removed tech references |
-
-## Process
-
-### Step 1: Read Source of Truth
-
-Read these files to understand actual implementation:
-
-```
-package.json          → version, dependencies, Node.js requirement
-src/cli/index.ts      → CLI flags, supported file types
-src/server/index.ts   → API routes
-src/components/*.tsx  → component names
-src/lib/*.ts          → utilities
-```
-
-### Step 2: Compare and Report
-
-For each doc file, check for:
-
-- **Version mismatches** (Node.js, React, package version)
-- **Removed dependencies** still mentioned (e.g., Pandoc)
-- **Renamed/deleted components** in architecture diagrams
-- **Implemented features** still marked "Not implemented"
-- **New CLI flags** not documented
-- **UI terminology** changes (e.g., "sidebar" → "margin notes")
-
-### Step 3: Output Format
-
-```markdown
-## Documentation Sync Report
-
-### Discrepancies Found
-
-#### CLAUDE.md
-1. **Architecture diagram**: Lists `CommentSidebar.tsx` but file doesn't exist
-   - **Fix**: Update to `MarginNote.tsx`, `MarginNotesContainer.tsx`
-
-#### README.md
-1. **Node.js version**: Says "≥18" but package.json requires "≥22"
-   - **Fix**: Update to ≥22.0.0
-
-### ✓ Already Accurate
-- .claude/roadmap.md
-```
-
-### Step 4: Fix
-
-After listing all discrepancies, ask for confirmation, then apply fixes using Edit tool.
-
-## When to Run
-
-- Before releases
-- After adding/removing features
-- After refactoring components

package/.claude/roadmap.md

@@ -1,121 +0,0 @@
-# Development Roadmap
-
-## v0.1.0 - MVP ✅
-
-- [x] CLI with Commander.js
-- [x] markdown-it for Markdown rendering (server-side with shiki syntax highlighting)
-- [x] HTML file support
-- [x] Bun.serve() server serving API + static files
-- [x] Svelte 5 frontend with Tailwind CSS v4
-- [x] Text selection → comment input
-- [x] Margin notes UI (Google Docs style)
-- [x] Highlight commented text with yellow background
-- [x] Copy All / Export JSON
-- [x] File-based comment persistence (`.comments.md` files)
-- [x] Copy for LLM feature (⌘⇧C) - copy selection/comment with surrounding context
-- [x] CLI subcommands: `list`, `show`, `open`
-
-## v0.2.0 - File-Based Comment Storage ✅
-
-Plain markdown storage enables git versioning, LLM accessibility, and cross-tool extensibility.
-
-- [x] Store comments in `~/.readit/comments/{path}/{filename}.comments.md`
-- [x] Human-readable markdown format with selected text + comment
-- [x] Auto-save on comment add/edit/delete
-- [x] Load comments from file on startup
-- [x] Anchor-based text matching (survives minor document edits)
-
-## v0.2.1 - Storage Robustness ✅
-
-- [x] Version compatibility check in parser (error on future versions)
-- [x] Anchor confidence propagation to UI (exact/fuzzy/unresolved indicators)
-- [x] Selection truncation for very long texts (>1000 chars)
-- [x] Document single-tab-per-file limitation
-- [x] Document cross-machine path limitation
-- [ ] Integration tests for storage edge cases:
-  - [ ] Large documents (10K+ lines)
-  - [ ] Many comments (100+)
-  - [ ] Unicode/emoji in selections
-  - [ ] Concurrent tab simulation
-  - [ ] Document changes between sessions
-  - [ ] Corrupt/malformed comment files
-
-## v0.3.0 - Comment Resolution Workflow
-
-Review documents, add comments, then resolve one-by-one with LLM assistance.
-
-- [ ] Comment status (`unresolved` / `resolved`)
-  - [ ] Add `status` field to Comment type
-  - [ ] Store status in `.comments.md` metadata: `<!-- c:{id}|{lineHint}|{timestamp}|{status} -->`
-  - [ ] Default new comments to `unresolved`
-- [ ] Navigate unresolved comments
-  - [ ] "Next unresolved" / "Previous unresolved" keyboard shortcuts
-  - [ ] Unresolved count in header
-- [ ] Visual status indicators
-  - [ ] Minimap: yellow = unresolved, green = resolved
-  - [ ] Margin notes: status badge + toggle button
-  - [ ] Highlight colors: yellow = unresolved, muted = resolved
-- [ ] Per-comment LLM copy
-  - [ ] Copy single comment + context (⌘⇧C on margin note)
-  - [ ] Include file path, line numbers, heading context
-- [ ] Mark resolved action
-  - [ ] Click to toggle status
-  - [ ] Auto-navigate to next unresolved (optional)
-
-## v0.4.0 - Visual Enhancements ✅
-
-- [x] Highlight commented text in document (moved to v0.1.0)
-- [x] Syntax highlighting for code blocks (shiki, server-side)
-- [x] Click highlight → scroll to margin note
-- [x] Click margin note → scroll to highlighted text
-- [x] Mermaid diagram rendering
-- [x] Layout mode toggle (centered / fullscreen)
-- [x] Floating TOC in fullscreen mode
-- [x] Settings modal with font preference (serif / sans-serif)
-- [x] Per-document settings storage (`~/.readit/settings/`)
-- [ ] Better mobile support
-
-## v0.5.0 - Comment Categories
-
-- [ ] Category selection (TODO, Question, Suggestion, Fix)
-- [ ] Color-coded categories
-- [ ] Filter by category
-- [ ] Category in export format
-
-## v0.6.0 - Multi-file Support (Partial ✅)
-
-- [ ] Glob pattern support (`readit docs/*.md`)
-- [x] Multiple file arguments (`readit file1.md file2.md`)
-- [x] Directory scanning (`readit <dir>`)
-- [x] `readit open <files...>` to add files to running server
-- [x] File tab navigation (TabBar.svelte)
-- [x] Per-file comment storage
-- [ ] Bulk export across files
-
-## v0.7.0 - Shell Integration & Editor Plugins ✅
-
-- [x] Zsh integration with `@` file autocomplete (fzf-powered, Forge Code-style)
-  - [x] `@<TAB>` launches fzf picker for markdown files
-  - [x] `@partial<TAB>` pre-filters fzf query
-  - [x] Syntax highlighting for `@*.md` patterns in command line
-  - [x] Standard compdef completion for subcommands and options
-  - [x] Bash and Fish completion scripts via `readit completion`
-- [x] Neovim plugin (`nvim-readit/`)
-  - [x] Server lifecycle management (start/stop/discover)
-  - [x] `:ReaditOpen`, `:ReaditStop`, `:ReaditStatus`, `:ReaditReload`, `:ReaditList` commands
-  - [x] Configurable keymaps (`<leader>r` prefix by default)
-  - [x] `:checkhealth readit` support
-  - [x] Auto-cleanup on VimLeavePre
-- [x] Enhanced live reload on file changes
-  - [x] Handle `rename` events (Vim/Neovim write-to-temp-then-rename saves)
-  - [x] Auto re-establish watcher after rename with retry logic
-  - [x] SSE auto-reconnect with exponential backoff
-  - [x] Parallel document + comments fetch on reload
-
-## Future Considerations
-
-- Sticky notes (ペタペタ) - add notes not tied to text selection
-- Collaborative mode (WebSocket sync)
-- GitHub integration (create issues from comments)
-- VS Code extension
-- PDF export with highlights and comments - export the current document view as a PDF with all highlights and margin notes visible, preserving the visual review state for sharing or archiving