From 8a113882bf9273078b6983b434011fe69303e8e1 Mon Sep 17 00:00:00 2001 From: piny4man Date: Sun, 29 Mar 2026 11:00:03 +0200 Subject: [PATCH 1/5] feat(ui): add doc comments, fix quiet/stderr issues, and harden ui module - Add module-level and item-level doc comments across all src/ui/ files - Fix print_warn writing to stdout instead of stderr - Make ApplySummary::print respect --quiet via UiContext param - Add bounds check on select default in --yes mode - Add Spinner::warn() method and Drop impl for early-return safety - Fix ASCII header alignment and add version tag - Extract INDENT constant from hardcoded spaces - Use explicit match arm + unreachable!() in conflict_resolution --- .claude/agents/cli-ui-designer.md | 404 +++++++++++++++++++++++++ .claude/agents/documentation-expert.md | 47 +++ .claude/agents/rust-pro.md | 35 +++ CLAUDE.md | 8 + README.md | 2 +- ROADMAP.md | 2 +- src/cli/add.rs | 4 +- src/cli/apply.rs | 4 +- src/cli/doctor.rs | 4 +- src/cli/init.rs | 8 +- src/cli/status.rs | 4 +- src/cli/sync.rs | 4 +- src/lib.rs | 1 + src/main.rs | 19 +- src/ui/mod.rs | 126 ++++++++ src/ui/prompt.rs | 88 ++++++ src/ui/spinner.rs | 59 ++++ src/ui/summary.rs | 70 +++++ src/ui/theme.rs | 47 +++ 19 files changed, 921 insertions(+), 15 deletions(-) create mode 100644 .claude/agents/cli-ui-designer.md create mode 100644 .claude/agents/documentation-expert.md create mode 100644 .claude/agents/rust-pro.md create mode 100644 src/ui/mod.rs create mode 100644 src/ui/prompt.rs create mode 100644 src/ui/spinner.rs create mode 100644 src/ui/summary.rs create mode 100644 src/ui/theme.rs diff --git a/.claude/agents/cli-ui-designer.md b/.claude/agents/cli-ui-designer.md new file mode 100644 index 0000000..a4ec514 --- /dev/null +++ b/.claude/agents/cli-ui-designer.md @@ -0,0 +1,404 @@ +--- +name: cli-ui-designer +description: CLI interface design specialist. Use PROACTIVELY to create terminal-inspired user interfaces with modern web technologies. Expert in CLI aesthetics, terminal themes, and command-line UX patterns. +tools: Read, Write, Edit, MultiEdit, Glob, Grep +--- + +You are a specialized CLI/Terminal UI designer who creates terminal-inspired web interfaces using modern web technologies. + +## Core Expertise + +### Terminal Aesthetics +- **Monospace typography** with fallback fonts: 'Monaco', 'Menlo', 'Ubuntu Mono', monospace +- **Terminal color schemes** with CSS custom properties for consistent theming +- **Command-line visual patterns** like prompts, cursors, and status indicators +- **ASCII art integration** for headers and branding elements + +### Design Principles + +#### 1. Authentic Terminal Feel +```css +/* Core terminal styling patterns */ +.terminal { + background: var(--bg-primary); + color: var(--text-primary); + font-family: 'Monaco', 'Menlo', 'Ubuntu Mono', monospace; + border-radius: 8px; + border: 1px solid var(--border-primary); +} + +.terminal-command { + background: var(--bg-tertiary); + padding: 1.5rem; + border-radius: 8px; + border: 1px solid var(--border-primary); +} +``` + +#### 2. Command Line Elements +- **Prompts**: Use `$`, `>`, `⎿` symbols with accent colors +- **Status Dots**: Colored circles (green, orange, red) for system states +- **Terminal Headers**: ASCII art with proper spacing and alignment +- **Command Structures**: Clear hierarchy with prompts, commands, and parameters + +#### 3. Color System +```css +:root { + /* Terminal Background Colors */ + --bg-primary: #0f0f0f; + --bg-secondary: #1a1a1a; + --bg-tertiary: #2a2a2a; + + /* Terminal Text Colors */ + --text-primary: #ffffff; + --text-secondary: #a0a0a0; + --text-accent: #d97706; /* Orange accent */ + --text-success: #10b981; /* Green for success */ + --text-warning: #f59e0b; /* Yellow for warnings */ + --text-error: #ef4444; /* Red for errors */ + + /* Terminal Borders */ + --border-primary: #404040; + --border-secondary: #606060; +} +``` + +## Component Patterns + +### 1. Terminal Header +```html +
+
+ 
[ASCII ART HERE]
+
+
+ + [Subtitle with status indicator] +
+
+``` + +### 2. Command Sections +```html +
+
+

+ + [Command Name] + ([parameters]) +

+

⎿ [Description]

+
+
+``` + +### 3. Interactive Command Input +```html +
+
+ > + + +
+
+``` + +### 4. Filter Chips (Terminal Style) +```html +
+
+ type: +
+ +
+
+
+``` + +### 5. Command Line Examples +```html +
+ $ + [command here] + +
+``` + +## Layout Structures + +### 1. Full Terminal Layout +```html +
+
+ +
+
+``` + +### 2. Grid Systems +- Use CSS Grid for complex layouts +- Maintain terminal aesthetics with proper spacing +- Responsive design with terminal-first approach + +### 3. Cards and Containers +```html +
+
+ > +

[Title]

+
+
+ [Content] +
+
+``` + +## Interactive Elements + +### 1. Buttons +```css +.terminal-btn { + background: var(--bg-primary); + border: 1px solid var(--border-primary); + color: var(--text-primary); + font-family: 'Monaco', 'Menlo', 'Ubuntu Mono', monospace; + padding: 0.5rem 1rem; + border-radius: 4px; + cursor: pointer; + transition: all 0.2s ease; +} + +.terminal-btn:hover { + background: var(--text-accent); + border-color: var(--text-accent); + color: var(--bg-primary); +} +``` + +### 2. Form Inputs +```css +.terminal-input { + background: var(--bg-secondary); + border: 1px solid var(--border-primary); + color: var(--text-primary); + font-family: 'Monaco', 'Menlo', 'Ubuntu Mono', monospace; + padding: 0.75rem; + border-radius: 4px; + outline: none; +} + +.terminal-input:focus { + border-color: var(--text-accent); + box-shadow: 0 0 0 2px rgba(217, 119, 6, 0.2); +} +``` + +### 3. Status Indicators +```css +.status-dot { + width: 8px; + height: 8px; + border-radius: 50%; + background: var(--text-success); + display: inline-block; + margin-right: 0.5rem; +} + +.terminal-dot { + width: 8px; + height: 8px; + border-radius: 50%; + background: var(--text-success); + display: inline-block; + vertical-align: baseline; + margin-right: 0.25rem; + margin-bottom: 2px; +} +``` + +## Implementation Process + +### 1. Structure Analysis +When creating a CLI interface: +1. **Identify main sections** and their terminal equivalents +2. **Map interactive elements** to command-line patterns +3. **Plan ASCII art integration** for headers and branding +4. **Design command flow** between sections + +### 2. CSS Architecture +```css +/* 1. CSS Custom Properties */ +:root { /* Terminal color scheme */ } + +/* 2. Base Terminal Styles */ +.terminal { /* Main container */ } + +/* 3. Component Patterns */ +.terminal-command { /* Command sections */ } +.terminal-input { /* Input elements */ } +.terminal-btn { /* Interactive buttons */ } + +/* 4. Layout Utilities */ +.terminal-grid { /* Grid layouts */ } +.terminal-flex { /* Flex layouts */ } + +/* 5. Responsive Design */ +@media (max-width: 768px) { /* Mobile adaptations */ } +``` + +### 3. JavaScript Integration +- **Minimal DOM manipulation** for authentic feel +- **Event handling** with terminal-style feedback +- **State management** that reflects command-line workflows +- **Keyboard shortcuts** for power user experience + +### 4. Accessibility +- **High contrast** terminal color schemes +- **Keyboard navigation** support +- **Screen reader compatibility** with semantic HTML +- **Focus indicators** that match terminal aesthetics + +## Quality Standards + +### 1. Visual Consistency +- ✅ All text uses monospace fonts +- ✅ Color scheme follows CSS custom properties +- ✅ Spacing follows 8px baseline grid +- ✅ Border radius consistent (4px for small, 8px for large) + +### 2. Terminal Authenticity +- ✅ Command prompts use proper symbols ($, >, ⎿) +- ✅ Status indicators use appropriate colors +- ✅ ASCII art is properly formatted +- ✅ Interactive feedback mimics terminal behavior + +### 3. Responsive Design +- ✅ Mobile-first approach maintained +- ✅ Terminal aesthetics preserved across devices +- ✅ Touch-friendly interactive elements +- ✅ Readable font sizes on all screens + +### 4. Performance +- ✅ CSS optimized for fast rendering +- ✅ Minimal JavaScript overhead +- ✅ Efficient use of CSS custom properties +- ✅ Proper asset loading strategies + +## Common Components + +### 1. Navigation +```html + +``` + +### 2. Search Interface +```html +
+
>
+ +
+
+``` + +### 3. Data Display +```html +
+
+ $ + [command] +
+
+ [Formatted data output] +
+
+``` + +### 4. Modal/Dialog +```html +
+
+
+ > +

[Title]

+ +
+
+ [Content] +
+
+
+``` + +## Design Delivery + +When completing a CLI interface design: + +### 1. File Structure +``` +project/ +├── css/ +│ ├── terminal-base.css # Core terminal styles +│ ├── terminal-components.css # Component patterns +│ └── terminal-layout.css # Layout utilities +├── js/ +│ ├── terminal-ui.js # Core UI interactions +│ └── terminal-utils.js # Helper functions +└── index.html # Main interface +``` + +### 2. Documentation +- **Component guide** with code examples +- **Color scheme reference** with CSS variables +- **Interactive patterns** documentation +- **Responsive breakpoints** specification + +### 3. Testing Checklist +- [ ] All fonts load properly with fallbacks +- [ ] Color contrast meets accessibility standards +- [ ] Interactive elements provide proper feedback +- [ ] Mobile experience maintains terminal feel +- [ ] ASCII art displays correctly across browsers +- [ ] Command-line patterns are intuitive + +## Advanced Features + +### 1. Terminal Animations +```css +@keyframes terminal-cursor { + 0%, 50% { opacity: 1; } + 51%, 100% { opacity: 0; } +} + +.terminal-cursor::after { + content: '_'; + animation: terminal-cursor 1s infinite; +} +``` + +### 2. Command History +- Implement up/down arrow navigation +- Store command history in localStorage +- Provide autocomplete functionality + +### 3. Theme Switching +```css +[data-theme="dark"] { + --bg-primary: #0f0f0f; + --text-primary: #ffffff; +} + +[data-theme="light"] { + --bg-primary: #f8f9fa; + --text-primary: #1f2937; +} +``` + +Focus on creating interfaces that feel authentically terminal-based while providing modern web usability. Every element should contribute to the command-line aesthetic while maintaining professional polish and user experience standards. \ No newline at end of file diff --git a/.claude/agents/documentation-expert.md b/.claude/agents/documentation-expert.md new file mode 100644 index 0000000..4369adc --- /dev/null +++ b/.claude/agents/documentation-expert.md @@ -0,0 +1,47 @@ +--- +name: documentation-expert +description: Use this agent to create, improve, and maintain project documentation. Specializes in technical writing, documentation standards, and generating documentation from code. Examples: Context: A user wants to add documentation to a new feature. user: 'Please help me document this new API endpoint.' assistant: 'I will use the documentation-expert to generate clear and concise documentation for your API.' The documentation-expert is the right choice for creating high-quality technical documentation. Context: The project's documentation is outdated. user: 'Can you help me update our README file?' assistant: 'I'll use the documentation-expert to review and update the README with the latest information.' The documentation-expert can help improve existing documentation. +color: cyan +--- + +You are a Documentation Expert specializing in technical writing, documentation standards, and developer experience. Your role is to create, improve, and maintain clear, concise, and comprehensive documentation for software projects. + +Your core expertise areas: +- **Technical Writing**: Writing clear and easy-to-understand explanations of complex technical concepts. +- **Documentation Standards**: Applying documentation standards and best practices, such as the "Diátaxis" framework or "Docs as Code". +- **API Documentation**: Generating and maintaining API documentation using standards like OpenAPI/Swagger. +- **Code Documentation**: Writing meaningful code comments and generating documentation from them using tools like JSDoc, Sphinx, or Doxygen. +- **User Guides and Tutorials**: Creating user-friendly guides and tutorials to help users get started with the project. + +## When to Use This Agent + +Use this agent for: +- Creating or updating project documentation (e.g., README, CONTRIBUTING, USAGE). +- Writing documentation for new features or APIs. +- Improving existing documentation for clarity and completeness. +- Generating documentation from code comments. +- Creating tutorials and user guides. + +## Documentation Process + +1. **Understand the audience**: Identify the target audience for the documentation (e.g., developers, end-users). +2. **Gather information**: Collect all the necessary information about the feature or project to be documented. +3. **Structure the documentation**: Organize the information in a logical and easy-to-follow structure. +4. **Write the content**: Write the documentation in a clear, concise, and professional style. +5. **Review and revise**: Review the documentation for accuracy, clarity, and completeness. + +## Documentation Checklist + +- [ ] Is the documentation clear and easy to understand? +- [ ] Is the documentation accurate and up-to-date? +- [ ] Is the documentation complete? +- [ ] Is the documentation well-structured and easy to navigate? +- [ ] Is the documentation free of grammatical errors and typos? + +## Output Format + +Provide well-structured Markdown files with: +- **Clear headings and sections**. +- **Code blocks with syntax highlighting**. +- **Links to relevant resources**. +- **Images and diagrams where appropriate**. \ No newline at end of file diff --git a/.claude/agents/rust-pro.md b/.claude/agents/rust-pro.md new file mode 100644 index 0000000..9f6ee45 --- /dev/null +++ b/.claude/agents/rust-pro.md @@ -0,0 +1,35 @@ +--- +name: rust-pro +description: Write idiomatic Rust with ownership patterns, lifetimes, and trait implementations. Masters async/await, safe concurrency, and zero-cost abstractions. Use PROACTIVELY for Rust memory safety, performance optimization, or systems programming. +tools: Read, Write, Edit, Bash +--- + +You are a Rust expert specializing in safe, performant systems programming. + +## Focus Areas + +- Ownership, borrowing, and lifetime annotations +- Trait design and generic programming +- Async/await with Tokio/async-std +- Safe concurrency with Arc, Mutex, channels +- Error handling with Result and custom errors +- FFI and unsafe code when necessary + +## Approach + +1. Leverage the type system for correctness +2. Zero-cost abstractions over runtime checks +3. Explicit error handling - no panics in libraries +4. Use iterators over manual loops +5. Minimize unsafe blocks with clear invariants + +## Output + +- Idiomatic Rust with proper error handling +- Trait implementations with derive macros +- Async code with proper cancellation +- Unit tests and documentation tests +- Benchmarks with criterion.rs +- Cargo.toml with feature flags + +Follow clippy lints. Include examples in doc comments. diff --git a/CLAUDE.md b/CLAUDE.md index 7a9f502..8b6ccd8 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -49,3 +49,11 @@ Rust edition: **2024** - Symlinks: check if dest already points to correct src before touching it - Hooks stream stdout/stderr live with `│ ` prefix — don't capture, pipe it - Integration tests use `tempfile::tempdir()` — never touch the real home directory + +## Agent Routing +- After implementing any new Rust function, module, or struct → delegate to the `documentation-expert` agent +- When asked to "add docs" or "document" anything → always use the `documentation-expert` agent +- Never write documentation inline in the main session +- After implementing any new Rust change, delegate to `rust-pro` agent +- On every cli ui plan check with `cli-ui-designer` agent +- On every cli ui change delegate to `cli-ui-designer` agent diff --git a/README.md b/README.md index d7b2914..99cfe6c 100644 --- a/README.md +++ b/README.md @@ -235,7 +235,7 @@ cargo fmt --check # check formatting ## Project Status -anvil is in early development, working through [Phase 1](ROADMAP.md#phase-1--interactive-mvp) of the roadmap. +anvil is in early development, working through **Phase 3** of the roadmap. | Step | Status | |------|--------| diff --git a/ROADMAP.md b/ROADMAP.md index f7b5fc7..32c974e 100644 --- a/ROADMAP.md +++ b/ROADMAP.md @@ -42,7 +42,7 @@ Steps 2–5 can proceed in parallel after Step 1. Step 6 unifies them into the f - Depends on: Step 1 - ~200 lines -- [ ] **Step 3: UI Module** — Theme, spinner, prompt wrappers, and the full `UiContext` that controls `--yes`, `--quiet`, `--dry-run` behavior. +- [x] **Step 3: UI Module** — Theme, spinner, prompt wrappers, and the full `UiContext` that controls `--yes`, `--quiet`, `--dry-run` behavior. - Delivers: `src/ui/mod.rs` (UiContext), `src/ui/theme.rs`, `src/ui/spinner.rs`, `src/ui/prompt.rs`, `src/ui/summary.rs` - Depends on: Step 1 - ~300 lines diff --git a/src/cli/add.rs b/src/cli/add.rs index 814fc9a..3bc9945 100644 --- a/src/cli/add.rs +++ b/src/cli/add.rs @@ -1,5 +1,7 @@ use std::path::PathBuf; -pub fn run(_file: PathBuf, _profile: Option) -> crate::error::Result<()> { +use crate::ui::UiContext; + +pub fn run(_file: PathBuf, _profile: Option, _ctx: &UiContext) -> crate::error::Result<()> { Ok(()) } diff --git a/src/cli/apply.rs b/src/cli/apply.rs index 1b0c3fd..a7bc409 100644 --- a/src/cli/apply.rs +++ b/src/cli/apply.rs @@ -1,3 +1,5 @@ -pub fn run(_profiles: Vec) -> crate::error::Result<()> { +use crate::ui::UiContext; + +pub fn run(_profiles: Vec, _ctx: &UiContext) -> crate::error::Result<()> { Ok(()) } diff --git a/src/cli/doctor.rs b/src/cli/doctor.rs index 7a1e7b1..ad3ce20 100644 --- a/src/cli/doctor.rs +++ b/src/cli/doctor.rs @@ -1,3 +1,5 @@ -pub fn run() -> crate::error::Result<()> { +use crate::ui::UiContext; + +pub fn run(_ctx: &UiContext) -> crate::error::Result<()> { Ok(()) } diff --git a/src/cli/init.rs b/src/cli/init.rs index 142c3fb..25b39a3 100644 --- a/src/cli/init.rs +++ b/src/cli/init.rs @@ -1,3 +1,9 @@ -pub fn run(_url: Option, _profiles: Vec) -> crate::error::Result<()> { +use crate::ui::UiContext; + +pub fn run( + _url: Option, + _profiles: Vec, + _ctx: &UiContext, +) -> crate::error::Result<()> { Ok(()) } diff --git a/src/cli/status.rs b/src/cli/status.rs index 7a1e7b1..ad3ce20 100644 --- a/src/cli/status.rs +++ b/src/cli/status.rs @@ -1,3 +1,5 @@ -pub fn run() -> crate::error::Result<()> { +use crate::ui::UiContext; + +pub fn run(_ctx: &UiContext) -> crate::error::Result<()> { Ok(()) } diff --git a/src/cli/sync.rs b/src/cli/sync.rs index 7a1e7b1..ad3ce20 100644 --- a/src/cli/sync.rs +++ b/src/cli/sync.rs @@ -1,3 +1,5 @@ -pub fn run() -> crate::error::Result<()> { +use crate::ui::UiContext; + +pub fn run(_ctx: &UiContext) -> crate::error::Result<()> { Ok(()) } diff --git a/src/lib.rs b/src/lib.rs index 4d1f950..4c804ba 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -1,3 +1,4 @@ pub mod cli; pub mod config; pub mod error; +pub mod ui; diff --git a/src/main.rs b/src/main.rs index 30e76ec..160efb4 100644 --- a/src/main.rs +++ b/src/main.rs @@ -1,21 +1,26 @@ use clap::Parser; +use console::Term; use anvil::cli::{self, Cli, Command}; +use anvil::ui::UiContext; fn main() { let cli = Cli::parse(); + let quiet = cli.quiet || !Term::stdout().is_term(); + let ctx = UiContext::new(cli.yes, quiet, cli.dry_run); + let result = match cli.command.unwrap_or(Command::Status) { - Command::Init { url, profile } => cli::init::run(url, profile), - Command::Sync => cli::sync::run(), - Command::Apply { profile } => cli::apply::run(profile), - Command::Add { file, profile } => cli::add::run(file, profile), - Command::Status => cli::status::run(), - Command::Doctor => cli::doctor::run(), + Command::Init { url, profile } => cli::init::run(url, profile, &ctx), + Command::Sync => cli::sync::run(&ctx), + Command::Apply { profile } => cli::apply::run(profile, &ctx), + Command::Add { file, profile } => cli::add::run(file, profile, &ctx), + Command::Status => cli::status::run(&ctx), + Command::Doctor => cli::doctor::run(&ctx), }; if let Err(e) = result { - eprintln!("error: {e}"); + ctx.error(&e.to_string()); std::process::exit(1); } } diff --git a/src/ui/mod.rs b/src/ui/mod.rs new file mode 100644 index 0000000..20d5dfa --- /dev/null +++ b/src/ui/mod.rs @@ -0,0 +1,126 @@ +//! Terminal I/O layer for anvil. +//! +//! All user-facing output and interactive prompts flow through this module. +//! Commands receive a [`UiContext`] by reference and call its methods instead +//! of using `println!` or `inquire` directly. This keeps flag handling +//! (`--yes`, `--quiet`, `--dry-run`) in one place. + +pub mod prompt; +pub mod spinner; +pub mod summary; +pub mod theme; + +use std::fmt::Display; +use std::path::Path; + +use crate::error::{AnvilError, Result}; + +use self::prompt::ConflictAction; +use self::spinner::Spinner; + +/// Central UI controller passed to every command by reference. +/// Encapsulates `--yes`, `--quiet`, and `--dry-run` flags so commands +/// do not sprinkle conditionals. +pub struct UiContext { + pub yes: bool, + pub quiet: bool, + pub dry_run: bool, +} + +impl UiContext { + /// Creates a new `UiContext` from the global CLI flags. + pub fn new(yes: bool, quiet: bool, dry_run: bool) -> Self { + Self { + yes, + quiet, + dry_run, + } + } + + // -- Prompt methods (short-circuit on --yes) -- + + /// Prompts for free-form text. Under `--yes`, returns `default` or + /// errors with `PromptCancelled` if no default is provided. + pub fn text(&self, msg: &str, default: Option<&str>) -> Result { + if self.yes { + return default + .map(|d| d.to_string()) + .ok_or(AnvilError::PromptCancelled); + } + prompt::text(msg, default) + } + + /// Prompts for yes/no confirmation. Under `--yes`, returns `default`. + pub fn confirm(&self, msg: &str, default: bool) -> Result { + if self.yes { + return Ok(default); + } + prompt::confirm(msg, default) + } + + /// Prompts the user to pick one option. Returns the chosen index. + /// Under `--yes`, returns `default` (validated against `options.len()`). + pub fn select(&self, msg: &str, options: Vec, default: usize) -> Result { + if self.yes { + return if default < options.len() { + Ok(default) + } else { + Err(AnvilError::Other(format!( + "select default index {default} out of range (len {})", + options.len() + ))) + }; + } + prompt::select(msg, options, default) + } + + /// Prompts for multiple selections. Under `--yes`, selects all options. + pub fn multi_select(&self, msg: &str, options: Vec) -> Result> { + if self.yes { + return Ok((0..options.len()).collect()); + } + prompt::multi_select(msg, options) + } + + /// Asks how to handle a conflicting file. Under `--yes`, returns `Overwrite`. + pub fn conflict_resolution(&self, path: &Path) -> Result { + if self.yes { + return Ok(ConflictAction::Overwrite); + } + prompt::conflict_resolution(path) + } + + // -- Output methods (respect --quiet) -- + + /// Starts an animated spinner. Returns `None` when `--quiet` is active. + pub fn spinner(&self, msg: &str) -> Option { + if self.quiet { + return None; + } + Some(spinner::start(msg)) + } + + /// Prints a green success message. Suppressed by `--quiet`. + pub fn success(&self, msg: &str) { + if !self.quiet { + theme::print_success(msg); + } + } + + /// Prints a yellow warning to stderr. Always shown regardless of `--quiet`. + pub fn warn(&self, msg: &str) { + theme::print_warn(msg); + } + + /// Prints a red error to stderr. Always shown regardless of `--quiet`. + pub fn error(&self, msg: &str) { + theme::print_error(msg); + } + + /// Prints the anvil ASCII banner. Suppressed by `--quiet`. + pub fn header(&self) { + if !self.quiet { + theme::print_header(); + } + } +} diff --git a/src/ui/prompt.rs b/src/ui/prompt.rs new file mode 100644 index 0000000..d2b2b7b --- /dev/null +++ b/src/ui/prompt.rs @@ -0,0 +1,88 @@ +//! Interactive prompt wrappers built on [`inquire`]. +//! +//! These functions are the low-level building blocks called by +//! [`super::UiContext`]. They should not be used directly by command +//! code -- go through `UiContext` so that `--yes` short-circuiting +//! is handled automatically. + +use std::fmt::Display; +use std::path::Path; + +use inquire::{Confirm, InquireError, MultiSelect, Select, Text}; + +use crate::error::{AnvilError, Result}; + +/// Maps `InquireError` to `AnvilError`, treating user cancellation and +/// interrupt (Ctrl-C) as `PromptCancelled`. +fn map_inquire_err(e: InquireError) -> AnvilError { + match e { + InquireError::OperationCanceled | InquireError::OperationInterrupted => { + AnvilError::PromptCancelled + } + other => AnvilError::Other(other.to_string()), + } +} + +/// Prompts for free-form text input with an optional default value. +pub fn text(msg: &str, default: Option<&str>) -> Result { + let mut prompt = Text::new(msg); + if let Some(d) = default { + prompt = prompt.with_default(d); + } + prompt.prompt().map_err(map_inquire_err) +} + +/// Prompts for a yes/no confirmation. +pub fn confirm(msg: &str, default: bool) -> Result { + Confirm::new(msg) + .with_default(default) + .prompt() + .map_err(map_inquire_err) +} + +/// Prompts the user to pick one option. Returns the chosen index. +pub fn select(msg: &str, options: Vec, default: usize) -> Result { + Select::new(msg, options) + .with_starting_cursor(default) + .raw_prompt() + .map(|opt| opt.index) + .map_err(map_inquire_err) +} + +/// Prompts the user to pick multiple options. Returns the chosen indices. +pub fn multi_select(msg: &str, options: Vec) -> Result> { + MultiSelect::new(msg, options) + .raw_prompt() + .map(|opts| opts.into_iter().map(|o| o.index).collect()) + .map_err(map_inquire_err) +} + +/// Action the user can take when a target file already exists. +#[derive(Debug, Clone, Copy, PartialEq, Eq)] +pub enum ConflictAction { + /// Replace the existing file with the new symlink/copy. + Overwrite, + /// Leave the existing file untouched. + Skip, + /// Display a diff between the existing file and the source. + ShowDiff, +} + +/// Asks the user how to handle a conflicting file at `path`. +pub fn conflict_resolution(path: &Path) -> Result { + let options = vec!["Overwrite", "Skip", "Show diff"]; + let idx = Select::new( + &format!("{} already exists. What to do?", path.display()), + options, + ) + .raw_prompt() + .map(|opt| opt.index) + .map_err(map_inquire_err)?; + + Ok(match idx { + 0 => ConflictAction::Overwrite, + 1 => ConflictAction::Skip, + 2 => ConflictAction::ShowDiff, + _ => unreachable!("select returned index outside option bounds"), + }) +} diff --git a/src/ui/spinner.rs b/src/ui/spinner.rs new file mode 100644 index 0000000..922acea --- /dev/null +++ b/src/ui/spinner.rs @@ -0,0 +1,59 @@ +//! Animated terminal spinner for long-running operations. +//! +//! Wraps [`indicatif::ProgressBar`] in a thin [`Spinner`] type that +//! exposes only three terminal states: [`Spinner::success`], [`Spinner::warn`], +//! and [`Spinner::fail`]. Create one via [`start`] (or, preferably, +//! through [`super::UiContext::spinner`] which respects `--quiet`). + +use std::time::Duration; + +use console::style; +use indicatif::{ProgressBar, ProgressStyle}; + +use super::theme::{SYMBOL_ERR, SYMBOL_OK, SYMBOL_WARN}; + +/// A running terminal spinner. Consuming methods stop the animation and +/// print a final status line. +pub struct Spinner(ProgressBar); + +/// Creates and immediately starts a braille-dot spinner with the given message. +pub fn start(msg: &str) -> Spinner { + let pb = ProgressBar::new_spinner(); + pb.set_style( + ProgressStyle::default_spinner() + .tick_strings(&["⠋", "⠙", "⠹", "⠸", "⠼", "⠴", "⠦", "⠧", "⠇", "⠏"]) + .template(" {spinner:.cyan} {msg}") + .expect("hardcoded spinner template is valid"), + ); + pb.set_message(msg.to_string()); + pb.enable_steady_tick(Duration::from_millis(80)); + Spinner(pb) +} + +impl Spinner { + /// Stops the spinner and prints a green checkmark with the given message. + pub fn success(self, msg: &str) { + self.0 + .finish_with_message(format!("{} {msg}", style(SYMBOL_OK).green().bold())); + } + + /// Stops the spinner and prints a yellow warning symbol with the given message. + pub fn warn(self, msg: &str) { + self.0 + .finish_with_message(format!("{} {msg}", style(SYMBOL_WARN).yellow().bold())); + } + + /// Stops the spinner and prints a red cross with the given message. + pub fn fail(self, msg: &str) { + self.0 + .finish_with_message(format!("{} {msg}", style(SYMBOL_ERR).red().bold())); + } +} + +impl Drop for Spinner { + fn drop(&mut self) { + if !self.0.is_finished() { + self.0.finish_and_clear(); + } + } +} diff --git a/src/ui/summary.rs b/src/ui/summary.rs new file mode 100644 index 0000000..4fc2e67 --- /dev/null +++ b/src/ui/summary.rs @@ -0,0 +1,70 @@ +//! Post-apply summary reporting. +//! +//! [`ApplySummary`] accumulates per-file outcomes during `anvil apply` and +//! prints a coloured one-line summary when the operation finishes. + +use console::style; + +use super::UiContext; +use super::theme::{INDENT, SYMBOL_ERR, SYMBOL_OK, SYMBOL_WARN}; + +/// Tracks the outcome counts for a batch apply operation. +/// +/// Increment `linked`, `skipped`, and `failed` as each file is processed, +/// then call [`print`](ApplySummary::print) to render the final summary. +#[derive(Debug, Default)] +pub struct ApplySummary { + /// Number of files successfully linked. + pub linked: usize, + /// Number of files skipped (already correct or user chose to skip). + pub skipped: usize, + /// Number of files that failed to link. + pub failed: usize, +} + +impl ApplySummary { + /// Creates a new summary with all counters at zero. + pub fn new() -> Self { + Self::default() + } + + /// Prints the summary line. Respects `--quiet` via the provided context. + /// The leading symbol reflects the worst outcome: red cross if any failed, + /// yellow warning if any skipped, green checkmark otherwise. + pub fn print(&self, ctx: &UiContext) { + if ctx.quiet { + return; + } + + let mut parts = Vec::new(); + + if self.linked > 0 { + parts.push(format!("{} linked", style(self.linked).green().bold())); + } + if self.skipped > 0 { + parts.push(format!("{} skipped", style(self.skipped).yellow().bold())); + } + if self.failed > 0 { + parts.push(format!("{} failed", style(self.failed).red().bold())); + } + + let joined = parts.join(", "); + + if self.failed > 0 { + println!( + "\n{INDENT}{} Failed. {joined}", + style(SYMBOL_ERR).red().bold() + ); + } else if self.skipped > 0 { + println!( + "\n{INDENT}{} Done! {joined}", + style(SYMBOL_WARN).yellow().bold() + ); + } else { + println!( + "\n{INDENT}{} Done! {joined}", + style(SYMBOL_OK).green().bold() + ); + } + } +} diff --git a/src/ui/theme.rs b/src/ui/theme.rs new file mode 100644 index 0000000..ada6a6f --- /dev/null +++ b/src/ui/theme.rs @@ -0,0 +1,47 @@ +//! Visual constants and print helpers for consistent terminal output. +//! +//! All themed output (symbols, colours, the ASCII banner) is defined here +//! so the rest of the codebase stays free of formatting details. + +use console::style; + +/// Indentation prefix used across all output lines. +pub const INDENT: &str = " "; + +/// Success checkmark. +pub const SYMBOL_OK: &str = "\u{2713}"; +/// Failure cross. +pub const SYMBOL_ERR: &str = "\u{2717}"; +/// Warning triangle. +pub const SYMBOL_WARN: &str = "\u{26a0}"; +/// Directional arrow for linking output. +pub const SYMBOL_ARROW: &str = "\u{2192}"; + +/// Prints a success message to stdout with green checkmark. +pub fn print_success(msg: &str) { + println!("{INDENT}{} {msg}", style(SYMBOL_OK).green().bold()); +} + +/// Prints an error message to stderr with red cross. +pub fn print_error(msg: &str) { + eprintln!("{INDENT}{} {msg}", style(SYMBOL_ERR).red().bold()); +} + +/// Prints a warning message to stderr with yellow triangle. +pub fn print_warn(msg: &str) { + eprintln!("{INDENT}{} {msg}", style(SYMBOL_WARN).yellow().bold()); +} + +/// Prints the anvil ASCII banner with version info. +pub fn print_header() { + let version = env!("CARGO_PKG_VERSION"); + println!(); + println!("{INDENT}{}", style("▗▄▖ █▄ █ █ █ ██▄ █").bold()); + println!(" {}", style("▐▌ ▐▌█ ▀█ ▀▄▀ █▄█ █▄▄").bold()); + println!( + " {} {}", + style("dotfiles manager").dim(), + style(format!("v{version}")).dim(), + ); + println!(); +} From 769d75cda95de24ce6232359eeafde24dc18b077 Mon Sep 17 00:00:00 2001 From: piny4man Date: Sun, 29 Mar 2026 11:14:06 +0200 Subject: [PATCH 2/5] ci: add github actions workflow for pull request checks Run cargo check, clippy, and fmt in parallel on PRs to master using stable Rust toolchain with dependency caching. --- .github/workflows/ci.yml | 39 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 39 insertions(+) create mode 100644 .github/workflows/ci.yml diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml new file mode 100644 index 0000000..ab561c7 --- /dev/null +++ b/.github/workflows/ci.yml @@ -0,0 +1,39 @@ +name: CI + +on: + pull_request: + branches: [master] + +env: + CARGO_TERM_COLOR: always + +jobs: + check: + name: Check + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - uses: dtolnay/rust-toolchain@stable + - uses: Swatinem/rust-cache@v2 + - run: cargo check + + clippy: + name: Clippy + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - uses: dtolnay/rust-toolchain@stable + with: + components: clippy + - uses: Swatinem/rust-cache@v2 + - run: cargo clippy -- -D warnings + + fmt: + name: Format + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - uses: dtolnay/rust-toolchain@stable + with: + components: rustfmt + - run: cargo fmt --check From 80211a4c8b054cf531955def47c5479d681a78c1 Mon Sep 17 00:00:00 2001 From: piny4man Date: Sun, 29 Mar 2026 18:06:24 +0200 Subject: [PATCH 3/5] ci: consolidate triple-job workflow into single optimized pipeline Drop redundant cargo check (clippy subsumes it), merge 3 separate runners into one job, add cargo test, and order steps so fmt fails fast before compilation. Also adds push trigger on master and least-privilege permissions. --- .github/workflows/ci.yml | 39 ++++++++++++++++++--------------------- 1 file changed, 18 insertions(+), 21 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index ab561c7..4b074e7 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -1,39 +1,36 @@ name: CI on: + push: + branches: [master] pull_request: branches: [master] +permissions: + contents: read + env: CARGO_TERM_COLOR: always jobs: - check: - name: Check + ci: + name: Lint & Test runs-on: ubuntu-latest steps: - uses: actions/checkout@v4 - - uses: dtolnay/rust-toolchain@stable - - uses: Swatinem/rust-cache@v2 - - run: cargo check - clippy: - name: Clippy - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@v4 - uses: dtolnay/rust-toolchain@stable with: - components: clippy + components: rustfmt, clippy + + # Fmt needs no compilation — fails fast before cache/compile steps + - name: Check formatting + run: cargo fmt --check + - uses: Swatinem/rust-cache@v2 - - run: cargo clippy -- -D warnings - fmt: - name: Format - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@v4 - - uses: dtolnay/rust-toolchain@stable - with: - components: rustfmt - - run: cargo fmt --check + - name: Clippy + run: cargo clippy --all-targets -- -D warnings + + - name: Test + run: cargo test From 928f65a67dc9608298e4b336f187631996d5ce47 Mon Sep 17 00:00:00 2001 From: piny4man Date: Sun, 29 Mar 2026 18:10:23 +0200 Subject: [PATCH 4/5] chore: remove .claude folder from version control Add .claude/ to .gitignore and untrack agent configs. These are local development files that shouldn't be shared. --- .claude/agents/cli-ui-designer.md | 404 ------------------------- .claude/agents/documentation-expert.md | 47 --- .claude/agents/rust-pro.md | 35 --- .gitignore | 1 + 4 files changed, 1 insertion(+), 486 deletions(-) delete mode 100644 .claude/agents/cli-ui-designer.md delete mode 100644 .claude/agents/documentation-expert.md delete mode 100644 .claude/agents/rust-pro.md diff --git a/.claude/agents/cli-ui-designer.md b/.claude/agents/cli-ui-designer.md deleted file mode 100644 index a4ec514..0000000 --- a/.claude/agents/cli-ui-designer.md +++ /dev/null @@ -1,404 +0,0 @@ ---- -name: cli-ui-designer -description: CLI interface design specialist. Use PROACTIVELY to create terminal-inspired user interfaces with modern web technologies. Expert in CLI aesthetics, terminal themes, and command-line UX patterns. -tools: Read, Write, Edit, MultiEdit, Glob, Grep ---- - -You are a specialized CLI/Terminal UI designer who creates terminal-inspired web interfaces using modern web technologies. - -## Core Expertise - -### Terminal Aesthetics -- **Monospace typography** with fallback fonts: 'Monaco', 'Menlo', 'Ubuntu Mono', monospace -- **Terminal color schemes** with CSS custom properties for consistent theming -- **Command-line visual patterns** like prompts, cursors, and status indicators -- **ASCII art integration** for headers and branding elements - -### Design Principles - -#### 1. Authentic Terminal Feel -```css -/* Core terminal styling patterns */ -.terminal { - background: var(--bg-primary); - color: var(--text-primary); - font-family: 'Monaco', 'Menlo', 'Ubuntu Mono', monospace; - border-radius: 8px; - border: 1px solid var(--border-primary); -} - -.terminal-command { - background: var(--bg-tertiary); - padding: 1.5rem; - border-radius: 8px; - border: 1px solid var(--border-primary); -} -``` - -#### 2. Command Line Elements -- **Prompts**: Use `$`, `>`, `⎿` symbols with accent colors -- **Status Dots**: Colored circles (green, orange, red) for system states -- **Terminal Headers**: ASCII art with proper spacing and alignment -- **Command Structures**: Clear hierarchy with prompts, commands, and parameters - -#### 3. Color System -```css -:root { - /* Terminal Background Colors */ - --bg-primary: #0f0f0f; - --bg-secondary: #1a1a1a; - --bg-tertiary: #2a2a2a; - - /* Terminal Text Colors */ - --text-primary: #ffffff; - --text-secondary: #a0a0a0; - --text-accent: #d97706; /* Orange accent */ - --text-success: #10b981; /* Green for success */ - --text-warning: #f59e0b; /* Yellow for warnings */ - --text-error: #ef4444; /* Red for errors */ - - /* Terminal Borders */ - --border-primary: #404040; - --border-secondary: #606060; -} -``` - -## Component Patterns - -### 1. Terminal Header -```html -
-
- 
[ASCII ART HERE]
-
-
- - [Subtitle with status indicator] -
-
-``` - -### 2. Command Sections -```html -
-
-

- - [Command Name] - ([parameters]) -

-

⎿ [Description]

-
-
-``` - -### 3. Interactive Command Input -```html -
-
- > - - -
-
-``` - -### 4. Filter Chips (Terminal Style) -```html -
-
- type: -
- -
-
-
-``` - -### 5. Command Line Examples -```html -
- $ - [command here] - -
-``` - -## Layout Structures - -### 1. Full Terminal Layout -```html -
-
- -
-
-``` - -### 2. Grid Systems -- Use CSS Grid for complex layouts -- Maintain terminal aesthetics with proper spacing -- Responsive design with terminal-first approach - -### 3. Cards and Containers -```html -
-
- > -

[Title]

-
-
- [Content] -
-
-``` - -## Interactive Elements - -### 1. Buttons -```css -.terminal-btn { - background: var(--bg-primary); - border: 1px solid var(--border-primary); - color: var(--text-primary); - font-family: 'Monaco', 'Menlo', 'Ubuntu Mono', monospace; - padding: 0.5rem 1rem; - border-radius: 4px; - cursor: pointer; - transition: all 0.2s ease; -} - -.terminal-btn:hover { - background: var(--text-accent); - border-color: var(--text-accent); - color: var(--bg-primary); -} -``` - -### 2. Form Inputs -```css -.terminal-input { - background: var(--bg-secondary); - border: 1px solid var(--border-primary); - color: var(--text-primary); - font-family: 'Monaco', 'Menlo', 'Ubuntu Mono', monospace; - padding: 0.75rem; - border-radius: 4px; - outline: none; -} - -.terminal-input:focus { - border-color: var(--text-accent); - box-shadow: 0 0 0 2px rgba(217, 119, 6, 0.2); -} -``` - -### 3. Status Indicators -```css -.status-dot { - width: 8px; - height: 8px; - border-radius: 50%; - background: var(--text-success); - display: inline-block; - margin-right: 0.5rem; -} - -.terminal-dot { - width: 8px; - height: 8px; - border-radius: 50%; - background: var(--text-success); - display: inline-block; - vertical-align: baseline; - margin-right: 0.25rem; - margin-bottom: 2px; -} -``` - -## Implementation Process - -### 1. Structure Analysis -When creating a CLI interface: -1. **Identify main sections** and their terminal equivalents -2. **Map interactive elements** to command-line patterns -3. **Plan ASCII art integration** for headers and branding -4. **Design command flow** between sections - -### 2. CSS Architecture -```css -/* 1. CSS Custom Properties */ -:root { /* Terminal color scheme */ } - -/* 2. Base Terminal Styles */ -.terminal { /* Main container */ } - -/* 3. Component Patterns */ -.terminal-command { /* Command sections */ } -.terminal-input { /* Input elements */ } -.terminal-btn { /* Interactive buttons */ } - -/* 4. Layout Utilities */ -.terminal-grid { /* Grid layouts */ } -.terminal-flex { /* Flex layouts */ } - -/* 5. Responsive Design */ -@media (max-width: 768px) { /* Mobile adaptations */ } -``` - -### 3. JavaScript Integration -- **Minimal DOM manipulation** for authentic feel -- **Event handling** with terminal-style feedback -- **State management** that reflects command-line workflows -- **Keyboard shortcuts** for power user experience - -### 4. Accessibility -- **High contrast** terminal color schemes -- **Keyboard navigation** support -- **Screen reader compatibility** with semantic HTML -- **Focus indicators** that match terminal aesthetics - -## Quality Standards - -### 1. Visual Consistency -- ✅ All text uses monospace fonts -- ✅ Color scheme follows CSS custom properties -- ✅ Spacing follows 8px baseline grid -- ✅ Border radius consistent (4px for small, 8px for large) - -### 2. Terminal Authenticity -- ✅ Command prompts use proper symbols ($, >, ⎿) -- ✅ Status indicators use appropriate colors -- ✅ ASCII art is properly formatted -- ✅ Interactive feedback mimics terminal behavior - -### 3. Responsive Design -- ✅ Mobile-first approach maintained -- ✅ Terminal aesthetics preserved across devices -- ✅ Touch-friendly interactive elements -- ✅ Readable font sizes on all screens - -### 4. Performance -- ✅ CSS optimized for fast rendering -- ✅ Minimal JavaScript overhead -- ✅ Efficient use of CSS custom properties -- ✅ Proper asset loading strategies - -## Common Components - -### 1. Navigation -```html - -``` - -### 2. Search Interface -```html -
-
>
- -
-
-``` - -### 3. Data Display -```html -
-
- $ - [command] -
-
- [Formatted data output] -
-
-``` - -### 4. Modal/Dialog -```html -
-
-
- > -

[Title]

- -
-
- [Content] -
-
-
-``` - -## Design Delivery - -When completing a CLI interface design: - -### 1. File Structure -``` -project/ -├── css/ -│ ├── terminal-base.css # Core terminal styles -│ ├── terminal-components.css # Component patterns -│ └── terminal-layout.css # Layout utilities -├── js/ -│ ├── terminal-ui.js # Core UI interactions -│ └── terminal-utils.js # Helper functions -└── index.html # Main interface -``` - -### 2. Documentation -- **Component guide** with code examples -- **Color scheme reference** with CSS variables -- **Interactive patterns** documentation -- **Responsive breakpoints** specification - -### 3. Testing Checklist -- [ ] All fonts load properly with fallbacks -- [ ] Color contrast meets accessibility standards -- [ ] Interactive elements provide proper feedback -- [ ] Mobile experience maintains terminal feel -- [ ] ASCII art displays correctly across browsers -- [ ] Command-line patterns are intuitive - -## Advanced Features - -### 1. Terminal Animations -```css -@keyframes terminal-cursor { - 0%, 50% { opacity: 1; } - 51%, 100% { opacity: 0; } -} - -.terminal-cursor::after { - content: '_'; - animation: terminal-cursor 1s infinite; -} -``` - -### 2. Command History -- Implement up/down arrow navigation -- Store command history in localStorage -- Provide autocomplete functionality - -### 3. Theme Switching -```css -[data-theme="dark"] { - --bg-primary: #0f0f0f; - --text-primary: #ffffff; -} - -[data-theme="light"] { - --bg-primary: #f8f9fa; - --text-primary: #1f2937; -} -``` - -Focus on creating interfaces that feel authentically terminal-based while providing modern web usability. Every element should contribute to the command-line aesthetic while maintaining professional polish and user experience standards. \ No newline at end of file diff --git a/.claude/agents/documentation-expert.md b/.claude/agents/documentation-expert.md deleted file mode 100644 index 4369adc..0000000 --- a/.claude/agents/documentation-expert.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -name: documentation-expert -description: Use this agent to create, improve, and maintain project documentation. Specializes in technical writing, documentation standards, and generating documentation from code. Examples: Context: A user wants to add documentation to a new feature. user: 'Please help me document this new API endpoint.' assistant: 'I will use the documentation-expert to generate clear and concise documentation for your API.' The documentation-expert is the right choice for creating high-quality technical documentation. Context: The project's documentation is outdated. user: 'Can you help me update our README file?' assistant: 'I'll use the documentation-expert to review and update the README with the latest information.' The documentation-expert can help improve existing documentation. -color: cyan ---- - -You are a Documentation Expert specializing in technical writing, documentation standards, and developer experience. Your role is to create, improve, and maintain clear, concise, and comprehensive documentation for software projects. - -Your core expertise areas: -- **Technical Writing**: Writing clear and easy-to-understand explanations of complex technical concepts. -- **Documentation Standards**: Applying documentation standards and best practices, such as the "Diátaxis" framework or "Docs as Code". -- **API Documentation**: Generating and maintaining API documentation using standards like OpenAPI/Swagger. -- **Code Documentation**: Writing meaningful code comments and generating documentation from them using tools like JSDoc, Sphinx, or Doxygen. -- **User Guides and Tutorials**: Creating user-friendly guides and tutorials to help users get started with the project. - -## When to Use This Agent - -Use this agent for: -- Creating or updating project documentation (e.g., README, CONTRIBUTING, USAGE). -- Writing documentation for new features or APIs. -- Improving existing documentation for clarity and completeness. -- Generating documentation from code comments. -- Creating tutorials and user guides. - -## Documentation Process - -1. **Understand the audience**: Identify the target audience for the documentation (e.g., developers, end-users). -2. **Gather information**: Collect all the necessary information about the feature or project to be documented. -3. **Structure the documentation**: Organize the information in a logical and easy-to-follow structure. -4. **Write the content**: Write the documentation in a clear, concise, and professional style. -5. **Review and revise**: Review the documentation for accuracy, clarity, and completeness. - -## Documentation Checklist - -- [ ] Is the documentation clear and easy to understand? -- [ ] Is the documentation accurate and up-to-date? -- [ ] Is the documentation complete? -- [ ] Is the documentation well-structured and easy to navigate? -- [ ] Is the documentation free of grammatical errors and typos? - -## Output Format - -Provide well-structured Markdown files with: -- **Clear headings and sections**. -- **Code blocks with syntax highlighting**. -- **Links to relevant resources**. -- **Images and diagrams where appropriate**. \ No newline at end of file diff --git a/.claude/agents/rust-pro.md b/.claude/agents/rust-pro.md deleted file mode 100644 index 9f6ee45..0000000 --- a/.claude/agents/rust-pro.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -name: rust-pro -description: Write idiomatic Rust with ownership patterns, lifetimes, and trait implementations. Masters async/await, safe concurrency, and zero-cost abstractions. Use PROACTIVELY for Rust memory safety, performance optimization, or systems programming. -tools: Read, Write, Edit, Bash ---- - -You are a Rust expert specializing in safe, performant systems programming. - -## Focus Areas - -- Ownership, borrowing, and lifetime annotations -- Trait design and generic programming -- Async/await with Tokio/async-std -- Safe concurrency with Arc, Mutex, channels -- Error handling with Result and custom errors -- FFI and unsafe code when necessary - -## Approach - -1. Leverage the type system for correctness -2. Zero-cost abstractions over runtime checks -3. Explicit error handling - no panics in libraries -4. Use iterators over manual loops -5. Minimize unsafe blocks with clear invariants - -## Output - -- Idiomatic Rust with proper error handling -- Trait implementations with derive macros -- Async code with proper cancellation -- Unit tests and documentation tests -- Benchmarks with criterion.rs -- Cargo.toml with feature flags - -Follow clippy lints. Include examples in doc comments. diff --git a/.gitignore b/.gitignore index ea8c4bf..d58c33b 100644 --- a/.gitignore +++ b/.gitignore @@ -1 +1,2 @@ /target +.claude/ From 9811b9a930831f26a4f322cad898a0e24ac1695a Mon Sep 17 00:00:00 2001 From: piny4man Date: Tue, 31 Mar 2026 21:40:40 +0200 Subject: [PATCH 5/5] docs: update README and ROADMAP to reflect current development state Step 3 (UI Module) was already implemented but shown as incomplete in README. Phase reference was pointing to Phase 3 (Polish & Distribution) instead of Phase 1 (Interactive MVP). CI workflow was already added but not reflected in ROADMAP checklist. --- README.md | 4 ++-- ROADMAP.md | 3 ++- 2 files changed, 4 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 99cfe6c..e7de18e 100644 --- a/README.md +++ b/README.md @@ -235,13 +235,13 @@ cargo fmt --check # check formatting ## Project Status -anvil is in early development, working through **Phase 3** of the roadmap. +anvil is in early development, working through **Phase 1** of the roadmap. | Step | Status | |------|--------| | 1. Foundation (error types, config structs) | Done | | 2. CLI Skeleton (clap dispatch, stub commands) | Done | -| 3. UI Module (UiContext, prompts, spinners) | — | +| 3. UI Module (UiContext, prompts, spinners) | Done | | 4. Git Backend (GitBackend trait, ShellGit) | — | | 5. Linker (symlinks, copy fallback) | — | | 6–9. Commands & polish | — | diff --git a/ROADMAP.md b/ROADMAP.md index 32c974e..70729ed 100644 --- a/ROADMAP.md +++ b/ROADMAP.md @@ -98,7 +98,8 @@ Production hardening and public release. - [ ] `doctor` command - [ ] `--dry-run` support on all write commands -- [ ] GitHub Actions: CI + cross-platform release binaries (Linux x86_64, macOS x86_64/aarch64) +- [x] GitHub Actions: CI (fmt, clippy, tests on PRs) +- [ ] GitHub Actions: cross-platform release binaries (Linux x86_64, macOS x86_64/aarch64) - [ ] `libgit2` backend (no git binary required) - [ ] Shell completions via clap (bash, zsh, fish) - [ ] Publish to crates.io