olemd/mail2couch
1
0
Fork 0
Code Issues Pull requests Projects Releases 1 Packages Wiki Activity Actions

feat: implement just-based build system with distinct binary names

Browse source 
Replace Makefile with justfile for better build management:

Build System Changes:
- Add comprehensive justfile with recipes for both implementations
- Configure Go to build as `mail2couch-go`
- Configure Rust to build as `mail2couch-rs` via Cargo.toml
- Add universal build, test, clean, and install recipes
- Include development convenience recipes and utility commands

New Justfile Features:
- `just build` - builds both implementations
- `just install` - installs both to /usr/local/bin
- `just test` - runs tests for both implementations
- `just sizes` - shows binary size comparison
- `just versions` - compares version outputs
- `just --list` - shows all available recipes

Documentation Updates:
- Update CLAUDE.md with justfile usage examples
- Replace make commands with just equivalents
- Add new utility commands (sizes, versions)
- Update IMPLEMENTATION_COMPARISON.md deployment sections

Benefits of just over make:
- Better command-line interface with `--list`
- More intuitive recipe syntax
- Better suited for development workflows
- Cross-platform compatibility
- Built-in help and documentation

Binary Naming:
- Go implementation: `mail2couch-go` (11M)
- Rust implementation: `mail2couch-rs` (8.3M)
- Clear distinction prevents conflicts
- Parallel installation support

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
Ole-Morten Duesund 2025-08-03 19:01:42 +02:00
commit 2cd65fd137
5 changed files with 374 additions and 27 deletions
Download patch file Download diff file Expand all files Collapse all files

131
CLAUDE.md
View file

@ -5,44 +5,112 @@ This file provides guidance to Claude Code (claude.ai/code) when working with co
## Project Overview
mail2couch is a utility for backing up mail from various sources (primarily IMAP) to CouchDB. The project supports two implementations:
- **Go implementation**: Located in `/go/` directory (currently the active implementation)
- **Rust implementation**: Planned but not yet implemented
- **Go implementation**: Located in `/go/` directory, builds as `mail2couch-go`
- **Rust implementation**: Located in `/rust/` directory, builds as `mail2couch-rs` (fully functional, more advanced)
## Development Commands
### Go Implementation (Primary)
### Universal Build Commands (Recommended)
```bash
# Build both implementations
just build
# Build individual implementations
just build-go # Builds go/mail2couch-go
just build-rust # Builds rust/target/release/mail2couch-rs
# Build optimized release versions
just build-release
# Install both binaries to /usr/local/bin
sudo just install
# Run tests for both implementations
just test
# Clean all build artifacts
just clean
# Format and check code
just fmt
just check
# Show binary sizes
just sizes
# Compare versions
just versions
# List all available recipes
just --list
```
### Go Implementation
```bash
# Build the application
cd go && go build -o mail2couch .
cd go && go build -o mail2couch-go .
# Run the application with automatic config discovery
cd go && ./mail2couch
cd go && ./mail2couch-go
# Run with specific config file
cd go && ./mail2couch --config /path/to/config.json
cd go && ./mail2couch-go --config /path/to/config.json
# Run with message limit (useful for large mailboxes)
cd go && ./mail2couch --max-messages 100
cd go && ./mail2couch-go --max-messages 100
# Run with both config and message limit
cd go && ./mail2couch --config /path/to/config.json --max-messages 50
# Run with dry-run mode
cd go && ./mail2couch-go --dry-run
# Run linting/static analysis
cd go && go vet ./...
# Run unit tests
cd go && go test ./...
# Check dependencies
cd go && go mod tidy
```
### Rust Implementation
```bash
# Build the application (release mode recommended)
cd rust && cargo build --release
# Run the application with automatic config discovery
cd rust && ./target/release/mail2couch-rs
# Run with specific config file
cd rust && ./target/release/mail2couch-rs --config /path/to/config.json
# Run with message limit
cd rust && ./target/release/mail2couch-rs --max-messages 100
# Run with dry-run mode
cd rust && ./target/release/mail2couch-rs --dry-run
# Run linting/static analysis
cd rust && cargo clippy -- -D warnings
# Run unit tests
cd rust && cargo test
# Format code
cd rust && cargo fmt
```
### Integration Testing
```bash
# Run integration tests with Podman containers
cd test && ./run-tests.sh
# Run specialized tests
cd test && ./test-wildcard-patterns.sh
cd test && ./test-incremental-sync.sh
# Run unit tests (none currently implemented)
cd go && go test ./...
# Check dependencies
cd go && go mod tidy
```
## Architecture
@ -90,11 +158,11 @@ This design ensures the same `config.json` format will work for both Go and Rust
### Current Implementation Status
#### Both Implementations
- ✅ Configuration loading with automatic file discovery
- ✅ Command line flag support for config file path
- ✅ Command line flag support (--config/-c, --max-messages/-m, --dry-run/-n)
- ✅ Per-account CouchDB database creation and management
- ✅ IMAP connection and mailbox listing
- ✅ Build error fixes
- ✅ Real IMAP message retrieval and parsing
- ✅ Email storage to CouchDB framework with native attachments
- ✅ Folder filtering logic with wildcard support (`*`, `?`, `[abc]` patterns)
@ -104,15 +172,40 @@ This design ensures the same `config.json` format will work for both Go and Rust
- ✅ Sync vs Archive mode implementation
- ✅ CouchDB attachment storage for email attachments
- ✅ Full message body and attachment handling with MIME multipart support
- ✅ Command line argument support (GNU-style --max-messages/-m and --config/-c flags)
- ✅ Per-account CouchDB databases for better organization
- ✅ Incremental sync functionality with IMAP SEARCH and sync metadata tracking
- ❌ Rust implementation
- ✅ Comprehensive --dry-run mode for safe configuration testing
#### Rust Implementation Additional Features
- ✅ Asynchronous processing with concurrent network operations
- ✅ Server-side IMAP keyword filtering (more efficient)
- ✅ Automatic retry logic with exponential backoff
- ✅ Structured error handling with detailed context
- ✅ Enhanced CLI with rich help system
- ✅ Comprehensive unit test coverage
- ✅ Emoji-enhanced logging for better user experience
#### Go Implementation Characteristics
- ✅ Sequential processing (simple and reliable)
- ✅ Minimal dependencies and fast compilation
- ✅ Client-side keyword filtering
- ✅ Basic error handling with continue-on-error semantics
### Key Dependencies
#### Go Implementation
- `github.com/emersion/go-imap/v2`: IMAP client library
- `github.com/go-kivik/kivik/v4`: CouchDB client library
- `github.com/spf13/pflag`: GNU-style command line flags
- `github.com/emersion/go-message`: Email parsing
#### Rust Implementation
- `async-imap`: Asynchronous IMAP client
- `reqwest`: HTTP client for CouchDB API
- `tokio`: Async runtime and utilities
- `clap`: Command line argument parsing
- `serde`: Serialization framework
- `mail-parser`: Email parsing with MIME support
### Incremental Sync Implementation

36
IMPLEMENTATION_COMPARISON.md
View file

@ -442,6 +442,8 @@ Both implementations currently share the same security limitations and features:
### Go Implementation Deployment
**Binary Name**: `mail2couch-go`
**Advantages**:
- Single binary deployment
- Minimal system dependencies
@ -450,16 +452,21 @@ Both implementations currently share the same security limitations and features:
**Best Practices**:
```bash
# Build for production
cd go && go build -ldflags="-s -w" -o mail2couch .
# Build for production using justfile
just build-go-release
# Or build directly
cd go && go build -ldflags="-s -w" -o mail2couch-go .
# Deploy with systemd service
sudo cp mail2couch /usr/local/bin/
sudo systemctl enable mail2couch.service
sudo cp go/mail2couch-go /usr/local/bin/
sudo systemctl enable mail2couch-go.service
```
### Rust Implementation Deployment
**Binary Name**: `mail2couch-rs`
**Advantages**:
- Better resource utilization under load
- Superior error recovery
@ -468,18 +475,33 @@ sudo systemctl enable mail2couch.service
**Best Practices**:
```bash
# Build optimized release
# Build optimized release using justfile
just build-rust-release
# Or build directly
cd rust && cargo build --release
# Deploy with enhanced monitoring
sudo cp target/release/mail2couch /usr/local/bin/
sudo systemctl enable mail2couch.service
sudo cp rust/target/release/mail2couch-rs /usr/local/bin/
sudo systemctl enable mail2couch-rs.service
# Configure structured logging
export RUST_LOG=info
export MAIL2COUCH_LOG_FORMAT=json
```
### Universal Installation
```bash
# Build and install both implementations
just build-release
sudo just install
# This installs:
# - /usr/local/bin/mail2couch-go
# - /usr/local/bin/mail2couch-rs
```
---
## Future Development Roadmap

119
Makefile Normal file
View file

@ -0,0 +1,119 @@
# Makefile for mail2couch project
# Builds both Go and Rust implementations with distinct binary names
.PHONY: all build build-go build-rust clean test help install
# Default target
all: build
# Build both implementations
build: build-go build-rust
# Build Go implementation as mail2couch-go
build-go:
@echo "Building Go implementation..."
cd go && go build -o mail2couch-go .
@echo "✅ Built: go/mail2couch-go"
# Build Rust implementation as mail2couch-rs
build-rust:
@echo "Building Rust implementation..."
cd rust && cargo build --release
@echo "✅ Built: rust/target/release/mail2couch-rs"
# Build optimized release versions
build-release: build-go-release build-rust-release
# Build optimized Go release
build-go-release:
@echo "Building optimized Go release..."
cd go && go build -ldflags="-s -w" -o mail2couch-go .
@echo "✅ Built optimized: go/mail2couch-go"
# Build optimized Rust release (already built with --release above)
build-rust-release: build-rust
# Install binaries to /usr/local/bin (requires sudo)
install: build-release
@echo "Installing binaries to /usr/local/bin..."
sudo cp go/mail2couch-go /usr/local/bin/
sudo cp rust/target/release/mail2couch-rs /usr/local/bin/
sudo chmod +x /usr/local/bin/mail2couch-go
sudo chmod +x /usr/local/bin/mail2couch-rs
@echo "✅ Installed mail2couch-go and mail2couch-rs"
# Run tests for both implementations
test: test-go test-rust
# Test Go implementation
test-go:
@echo "Running Go tests..."
cd go && go test ./...
# Test Rust implementation
test-rust:
@echo "Running Rust tests..."
cd rust && cargo test
# Clean build artifacts
clean:
@echo "Cleaning build artifacts..."
cd go && rm -f mail2couch-go mail2couch
cd rust && cargo clean
@echo "✅ Cleaned build artifacts"
# Check code formatting and linting
check: check-go check-rust
# Check Go code
check-go:
@echo "Checking Go code..."
cd go && go fmt ./...
cd go && go vet ./...
# Check Rust code
check-rust:
@echo "Checking Rust code..."
cd rust && cargo fmt --check
cd rust && cargo clippy -- -D warnings
# Fix code formatting
fmt: fmt-go fmt-rust
# Format Go code
fmt-go:
@echo "Formatting Go code..."
cd go && go fmt ./...
# Format Rust code
fmt-rust:
@echo "Formatting Rust code..."
cd rust && cargo fmt
# Show help
help:
@echo "Available targets:"
@echo " all - Build both implementations (default)"
@echo " build - Build both implementations"
@echo " build-go - Build Go implementation (mail2couch-go)"
@echo " build-rust - Build Rust implementation (mail2couch-rs)"
@echo " build-release - Build optimized release versions"
@echo " install - Install binaries to /usr/local/bin (requires sudo)"
@echo " test - Run tests for both implementations"
@echo " test-go - Run Go tests"
@echo " test-rust - Run Rust tests"
@echo " clean - Clean build artifacts"
@echo " check - Check code formatting and linting"
@echo " fmt - Format code"
@echo " help - Show this help message"
@echo ""
@echo "Output binaries:"
@echo " go/mail2couch-go - Go implementation"
@echo " rust/target/release/mail2couch-rs - Rust implementation"
# Development convenience targets
dev-go: build-go
./go/mail2couch-go --help
dev-rust: build-rust
./rust/target/release/mail2couch-rs --help

113
justfile Normal file
View file

@ -0,0 +1,113 @@
# Justfile for mail2couch project
# Builds both Go and Rust implementations with distinct binary names
# Default recipe
default: build
# Build both implementations
build: build-go build-rust
# Build Go implementation as mail2couch-go
build-go:
@echo "Building Go implementation..."
cd go && go build -o mail2couch-go .
@echo "✅ Built: go/mail2couch-go"
# Build Rust implementation as mail2couch-rs
build-rust:
@echo "Building Rust implementation..."
cd rust && cargo build --release
@echo "✅ Built: rust/target/release/mail2couch-rs"
# Build optimized release versions
build-release: build-go-release build-rust-release
# Build optimized Go release
build-go-release:
@echo "Building optimized Go release..."
cd go && go build -ldflags="-s -w" -o mail2couch-go .
@echo "✅ Built optimized: go/mail2couch-go"
# Build optimized Rust release (already built with --release above)
build-rust-release: build-rust
# Install binaries to /usr/local/bin (requires sudo)
install: build-release
@echo "Installing binaries to /usr/local/bin..."
sudo cp go/mail2couch-go /usr/local/bin/
sudo cp rust/target/release/mail2couch-rs /usr/local/bin/
sudo chmod +x /usr/local/bin/mail2couch-go
sudo chmod +x /usr/local/bin/mail2couch-rs
@echo "✅ Installed mail2couch-go and mail2couch-rs"
# Run tests for both implementations
test: test-go test-rust
# Test Go implementation
test-go:
@echo "Running Go tests..."
cd go && go test ./...
# Test Rust implementation
test-rust:
@echo "Running Rust tests..."
cd rust && cargo test
# Clean build artifacts
clean:
@echo "Cleaning build artifacts..."
cd go && rm -f mail2couch-go mail2couch
cd rust && cargo clean
@echo "✅ Cleaned build artifacts"
# Check code formatting and linting
check: check-go check-rust
# Check Go code
check-go:
@echo "Checking Go code..."
cd go && go fmt ./...
cd go && go vet ./...
# Check Rust code
check-rust:
@echo "Checking Rust code..."
cd rust && cargo fmt --check
cd rust && cargo clippy -- -D warnings
# Fix code formatting
fmt: fmt-go fmt-rust
# Format Go code
fmt-go:
@echo "Formatting Go code..."
cd go && go fmt ./...
# Format Rust code
fmt-rust:
@echo "Formatting Rust code..."
cd rust && cargo fmt
# Development convenience - build and test Go version
dev-go: build-go
./go/mail2couch-go --help
# Development convenience - build and test Rust version
dev-rust: build-rust
./rust/target/release/mail2couch-rs --help
# Show binary sizes
sizes: build
@echo "Binary sizes:"
@ls -lh go/mail2couch-go rust/target/release/mail2couch-rs | awk '{print $5 "\t" $9}'
# Run both binaries with --version to compare
versions: build
@echo "Go version:"
@./go/mail2couch-go --help | head -1
@echo ""
@echo "Rust version:"
@./rust/target/release/mail2couch-rs --version
# Clean and rebuild everything
rebuild: clean build

2
rust/Cargo.toml
View file

@ -65,5 +65,5 @@ name = "mail2couch"
path = "src/lib.rs"
[[bin]]
name = "mail2couch"
name = "mail2couch-rs"
path = "src/main.rs"