mirror of
https://github.com/yarlson/lnk.git
synced 2025-09-24 21:11:27 +02:00
Compare commits
40 Commits
Author | SHA1 | Date | |
---|---|---|---|
|
30ab78d506 | ||
|
7f10e1ce8a | ||
|
57839c795e | ||
|
dc524607fa | ||
|
9bf2e70d13 | ||
|
65db5fe738 | ||
|
43b68bc071 | ||
|
ab97fa86dc | ||
|
4cd8191805 | ||
|
6830c06eb4 | ||
|
8a29b7fe43 | ||
|
a6852e5ad5 | ||
|
36d76c881c | ||
|
6de387797e | ||
|
9cbad5e593 | ||
|
150e8adf8b | ||
|
4b11563bdf | ||
|
b476ce503b | ||
|
ae9cc175ce | ||
|
1e2c9704f3 | ||
|
3cba309c05 | ||
|
3e6b426a19 | ||
|
02f342b02b | ||
|
92f2575090 | ||
|
0f74723a03 | ||
|
093cc8ebe7 | ||
|
ff3cddc065 | ||
|
4a275ce4ca | ||
|
69c1038f3e | ||
|
c670ac1fd8 | ||
|
27196e3341 | ||
|
84c507828d | ||
|
d02f112200 | ||
|
f96bfb6ce0 | ||
|
7007ec64f2 | ||
|
ec6ad6b0d0 | ||
|
e7f316ea6e | ||
|
09d67f181e | ||
|
3a34e4fb37 | ||
|
fc0b567e9f |
17
.github/dependabot.yml
vendored
Normal file
17
.github/dependabot.yml
vendored
Normal file
@@ -0,0 +1,17 @@
|
||||
# https://docs.github.com/en/code-security/dependabot/dependabot-version-updates/optimizing-pr-creation-version-updates#setting-up-a-cooldown-period-for-dependency-updates
|
||||
|
||||
version: 2
|
||||
updates:
|
||||
- package-ecosystem: github-actions
|
||||
directory: /
|
||||
schedule:
|
||||
interval: weekly
|
||||
# https://docs.github.com/en/code-security/dependabot/working-with-dependabot/dependabot-options-reference#groups--
|
||||
groups:
|
||||
actions:
|
||||
# Combine all images of last week
|
||||
patterns: ["*"]
|
||||
- package-ecosystem: gomod
|
||||
directory: /
|
||||
schedule:
|
||||
interval: weekly
|
22
.github/workflows/ci.yml
vendored
22
.github/workflows/ci.yml
vendored
@@ -6,6 +6,12 @@ on:
|
||||
pull_request:
|
||||
branches: [ main ]
|
||||
|
||||
permissions:
|
||||
contents: read
|
||||
|
||||
env:
|
||||
GO_VERSION: '1.24'
|
||||
|
||||
jobs:
|
||||
test:
|
||||
runs-on: ubuntu-latest
|
||||
@@ -16,10 +22,10 @@ jobs:
|
||||
- name: Set up Go
|
||||
uses: actions/setup-go@v5
|
||||
with:
|
||||
go-version: '1.24'
|
||||
go-version: ${{ env.GO_VERSION }}
|
||||
|
||||
- name: Cache Go modules
|
||||
uses: actions/cache@v3
|
||||
uses: actions/cache@v4
|
||||
with:
|
||||
path: ~/go/pkg/mod
|
||||
key: ${{ runner.os }}-go-${{ hashFiles('**/go.sum') }}
|
||||
@@ -38,12 +44,12 @@ jobs:
|
||||
run: go vet ./...
|
||||
|
||||
- name: Test
|
||||
run: go test -v -race -coverprofile=coverage.out ./test
|
||||
run: go test -v -race -coverprofile=coverage.out ./...
|
||||
|
||||
- name: Upload coverage to Codecov
|
||||
uses: codecov/codecov-action@v3
|
||||
uses: codecov/codecov-action@v5
|
||||
with:
|
||||
file: ./coverage.out
|
||||
files: ./coverage.out
|
||||
|
||||
lint:
|
||||
runs-on: ubuntu-latest
|
||||
@@ -54,10 +60,10 @@ jobs:
|
||||
- name: Set up Go
|
||||
uses: actions/setup-go@v5
|
||||
with:
|
||||
go-version: '1.24'
|
||||
go-version: ${{ env.GO_VERSION }}
|
||||
|
||||
- name: golangci-lint
|
||||
uses: golangci/golangci-lint-action@v3
|
||||
uses: golangci/golangci-lint-action@v8
|
||||
with:
|
||||
version: latest
|
||||
|
||||
@@ -71,7 +77,7 @@ jobs:
|
||||
- name: Set up Go
|
||||
uses: actions/setup-go@v5
|
||||
with:
|
||||
go-version: '1.24'
|
||||
go-version: ${{ env.GO_VERSION }}
|
||||
|
||||
- name: Build
|
||||
run: go build -v ./...
|
||||
|
2
.github/workflows/release.yml
vendored
2
.github/workflows/release.yml
vendored
@@ -23,7 +23,7 @@ jobs:
|
||||
go-version: '1.24'
|
||||
|
||||
- name: Run tests
|
||||
run: go test ./test
|
||||
run: go test ./...
|
||||
|
||||
- name: Run GoReleaser
|
||||
uses: goreleaser/goreleaser-action@v6
|
||||
|
2
.gitignore
vendored
2
.gitignore
vendored
@@ -44,3 +44,5 @@ desktop.ini
|
||||
|
||||
# GoReleaser artifacts
|
||||
goreleaser/
|
||||
*.md
|
||||
!/README.md
|
||||
|
8
Makefile
8
Makefile
@@ -60,19 +60,19 @@ build:
|
||||
## test: Run tests
|
||||
test:
|
||||
@echo "$(BLUE)Running tests...$(NC)"
|
||||
@go test ./test
|
||||
@go test ./...
|
||||
@echo "$(GREEN)✓ Tests passed$(NC)"
|
||||
|
||||
## test-v: Run tests with verbose output
|
||||
test-v:
|
||||
@echo "$(BLUE)Running tests (verbose)...$(NC)"
|
||||
@go test -v ./test
|
||||
@go test -v ./...
|
||||
|
||||
## test-cover: Run tests with coverage
|
||||
test-cover:
|
||||
@echo "$(BLUE)Running tests with coverage...$(NC)"
|
||||
@go test -v -cover ./test
|
||||
@go test -coverprofile=coverage.out ./test
|
||||
@go test -v -cover ./...
|
||||
@go test -coverprofile=coverage.out ./
|
||||
@go tool cover -html=coverage.out -o coverage.html
|
||||
@echo "$(GREEN)✓ Coverage report generated: coverage.html$(NC)"
|
||||
|
||||
|
373
README.md
373
README.md
@@ -2,11 +2,18 @@
|
||||
|
||||
**Git-native dotfiles management that doesn't suck.**
|
||||
|
||||
Move your dotfiles to `~/.config/lnk`, symlink them back, and use Git like normal. That's it.
|
||||
Lnk makes managing your dotfiles straightforward, no tedious setups, no complex configurations. Just tell Lnk what files you want tracked, and it'll automatically move them into a tidy Git repository under `~/.config/lnk`. It then creates clean, portable symlinks back to their original locations. Easy.
|
||||
|
||||
Why bother with Lnk instead of plain old Git or other dotfile managers? Unlike traditional methods, Lnk automates the boring parts: safely relocating files, handling host-specific setups, bulk operations for multiple files, recursive directory processing, and even running your custom bootstrap scripts automatically. This means fewer manual steps and less chance of accidentally overwriting something important.
|
||||
|
||||
With Lnk, your dotfiles setup stays organized and effortlessly portable, letting you spend more time doing real work, not wrestling with configuration files.
|
||||
|
||||
```bash
|
||||
lnk init
|
||||
lnk add ~/.vimrc ~/.bashrc
|
||||
lnk init -r git@github.com:user/dotfiles.git # Clones & runs bootstrap automatically
|
||||
lnk add ~/.vimrc ~/.bashrc ~/.gitconfig # Multiple files at once
|
||||
lnk add --recursive ~/.config/nvim # Process directory contents
|
||||
lnk add --dry-run ~/.tmux.conf # Preview changes first
|
||||
lnk add --host work ~/.ssh/config # Host-specific config
|
||||
lnk push "setup"
|
||||
```
|
||||
|
||||
@@ -19,7 +26,6 @@ curl -sSL https://raw.githubusercontent.com/yarlson/lnk/main/install.sh | bash
|
||||
|
||||
```bash
|
||||
# Homebrew (macOS/Linux)
|
||||
brew tap yarlson/lnk
|
||||
brew install lnk
|
||||
```
|
||||
|
||||
@@ -42,107 +48,388 @@ git clone https://github.com/yarlson/lnk.git && cd lnk && go build . && sudo mv
|
||||
# Fresh start
|
||||
lnk init
|
||||
|
||||
# With existing repo
|
||||
# With existing repo (runs bootstrap automatically)
|
||||
lnk init -r git@github.com:user/dotfiles.git
|
||||
|
||||
# Skip automatic bootstrap
|
||||
lnk init -r git@github.com:user/dotfiles.git --no-bootstrap
|
||||
|
||||
# Force initialization (WARNING: overwrites existing managed files)
|
||||
lnk init -r git@github.com:user/dotfiles.git --force
|
||||
|
||||
# Run bootstrap script manually
|
||||
lnk bootstrap
|
||||
```
|
||||
|
||||
### Daily workflow
|
||||
|
||||
```bash
|
||||
# Add files/directories
|
||||
lnk add ~/.vimrc ~/.config/nvim ~/.gitconfig
|
||||
# Add multiple files at once (common config)
|
||||
lnk add ~/.vimrc ~/.bashrc ~/.gitconfig ~/.tmux.conf
|
||||
|
||||
# Add directory contents individually
|
||||
lnk add --recursive ~/.config/nvim ~/.config/zsh
|
||||
|
||||
# Preview changes before applying
|
||||
lnk add --dry-run ~/.config/git/config
|
||||
lnk add --dry-run --recursive ~/.config/kitty
|
||||
|
||||
# Add host-specific files (supports bulk operations)
|
||||
lnk add --host laptop ~/.ssh/config ~/.aws/credentials
|
||||
lnk add --host work ~/.gitconfig ~/.ssh/config
|
||||
|
||||
# List managed files
|
||||
lnk list # Common config only
|
||||
lnk list --host laptop # Laptop-specific config
|
||||
lnk list --all # All configurations
|
||||
|
||||
# Check status
|
||||
lnk status
|
||||
|
||||
# Sync changes
|
||||
lnk push "updated vim config"
|
||||
lnk pull
|
||||
lnk pull # Pull common config
|
||||
lnk pull --host laptop # Pull laptop-specific config
|
||||
```
|
||||
|
||||
## How it works
|
||||
|
||||
```
|
||||
Common files:
|
||||
Before: ~/.vimrc (file)
|
||||
After: ~/.vimrc -> ~/.config/lnk/.vimrc (symlink)
|
||||
|
||||
Host-specific files:
|
||||
Before: ~/.ssh/config (file)
|
||||
After: ~/.ssh/config -> ~/.config/lnk/laptop.lnk/.ssh/config (symlink)
|
||||
```
|
||||
|
||||
Your files live in `~/.config/lnk` (a Git repo). Lnk creates symlinks back to original locations. Edit files normally, use Git normally.
|
||||
Your files live in `~/.config/lnk` (a Git repo). Common files go in the root, host-specific files go in `<host>.lnk/` subdirectories. Lnk creates symlinks back to original locations. Edit files normally, use Git normally.
|
||||
|
||||
## Safety Features
|
||||
|
||||
Lnk includes built-in safety checks to prevent accidental data loss:
|
||||
|
||||
### Data Loss Prevention
|
||||
|
||||
```bash
|
||||
# This will be blocked if you already have managed files
|
||||
lnk init -r git@github.com:user/dotfiles.git
|
||||
# ❌ Directory ~/.config/lnk already contains managed files
|
||||
# 💡 Use 'lnk pull' to update from remote instead of 'lnk init -r'
|
||||
|
||||
# Use pull instead to safely update
|
||||
lnk pull
|
||||
|
||||
# Or force if you understand the risks (shows warning only when needed)
|
||||
lnk init -r git@github.com:user/dotfiles.git --force
|
||||
# ⚠️ Using --force flag: This will overwrite existing managed files
|
||||
# 💡 Only use this if you understand the risks
|
||||
```
|
||||
|
||||
### Smart Warnings
|
||||
|
||||
- **Contextual alerts**: Warnings only appear when there are actually managed files to overwrite
|
||||
- **Clear guidance**: Error messages suggest the correct command to use
|
||||
- **Force override**: Advanced users can bypass safety checks when needed
|
||||
|
||||
## Bootstrap Support
|
||||
|
||||
Lnk automatically runs bootstrap scripts when cloning dotfiles repositories, making it easy to set up your development environment. Just add a `bootstrap.sh` file to your dotfiles repo.
|
||||
|
||||
### Examples
|
||||
|
||||
**Simple bootstrap script:**
|
||||
|
||||
```bash
|
||||
#!/bin/bash
|
||||
# bootstrap.sh
|
||||
echo "Setting up development environment..."
|
||||
|
||||
# Install Homebrew (macOS)
|
||||
if ! command -v brew &> /dev/null; then
|
||||
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
|
||||
fi
|
||||
|
||||
# Install packages
|
||||
brew install git vim tmux
|
||||
|
||||
echo "✅ Setup complete!"
|
||||
```
|
||||
|
||||
**Usage:**
|
||||
|
||||
```bash
|
||||
# Automatic bootstrap on clone
|
||||
lnk init -r git@github.com:you/dotfiles.git
|
||||
# → Clones repo and runs bootstrap script automatically
|
||||
|
||||
# Skip bootstrap if needed
|
||||
lnk init -r git@github.com:you/dotfiles.git --no-bootstrap
|
||||
|
||||
# Run bootstrap manually later
|
||||
lnk bootstrap
|
||||
```
|
||||
|
||||
## Multihost Support
|
||||
|
||||
Lnk supports both **common configurations** (shared across all machines) and **host-specific configurations** (unique per machine).
|
||||
|
||||
### File Organization
|
||||
|
||||
```
|
||||
~/.config/lnk/
|
||||
├── .lnk # Tracks common files
|
||||
├── .lnk.laptop # Tracks laptop-specific files
|
||||
├── .lnk.work # Tracks work-specific files
|
||||
├── .vimrc # Common file
|
||||
├── .gitconfig # Common file
|
||||
├── laptop.lnk/ # Laptop-specific storage
|
||||
│ ├── .ssh/
|
||||
│ │ └── config
|
||||
│ └── .tmux.conf
|
||||
└── work.lnk/ # Work-specific storage
|
||||
├── .ssh/
|
||||
│ └── config
|
||||
└── .gitconfig
|
||||
```
|
||||
|
||||
### Usage Patterns
|
||||
|
||||
```bash
|
||||
# Common config (shared everywhere) - supports multiple files
|
||||
lnk add ~/.vimrc ~/.bashrc ~/.gitconfig ~/.tmux.conf
|
||||
|
||||
# Process directory contents individually
|
||||
lnk add --recursive ~/.config/nvim ~/.config/zsh
|
||||
|
||||
# Preview operations before making changes
|
||||
lnk add --dry-run ~/.config/alacritty/alacritty.yml
|
||||
lnk add --dry-run --recursive ~/.config/i3
|
||||
|
||||
# Host-specific config (unique per machine) - supports bulk operations
|
||||
lnk add --host $(hostname) ~/.ssh/config ~/.aws/credentials
|
||||
lnk add --host work ~/.gitconfig ~/.npmrc
|
||||
|
||||
# List configurations
|
||||
lnk list # Common only
|
||||
lnk list --host work # Work host only
|
||||
lnk list --all # Everything
|
||||
|
||||
# Pull configurations
|
||||
lnk pull # Common config
|
||||
lnk pull --host work # Work-specific config
|
||||
```
|
||||
|
||||
## Why not just Git?
|
||||
|
||||
You could `git init ~/.config/lnk` and manually symlink everything. Lnk just automates the tedious parts:
|
||||
|
||||
- Moving files safely
|
||||
- Moving files safely (with atomic operations)
|
||||
- Creating relative symlinks
|
||||
- Handling conflicts
|
||||
- Handling conflicts and rollback
|
||||
- Tracking what's managed
|
||||
- Processing multiple files efficiently
|
||||
- Recursive directory traversal
|
||||
- Preview mode for safety
|
||||
|
||||
## Examples
|
||||
|
||||
### First time setup
|
||||
|
||||
```bash
|
||||
# Clone dotfiles and run bootstrap automatically
|
||||
lnk init -r git@github.com:you/dotfiles.git
|
||||
lnk add ~/.bashrc ~/.vimrc ~/.gitconfig
|
||||
# → Downloads dependencies, installs packages, configures environment
|
||||
|
||||
# Add common config (shared across all machines) - multiple files at once
|
||||
lnk add ~/.bashrc ~/.vimrc ~/.gitconfig ~/.tmux.conf
|
||||
|
||||
# Add configuration directories individually
|
||||
lnk add --recursive ~/.config/nvim ~/.config/zsh
|
||||
|
||||
# Preview before adding sensitive files
|
||||
lnk add --dry-run ~/.ssh/id_rsa.pub
|
||||
lnk add ~/.ssh/id_rsa.pub # Add after verification
|
||||
|
||||
# Add host-specific config (supports bulk operations)
|
||||
lnk add --host $(hostname) ~/.ssh/config ~/.aws/credentials
|
||||
|
||||
lnk push "initial setup"
|
||||
```
|
||||
|
||||
### On a new machine
|
||||
|
||||
```bash
|
||||
# Bootstrap runs automatically
|
||||
lnk init -r git@github.com:you/dotfiles.git
|
||||
lnk pull # auto-creates symlinks
|
||||
# → Sets up environment, installs dependencies
|
||||
|
||||
# Pull common config
|
||||
lnk pull
|
||||
|
||||
# Pull host-specific config (if it exists)
|
||||
lnk pull --host $(hostname)
|
||||
|
||||
# Or run bootstrap manually if needed
|
||||
lnk bootstrap
|
||||
```
|
||||
|
||||
### Daily edits
|
||||
|
||||
```bash
|
||||
vim ~/.vimrc # edit normally
|
||||
lnk status # check what changed
|
||||
lnk push "new plugins" # commit & push
|
||||
vim ~/.vimrc # edit normally
|
||||
lnk list # see common config
|
||||
lnk list --host $(hostname) # see host-specific config
|
||||
lnk list --all # see everything
|
||||
lnk status # check what changed
|
||||
lnk push "new plugins" # commit & push
|
||||
```
|
||||
|
||||
### Multi-machine workflow
|
||||
|
||||
```bash
|
||||
# On your laptop - use bulk operations for efficiency
|
||||
lnk add --host laptop ~/.ssh/config ~/.aws/credentials ~/.npmrc
|
||||
lnk add ~/.vimrc ~/.bashrc ~/.gitconfig # Common config (multiple files)
|
||||
lnk push "laptop configuration"
|
||||
|
||||
# On your work machine
|
||||
lnk pull # Get common config
|
||||
lnk add --host work ~/.gitconfig ~/.ssh/config
|
||||
lnk add --recursive ~/.config/work-tools # Work-specific tools
|
||||
lnk push "work configuration"
|
||||
|
||||
# Back on laptop
|
||||
lnk pull # Get updates (work config won't affect laptop)
|
||||
```
|
||||
|
||||
## Commands
|
||||
|
||||
- `lnk init [-r remote]` - Create repo
|
||||
- `lnk add <files>` - Move files to repo, create symlinks
|
||||
- `lnk rm <files>` - Move files back, remove symlinks
|
||||
- `lnk init [-r remote] [--no-bootstrap] [--force]` - Create repo (runs bootstrap automatically)
|
||||
- `lnk add [--host HOST] [--recursive] [--dry-run] <files>...` - Move files to repo, create symlinks
|
||||
- `lnk rm [--host HOST] <files>` - Move files back, remove symlinks
|
||||
- `lnk list [--host HOST] [--all]` - List files managed by lnk
|
||||
- `lnk status` - Git status + sync info
|
||||
- `lnk push [msg]` - Stage all, commit, push
|
||||
- `lnk pull` - Pull + restore missing symlinks
|
||||
- `lnk pull [--host HOST]` - Pull + restore missing symlinks
|
||||
- `lnk bootstrap` - Run bootstrap script manually
|
||||
|
||||
### Command Options
|
||||
|
||||
- `--host HOST` - Manage files for specific host (default: common configuration)
|
||||
- `--recursive, -r` - Add directory contents individually instead of the directory as a whole
|
||||
- `--dry-run, -n` - Show what would be added without making changes
|
||||
- `--all` - Show all configurations (common + all hosts) when listing
|
||||
- `-r, --remote URL` - Clone from remote URL when initializing
|
||||
- `--no-bootstrap` - Skip automatic execution of bootstrap script after cloning
|
||||
- `--force` - Force initialization even if directory contains managed files (WARNING: overwrites existing content)
|
||||
|
||||
### Output Formatting
|
||||
|
||||
Lnk provides flexible output formatting options to suit different environments and preferences:
|
||||
|
||||
#### Color Output
|
||||
|
||||
Control when ANSI colors are used in output:
|
||||
|
||||
```bash
|
||||
# Default: auto-detect based on TTY
|
||||
lnk init
|
||||
|
||||
# Force colors regardless of environment
|
||||
lnk init --colors=always
|
||||
|
||||
# Disable colors completely
|
||||
lnk init --colors=never
|
||||
|
||||
# Environment variable support
|
||||
NO_COLOR=1 lnk init # Disables colors (acts like --colors=never)
|
||||
```
|
||||
|
||||
**Color modes:**
|
||||
- `auto` (default): Use colors only when stdout is a TTY
|
||||
- `always`: Force color output regardless of TTY
|
||||
- `never`: Disable color output regardless of TTY
|
||||
|
||||
The `NO_COLOR` environment variable acts like `--colors=never` when set, but explicit `--colors` flags take precedence.
|
||||
|
||||
#### Emoji Output
|
||||
|
||||
Control emoji usage in output messages:
|
||||
|
||||
```bash
|
||||
# Default: emojis enabled
|
||||
lnk init
|
||||
|
||||
# Disable emojis
|
||||
lnk init --no-emoji
|
||||
|
||||
# Explicitly enable emojis
|
||||
lnk init --emoji
|
||||
```
|
||||
|
||||
**Emoji flags:**
|
||||
- `--emoji` (default: true): Enable emoji in output
|
||||
- `--no-emoji`: Disable emoji in output
|
||||
|
||||
The `--emoji` and `--no-emoji` flags are mutually exclusive.
|
||||
|
||||
#### Examples
|
||||
|
||||
```bash
|
||||
# Clean output for scripts/pipes
|
||||
lnk init --colors=never --no-emoji
|
||||
|
||||
# Force colorful output in non-TTY environments
|
||||
lnk init --colors=always
|
||||
|
||||
# Disable colors but keep emojis
|
||||
lnk init --colors=never
|
||||
|
||||
# Disable emojis but keep colors
|
||||
lnk init --no-emoji
|
||||
```
|
||||
|
||||
### Add Command Examples
|
||||
|
||||
```bash
|
||||
# Multiple files at once
|
||||
lnk add ~/.bashrc ~/.vimrc ~/.gitconfig
|
||||
|
||||
# Recursive directory processing
|
||||
lnk add --recursive ~/.config/nvim
|
||||
|
||||
# Preview changes first
|
||||
lnk add --dry-run ~/.ssh/config
|
||||
lnk add --dry-run --recursive ~/.config/kitty
|
||||
|
||||
# Host-specific bulk operations
|
||||
lnk add --host work ~/.gitconfig ~/.ssh/config ~/.npmrc
|
||||
```
|
||||
|
||||
## Technical bits
|
||||
|
||||
- **Single binary** (~8MB, no deps)
|
||||
- **Atomic operations** (rollback on failure)
|
||||
- **Relative symlinks** (portable)
|
||||
- **XDG compliant** (`~/.config/lnk`)
|
||||
- **20 integration tests**
|
||||
- **Multihost support** (common + host-specific configs)
|
||||
- **Bootstrap support** (automatic environment setup)
|
||||
- **Bulk operations** (multiple files, atomic transactions)
|
||||
- **Recursive processing** (directory contents individually)
|
||||
- **Preview mode** (dry-run for safety)
|
||||
- **Data loss prevention** (safety checks with contextual warnings)
|
||||
- **Git-native** (standard Git repo, no special formats)
|
||||
|
||||
## Alternatives
|
||||
|
||||
| Tool | Complexity | Why choose it |
|
||||
| ------- | ---------- | ------------------------------------- |
|
||||
| **lnk** | Minimal | Just works, no config, Git-native |
|
||||
| chezmoi | High | Templates, encryption, cross-platform |
|
||||
| yadm | Medium | Git power user, encryption |
|
||||
| dotbot | Low | YAML config, basic features |
|
||||
| stow | Low | Perl, symlink only |
|
||||
|
||||
## FAQ
|
||||
|
||||
**Q: What if I already have dotfiles in Git?**
|
||||
A: `git clone your-repo ~/.config/lnk && lnk add ~/.vimrc` (adopts existing files)
|
||||
|
||||
**Q: How do I handle machine-specific configs?**
|
||||
A: Git branches, or just don't manage machine-specific files with lnk
|
||||
|
||||
**Q: Windows support?**
|
||||
A: Symlinks work on Windows 10+, but untested
|
||||
|
||||
**Q: Production ready?**
|
||||
A: I use it daily. It won't break your files. API might change (pre-1.0).
|
||||
| Tool | Complexity | Why choose it |
|
||||
| ------- | ---------- | ----------------------------------------------------------------------------------------- |
|
||||
| **lnk** | Minimal | Just works, no config, Git-native, multihost, bootstrap, bulk ops, dry-run, safety checks |
|
||||
| chezmoi | High | Templates, encryption, cross-platform |
|
||||
| yadm | Medium | Git power user, encryption |
|
||||
| dotbot | Low | YAML config, basic features |
|
||||
| stow | Low | Perl, symlink only |
|
||||
|
||||
## Contributing
|
||||
|
||||
|
190
RELEASE.md
190
RELEASE.md
@@ -1,190 +0,0 @@
|
||||
# Release Process
|
||||
|
||||
This document describes how to create releases for the lnk project using GoReleaser.
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- Push access to the main repository
|
||||
- Git tags pushed to GitHub trigger releases automatically
|
||||
- GoReleaser is configured in `.goreleaser.yml`
|
||||
- GitHub Actions will handle the release process
|
||||
- Access to the [homebrew-lnk](https://github.com/yarlson/homebrew-lnk) tap repository
|
||||
- **Personal Access Token** set up as `HOMEBREW_TAP_TOKEN` secret (see Setup section)
|
||||
|
||||
## Setup (One-time)
|
||||
|
||||
### GitHub Personal Access Token
|
||||
|
||||
For GoReleaser to update the Homebrew formula, you need a Personal Access Token:
|
||||
|
||||
1. Go to GitHub Settings → Developer settings → Personal access tokens → Tokens (classic)
|
||||
2. Click "Generate new token" → "Generate new token (classic)"
|
||||
3. Name: "GoReleaser Homebrew Access"
|
||||
4. Scopes: Select `repo` (Full control of private repositories)
|
||||
5. Generate and copy the token
|
||||
6. In your `yarlson/lnk` repository:
|
||||
- Go to Settings → Secrets and variables → Actions
|
||||
- Add new repository secret: `HOMEBREW_TAP_TOKEN`
|
||||
- Paste the token as the value
|
||||
|
||||
This allows GoReleaser to automatically update the Homebrew formula in [homebrew-lnk](https://github.com/yarlson/homebrew-lnk).
|
||||
|
||||
## Creating a Release
|
||||
|
||||
### 1. Ensure everything is ready
|
||||
|
||||
```bash
|
||||
# Run all quality checks
|
||||
make check
|
||||
|
||||
# Test GoReleaser configuration
|
||||
make goreleaser-check
|
||||
|
||||
# Test build process
|
||||
make goreleaser-snapshot
|
||||
```
|
||||
|
||||
### 2. Create and push a version tag
|
||||
|
||||
```bash
|
||||
# Create a new tag (replace x.y.z with actual version)
|
||||
git tag -a v1.0.0 -m "Release v1.0.0"
|
||||
|
||||
# Push the tag to trigger the release
|
||||
git push origin v1.0.0
|
||||
```
|
||||
|
||||
### 3. Monitor the release
|
||||
|
||||
- GitHub Actions will automatically build and release when the tag is pushed
|
||||
- Check the [Actions tab](https://github.com/yarlson/lnk/actions) for build status
|
||||
- The release will appear in [GitHub Releases](https://github.com/yarlson/lnk/releases)
|
||||
- The Homebrew formula will be automatically updated in [homebrew-lnk](https://github.com/yarlson/homebrew-lnk)
|
||||
|
||||
## What GoReleaser Does
|
||||
|
||||
1. **Builds binaries** for multiple platforms:
|
||||
|
||||
- Linux (amd64, arm64)
|
||||
- macOS (amd64, arm64)
|
||||
- Windows (amd64)
|
||||
|
||||
2. **Creates archives** with consistent naming:
|
||||
|
||||
- `lnk_Linux_x86_64.tar.gz`
|
||||
- `lnk_Darwin_arm64.tar.gz`
|
||||
- etc.
|
||||
|
||||
3. **Generates checksums** for verification
|
||||
|
||||
4. **Creates GitHub release** with:
|
||||
|
||||
- Automatic changelog from conventional commits
|
||||
- Installation instructions
|
||||
- Download links for all platforms
|
||||
|
||||
5. **Updates Homebrew formula** automatically in the [homebrew-lnk](https://github.com/yarlson/homebrew-lnk) tap
|
||||
|
||||
## Manual Release (if needed)
|
||||
|
||||
If you need to create a release manually:
|
||||
|
||||
```bash
|
||||
# Export GitHub token
|
||||
export GITHUB_TOKEN="your_token_here"
|
||||
|
||||
# Create release (requires a git tag)
|
||||
goreleaser release --clean
|
||||
```
|
||||
|
||||
## Testing Releases Locally
|
||||
|
||||
```bash
|
||||
# Test the build process without releasing
|
||||
make goreleaser-snapshot
|
||||
|
||||
# Built artifacts will be in dist/
|
||||
ls -la dist/
|
||||
|
||||
# Test a binary
|
||||
./dist/lnk_<platform>/lnk --version
|
||||
```
|
||||
|
||||
## Installation Methods
|
||||
|
||||
After a release is published, users can install lnk using multiple methods:
|
||||
|
||||
### 1. Shell Script (Recommended)
|
||||
|
||||
```bash
|
||||
curl -sSL https://raw.githubusercontent.com/yarlson/lnk/main/install.sh | bash
|
||||
```
|
||||
|
||||
### 2. Homebrew (macOS/Linux)
|
||||
|
||||
```bash
|
||||
brew tap yarlson/lnk
|
||||
brew install lnk
|
||||
```
|
||||
|
||||
### 3. Manual Download
|
||||
|
||||
```bash
|
||||
# Download from GitHub releases
|
||||
wget https://github.com/yarlson/lnk/releases/latest/download/lnk_Linux_x86_64.tar.gz
|
||||
tar -xzf lnk_Linux_x86_64.tar.gz
|
||||
sudo mv lnk /usr/local/bin/
|
||||
```
|
||||
|
||||
## Version Numbering
|
||||
|
||||
We use [Semantic Versioning](https://semver.org/):
|
||||
|
||||
- `v1.0.0` - Major release (breaking changes)
|
||||
- `v1.1.0` - Minor release (new features, backward compatible)
|
||||
- `v1.1.1` - Patch release (bug fixes)
|
||||
|
||||
## Changelog
|
||||
|
||||
GoReleaser automatically generates changelogs from git commits using conventional commit format:
|
||||
|
||||
- `feat:` - New features
|
||||
- `fix:` - Bug fixes
|
||||
- `docs:` - Documentation changes (excluded from changelog)
|
||||
- `test:` - Test changes (excluded from changelog)
|
||||
- `ci:` - CI changes (excluded from changelog)
|
||||
|
||||
## Homebrew Tap
|
||||
|
||||
The Homebrew formula is automatically maintained in the [homebrew-lnk](https://github.com/yarlson/homebrew-lnk) repository. When a new release is created:
|
||||
|
||||
1. GoReleaser automatically creates/updates the formula
|
||||
2. The formula is committed to the tap repository
|
||||
3. Users can immediately install the new version via `brew install yarlson/lnk/lnk`
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### Release failed to create
|
||||
|
||||
1. Check that the tag follows the format `vX.Y.Z`
|
||||
2. Ensure GitHub Actions has proper permissions
|
||||
3. Check the Actions log for detailed error messages
|
||||
|
||||
### Missing binaries in release
|
||||
|
||||
1. Verify GoReleaser configuration: `make goreleaser-check`
|
||||
2. Test build locally: `make goreleaser-snapshot`
|
||||
3. Check the build matrix in `.goreleaser.yml`
|
||||
|
||||
### Changelog is empty
|
||||
|
||||
1. Ensure commits follow conventional commit format
|
||||
2. Check that there are commits since the last tag
|
||||
3. Verify changelog configuration in `.goreleaser.yml`
|
||||
|
||||
### Homebrew formula not updated
|
||||
|
||||
1. Check that the GITHUB_TOKEN has access to the homebrew-lnk repository
|
||||
2. Verify the repository name and owner in `.goreleaser.yml`
|
||||
3. Check the release workflow logs for Homebrew-related errors
|
||||
4. Ensure the homebrew-lnk repository exists and is accessible
|
202
cmd/add.go
202
cmd/add.go
@@ -5,31 +5,189 @@ import (
|
||||
"path/filepath"
|
||||
|
||||
"github.com/spf13/cobra"
|
||||
|
||||
"github.com/yarlson/lnk/internal/core"
|
||||
)
|
||||
|
||||
var addCmd = &cobra.Command{
|
||||
Use: "add <file>",
|
||||
Short: "✨ Add a file to lnk management",
|
||||
Long: "Moves a file to the lnk repository and creates a symlink in its place.",
|
||||
Args: cobra.ExactArgs(1),
|
||||
SilenceUsage: true,
|
||||
RunE: func(cmd *cobra.Command, args []string) error {
|
||||
filePath := args[0]
|
||||
func newAddCmd() *cobra.Command {
|
||||
cmd := &cobra.Command{
|
||||
Use: "add <file>...",
|
||||
Short: "✨ Add files to lnk management",
|
||||
Long: `Moves files to the lnk repository and creates symlinks in their place. Supports multiple files.
|
||||
|
||||
lnk := core.NewLnk()
|
||||
if err := lnk.Add(filePath); err != nil {
|
||||
return fmt.Errorf("failed to add file: %w", err)
|
||||
}
|
||||
Examples:
|
||||
lnk add ~/.bashrc ~/.vimrc # Add multiple files at once
|
||||
lnk add --recursive ~/.config/nvim # Add directory contents individually
|
||||
lnk add --dry-run ~/.gitconfig # Preview what would be added
|
||||
lnk add --host work ~/.ssh/config # Add host-specific configuration
|
||||
|
||||
basename := filepath.Base(filePath)
|
||||
fmt.Printf("✨ \033[1mAdded %s to lnk\033[0m\n", basename)
|
||||
fmt.Printf(" 🔗 \033[90m%s\033[0m → \033[36m~/.config/lnk/%s\033[0m\n", filePath, basename)
|
||||
fmt.Printf(" 📝 Use \033[1mlnk push\033[0m to sync to remote\n")
|
||||
return nil
|
||||
},
|
||||
}
|
||||
|
||||
func init() {
|
||||
rootCmd.AddCommand(addCmd)
|
||||
The --recursive flag processes directory contents individually instead of treating
|
||||
the directory as a single unit. This is useful for configuration directories where
|
||||
you want each file managed separately.
|
||||
|
||||
The --dry-run flag shows you exactly what files would be added without making any
|
||||
changes to your system - perfect for verification before bulk operations.`,
|
||||
Args: cobra.MinimumNArgs(1),
|
||||
SilenceUsage: true,
|
||||
SilenceErrors: true,
|
||||
RunE: func(cmd *cobra.Command, args []string) error {
|
||||
host, _ := cmd.Flags().GetString("host")
|
||||
recursive, _ := cmd.Flags().GetBool("recursive")
|
||||
dryRun, _ := cmd.Flags().GetBool("dry-run")
|
||||
lnk := core.NewLnk(core.WithHost(host))
|
||||
w := GetWriter(cmd)
|
||||
|
||||
// Handle dry-run mode
|
||||
if dryRun {
|
||||
files, err := lnk.PreviewAdd(args, recursive)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
// Display preview output
|
||||
if recursive {
|
||||
w.Writeln(Message{Text: fmt.Sprintf("Would add %d files recursively:", len(files)), Emoji: "🔍", Bold: true})
|
||||
} else {
|
||||
w.Writeln(Message{Text: fmt.Sprintf("Would add %d files:", len(files)), Emoji: "🔍", Bold: true})
|
||||
}
|
||||
|
||||
// List files that would be added
|
||||
for _, file := range files {
|
||||
basename := filepath.Base(file)
|
||||
w.WriteString(" ").
|
||||
Writeln(Message{Text: basename, Emoji: "📄"})
|
||||
}
|
||||
|
||||
w.WritelnString("").
|
||||
Writeln(Info("To proceed: run without --dry-run flag"))
|
||||
|
||||
return w.Err()
|
||||
}
|
||||
|
||||
// Handle recursive mode
|
||||
if recursive {
|
||||
// Get preview to count files first for better output
|
||||
previewFiles, err := lnk.PreviewAdd(args, recursive)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
// Create progress callback for CLI display
|
||||
progressCallback := func(current, total int, currentFile string) {
|
||||
w.WriteString(fmt.Sprintf("\r⏳ Processing %d/%d: %s", current, total, currentFile))
|
||||
}
|
||||
|
||||
if err := lnk.AddRecursiveWithProgress(args, progressCallback); err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
// Clear progress line and show completion
|
||||
w.WriteString("\r")
|
||||
|
||||
// Store processed file count for display
|
||||
args = previewFiles // Replace args with actual files for display
|
||||
} else {
|
||||
// Use appropriate method based on number of files
|
||||
if len(args) == 1 {
|
||||
// Single file - use existing Add method for backward compatibility
|
||||
if err := lnk.Add(args[0]); err != nil {
|
||||
return err
|
||||
}
|
||||
} else {
|
||||
// Multiple files - use AddMultiple for atomic operation
|
||||
if err := lnk.AddMultiple(args); err != nil {
|
||||
return err
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// Display results
|
||||
if recursive {
|
||||
// Recursive mode - show enhanced message with count
|
||||
if host != "" {
|
||||
w.Writeln(Sparkles(fmt.Sprintf("Added %d files recursively to lnk (host: %s)", len(args), host)))
|
||||
} else {
|
||||
w.Writeln(Sparkles(fmt.Sprintf("Added %d files recursively to lnk", len(args))))
|
||||
}
|
||||
|
||||
// Show some of the files that were added (limit to first few for readability)
|
||||
filesToShow := len(args)
|
||||
if filesToShow > 5 {
|
||||
filesToShow = 5
|
||||
}
|
||||
|
||||
for i := 0; i < filesToShow; i++ {
|
||||
basename := filepath.Base(args[i])
|
||||
if host != "" {
|
||||
w.WriteString(" ").
|
||||
Write(Link(basename)).
|
||||
WriteString(" → ").
|
||||
Writeln(Colored(fmt.Sprintf("~/.config/lnk/%s.lnk/...", host), ColorCyan))
|
||||
} else {
|
||||
w.WriteString(" ").
|
||||
Write(Link(basename)).
|
||||
WriteString(" → ").
|
||||
Writeln(Colored("~/.config/lnk/...", ColorCyan))
|
||||
}
|
||||
}
|
||||
|
||||
if len(args) > 5 {
|
||||
w.WriteString(" ").
|
||||
Writeln(Colored(fmt.Sprintf("... and %d more files", len(args)-5), ColorGray))
|
||||
}
|
||||
} else if len(args) == 1 {
|
||||
// Single file - maintain existing output format for backward compatibility
|
||||
filePath := args[0]
|
||||
basename := filepath.Base(filePath)
|
||||
if host != "" {
|
||||
w.Writeln(Sparkles(fmt.Sprintf("Added %s to lnk (host: %s)", basename, host)))
|
||||
w.WriteString(" ").
|
||||
Write(Link(filePath)).
|
||||
WriteString(" → ").
|
||||
Writeln(Colored(fmt.Sprintf("~/.config/lnk/%s.lnk/%s", host, filePath), ColorCyan))
|
||||
} else {
|
||||
w.Writeln(Sparkles(fmt.Sprintf("Added %s to lnk", basename)))
|
||||
w.WriteString(" ").
|
||||
Write(Link(filePath)).
|
||||
WriteString(" → ").
|
||||
Writeln(Colored(fmt.Sprintf("~/.config/lnk/%s", filePath), ColorCyan))
|
||||
}
|
||||
} else {
|
||||
// Multiple files - show summary
|
||||
if host != "" {
|
||||
w.Writeln(Sparkles(fmt.Sprintf("Added %d items to lnk (host: %s)", len(args), host)))
|
||||
} else {
|
||||
w.Writeln(Sparkles(fmt.Sprintf("Added %d items to lnk", len(args))))
|
||||
}
|
||||
|
||||
// List each added file
|
||||
for _, filePath := range args {
|
||||
basename := filepath.Base(filePath)
|
||||
if host != "" {
|
||||
w.WriteString(" ").
|
||||
Write(Link(basename)).
|
||||
WriteString(" → ").
|
||||
Writeln(Colored(fmt.Sprintf("~/.config/lnk/%s.lnk/...", host), ColorCyan))
|
||||
} else {
|
||||
w.WriteString(" ").
|
||||
Write(Link(basename)).
|
||||
WriteString(" → ").
|
||||
Writeln(Colored("~/.config/lnk/...", ColorCyan))
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
w.WriteString(" ").
|
||||
Write(Message{Text: "Use ", Emoji: "📝"}).
|
||||
Write(Bold("lnk push")).
|
||||
WritelnString(" to sync to remote")
|
||||
|
||||
return w.Err()
|
||||
},
|
||||
}
|
||||
|
||||
cmd.Flags().StringP("host", "H", "", "Manage file for specific host (default: common configuration)")
|
||||
cmd.Flags().BoolP("recursive", "r", false, "Add directory contents individually instead of the directory as a whole")
|
||||
cmd.Flags().BoolP("dry-run", "n", false, "Show what would be added without making changes")
|
||||
return cmd
|
||||
}
|
||||
|
62
cmd/bootstrap.go
Normal file
62
cmd/bootstrap.go
Normal file
@@ -0,0 +1,62 @@
|
||||
package cmd
|
||||
|
||||
import (
|
||||
"github.com/spf13/cobra"
|
||||
|
||||
"github.com/yarlson/lnk/internal/core"
|
||||
)
|
||||
|
||||
func newBootstrapCmd() *cobra.Command {
|
||||
return &cobra.Command{
|
||||
Use: "bootstrap",
|
||||
Short: "🚀 Run the bootstrap script to set up your environment",
|
||||
Long: "Executes the bootstrap script from your dotfiles repository to install dependencies and configure your system.",
|
||||
SilenceUsage: true,
|
||||
SilenceErrors: true,
|
||||
RunE: func(cmd *cobra.Command, args []string) error {
|
||||
lnk := core.NewLnk()
|
||||
w := GetWriter(cmd)
|
||||
|
||||
scriptPath, err := lnk.FindBootstrapScript()
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
if scriptPath == "" {
|
||||
w.Writeln(Info("No bootstrap script found")).
|
||||
WriteString(" ").
|
||||
Write(Message{Text: "Create a ", Emoji: "📝"}).
|
||||
Write(Bold("bootstrap.sh")).
|
||||
WritelnString(" file in your dotfiles repository:").
|
||||
WriteString(" ").
|
||||
Writeln(Colored("#!/bin/bash", ColorGray)).
|
||||
WriteString(" ").
|
||||
Writeln(Colored("echo \"Setting up environment...\"", ColorGray)).
|
||||
WriteString(" ").
|
||||
Writeln(Colored("# Your setup commands here", ColorGray))
|
||||
return w.Err()
|
||||
}
|
||||
|
||||
w.Writeln(Rocket("Running bootstrap script")).
|
||||
WriteString(" ").
|
||||
Write(Message{Text: "Script: ", Emoji: "📄"}).
|
||||
Writeln(Colored(scriptPath, ColorCyan)).
|
||||
WritelnString("")
|
||||
|
||||
if err := w.Err(); err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
if err := lnk.RunBootstrapScript(scriptPath); err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
w.WritelnString("").
|
||||
Writeln(Success("Bootstrap completed successfully!")).
|
||||
WriteString(" ").
|
||||
Writeln(Message{Text: "Your environment is ready to use", Emoji: "🎉"})
|
||||
|
||||
return w.Err()
|
||||
},
|
||||
}
|
||||
}
|
159
cmd/init.go
159
cmd/init.go
@@ -1,45 +1,136 @@
|
||||
package cmd
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
|
||||
"github.com/spf13/cobra"
|
||||
|
||||
"github.com/yarlson/lnk/internal/core"
|
||||
)
|
||||
|
||||
var initCmd = &cobra.Command{
|
||||
Use: "init",
|
||||
Short: "🎯 Initialize a new lnk repository",
|
||||
Long: "Creates the lnk directory and initializes a Git repository for managing dotfiles.",
|
||||
SilenceUsage: true,
|
||||
RunE: func(cmd *cobra.Command, args []string) error {
|
||||
remote, _ := cmd.Flags().GetString("remote")
|
||||
func newInitCmd() *cobra.Command {
|
||||
cmd := &cobra.Command{
|
||||
Use: "init",
|
||||
Short: "🎯 Initialize a new lnk repository",
|
||||
Long: "Creates the lnk directory and initializes a Git repository for managing dotfiles.",
|
||||
SilenceUsage: true,
|
||||
SilenceErrors: true,
|
||||
RunE: func(cmd *cobra.Command, args []string) error {
|
||||
remote, _ := cmd.Flags().GetString("remote")
|
||||
noBootstrap, _ := cmd.Flags().GetBool("no-bootstrap")
|
||||
force, _ := cmd.Flags().GetBool("force")
|
||||
|
||||
lnk := core.NewLnk()
|
||||
if err := lnk.InitWithRemote(remote); err != nil {
|
||||
return fmt.Errorf("failed to initialize lnk: %w", err)
|
||||
}
|
||||
lnk := core.NewLnk()
|
||||
w := GetWriter(cmd)
|
||||
|
||||
if remote != "" {
|
||||
fmt.Printf("🎯 \033[1mInitialized lnk repository\033[0m\n")
|
||||
fmt.Printf(" 📦 Cloned from: \033[36m%s\033[0m\n", remote)
|
||||
fmt.Printf(" 📁 Location: \033[90m~/.config/lnk\033[0m\n")
|
||||
fmt.Printf("\n💡 \033[33mNext steps:\033[0m\n")
|
||||
fmt.Printf(" • Run \033[1mlnk pull\033[0m to restore symlinks\n")
|
||||
fmt.Printf(" • Use \033[1mlnk add <file>\033[0m to manage new files\n")
|
||||
} else {
|
||||
fmt.Printf("🎯 \033[1mInitialized empty lnk repository\033[0m\n")
|
||||
fmt.Printf(" 📁 Location: \033[90m~/.config/lnk\033[0m\n")
|
||||
fmt.Printf("\n💡 \033[33mNext steps:\033[0m\n")
|
||||
fmt.Printf(" • Run \033[1mlnk add <file>\033[0m to start managing dotfiles\n")
|
||||
fmt.Printf(" • Add a remote with: \033[1mgit remote add origin <url>\033[0m\n")
|
||||
}
|
||||
// Show warning when force is used and there are managed files to overwrite
|
||||
if force && remote != "" && lnk.HasUserContent() {
|
||||
w.Writeln(Warning("Using --force flag: This will overwrite existing managed files")).
|
||||
WriteString(" ").
|
||||
Writeln(Info("Only use this if you understand the risks")).
|
||||
WritelnString("")
|
||||
if err := w.Err(); err != nil {
|
||||
return err
|
||||
}
|
||||
}
|
||||
|
||||
return nil
|
||||
},
|
||||
}
|
||||
|
||||
func init() {
|
||||
initCmd.Flags().StringP("remote", "r", "", "Clone from remote URL instead of creating empty repository")
|
||||
rootCmd.AddCommand(initCmd)
|
||||
if err := lnk.InitWithRemoteForce(remote, force); err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
if remote != "" {
|
||||
w.Writeln(Target("Initialized lnk repository")).
|
||||
WriteString(" ").
|
||||
Write(Message{Text: "Cloned from: ", Emoji: "📦"}).
|
||||
Writeln(Colored(remote, ColorCyan)).
|
||||
WriteString(" ").
|
||||
Write(Message{Text: "Location: ", Emoji: "📁"}).
|
||||
Writeln(Colored("~/.config/lnk", ColorGray))
|
||||
|
||||
if err := w.Err(); err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
// Try to run bootstrap script if not disabled
|
||||
if !noBootstrap {
|
||||
w.WritelnString("").
|
||||
Writeln(Message{Text: "Looking for bootstrap script...", Emoji: "🔍", Bold: true})
|
||||
|
||||
if err := w.Err(); err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
scriptPath, err := lnk.FindBootstrapScript()
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
if scriptPath != "" {
|
||||
w.WriteString(" ").
|
||||
Write(Success("Found bootstrap script: ")).
|
||||
Writeln(Colored(scriptPath, ColorCyan)).
|
||||
WritelnString("").
|
||||
Writeln(Rocket("Running bootstrap script...")).
|
||||
WritelnString("")
|
||||
|
||||
if err := w.Err(); err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
if err := lnk.RunBootstrapScript(scriptPath); err != nil {
|
||||
w.WritelnString("").
|
||||
Writeln(Warning("Bootstrap script failed, but repository was initialized successfully")).
|
||||
WriteString(" ").
|
||||
Write(Info("You can run it manually with: ")).
|
||||
Writeln(Bold("lnk bootstrap")).
|
||||
WriteString(" ").
|
||||
Write(Message{Text: "Error: ", Emoji: "🔧"}).
|
||||
Writeln(Plain(err.Error()))
|
||||
} else {
|
||||
w.WritelnString("").
|
||||
Writeln(Success("Bootstrap completed successfully!"))
|
||||
}
|
||||
|
||||
if err := w.Err(); err != nil {
|
||||
return err
|
||||
}
|
||||
} else {
|
||||
w.WriteString(" ").
|
||||
Writeln(Info("No bootstrap script found"))
|
||||
if err := w.Err(); err != nil {
|
||||
return err
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
w.WritelnString("").
|
||||
Writeln(Info("Next steps:")).
|
||||
WriteString(" • Run ").
|
||||
Write(Bold("lnk pull")).
|
||||
Writeln(Plain(" to restore symlinks")).
|
||||
WriteString(" • Use ").
|
||||
Write(Bold("lnk add <file>")).
|
||||
Writeln(Plain(" to manage new files"))
|
||||
|
||||
return w.Err()
|
||||
} else {
|
||||
w.Writeln(Target("Initialized empty lnk repository")).
|
||||
WriteString(" ").
|
||||
Write(Message{Text: "Location: ", Emoji: "📁"}).
|
||||
Writeln(Colored("~/.config/lnk", ColorGray)).
|
||||
WritelnString("").
|
||||
Writeln(Info("Next steps:")).
|
||||
WriteString(" • Run ").
|
||||
Write(Bold("lnk add <file>")).
|
||||
Writeln(Plain(" to start managing dotfiles")).
|
||||
WriteString(" • Add a remote with: ").
|
||||
Writeln(Bold("git remote add origin <url>"))
|
||||
|
||||
return w.Err()
|
||||
}
|
||||
},
|
||||
}
|
||||
|
||||
cmd.Flags().StringP("remote", "r", "", "Clone from remote URL instead of creating empty repository")
|
||||
cmd.Flags().Bool("no-bootstrap", false, "Skip automatic execution of bootstrap script after cloning")
|
||||
cmd.Flags().Bool("force", false, "Force initialization even if directory contains managed files (WARNING: This will overwrite existing content)")
|
||||
return cmd
|
||||
}
|
||||
|
236
cmd/list.go
Normal file
236
cmd/list.go
Normal file
@@ -0,0 +1,236 @@
|
||||
package cmd
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"os"
|
||||
"path/filepath"
|
||||
"strings"
|
||||
|
||||
"github.com/spf13/cobra"
|
||||
|
||||
"github.com/yarlson/lnk/internal/core"
|
||||
)
|
||||
|
||||
func newListCmd() *cobra.Command {
|
||||
cmd := &cobra.Command{
|
||||
Use: "list",
|
||||
Short: "📋 List files managed by lnk",
|
||||
Long: "Display all files and directories currently managed by lnk.",
|
||||
SilenceUsage: true,
|
||||
SilenceErrors: true,
|
||||
RunE: func(cmd *cobra.Command, args []string) error {
|
||||
host, _ := cmd.Flags().GetString("host")
|
||||
all, _ := cmd.Flags().GetBool("all")
|
||||
|
||||
if host != "" {
|
||||
// Show specific host configuration
|
||||
return listHostConfig(cmd, host)
|
||||
}
|
||||
|
||||
if all {
|
||||
// Show all configurations (common + all hosts)
|
||||
return listAllConfigs(cmd)
|
||||
}
|
||||
|
||||
// Default: show common configuration
|
||||
return listCommonConfig(cmd)
|
||||
},
|
||||
}
|
||||
|
||||
cmd.Flags().StringP("host", "H", "", "List files for specific host")
|
||||
cmd.Flags().BoolP("all", "a", false, "List files for all hosts and common configuration")
|
||||
return cmd
|
||||
}
|
||||
|
||||
func listCommonConfig(cmd *cobra.Command) error {
|
||||
lnk := core.NewLnk()
|
||||
w := GetWriter(cmd)
|
||||
|
||||
managedItems, err := lnk.List()
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
if len(managedItems) == 0 {
|
||||
w.Writeln(Message{Text: "No files currently managed by lnk (common)", Emoji: "📋", Bold: true}).
|
||||
WriteString(" ").
|
||||
Write(Info("Use ")).
|
||||
Write(Bold("lnk add <file>")).
|
||||
WritelnString(" to start managing files")
|
||||
return w.Err()
|
||||
}
|
||||
|
||||
countText := fmt.Sprintf("Files managed by lnk (common) (%d item", len(managedItems))
|
||||
if len(managedItems) > 1 {
|
||||
countText += "s"
|
||||
}
|
||||
countText += "):"
|
||||
|
||||
w.Writeln(Message{Text: countText, Emoji: "📋", Bold: true}).
|
||||
WritelnString("")
|
||||
|
||||
for _, item := range managedItems {
|
||||
w.WriteString(" ").
|
||||
Writeln(Link(item))
|
||||
}
|
||||
|
||||
w.WritelnString("").
|
||||
Write(Info("Use ")).
|
||||
Write(Bold("lnk status")).
|
||||
WritelnString(" to check sync status")
|
||||
return w.Err()
|
||||
}
|
||||
|
||||
func listHostConfig(cmd *cobra.Command, host string) error {
|
||||
lnk := core.NewLnk(core.WithHost(host))
|
||||
w := GetWriter(cmd)
|
||||
|
||||
managedItems, err := lnk.List()
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
if len(managedItems) == 0 {
|
||||
w.Writeln(Message{Text: fmt.Sprintf("No files currently managed by lnk (host: %s)", host), Emoji: "📋", Bold: true}).
|
||||
WriteString(" ").
|
||||
Write(Info("Use ")).
|
||||
Write(Bold(fmt.Sprintf("lnk add --host %s <file>", host))).
|
||||
WritelnString(" to start managing files")
|
||||
return w.Err()
|
||||
}
|
||||
|
||||
countText := fmt.Sprintf("Files managed by lnk (host: %s) (%d item", host, len(managedItems))
|
||||
if len(managedItems) > 1 {
|
||||
countText += "s"
|
||||
}
|
||||
countText += "):"
|
||||
|
||||
w.Writeln(Message{Text: countText, Emoji: "📋", Bold: true}).
|
||||
WritelnString("")
|
||||
|
||||
for _, item := range managedItems {
|
||||
w.WriteString(" ").
|
||||
Writeln(Link(item))
|
||||
}
|
||||
|
||||
w.WritelnString("").
|
||||
Write(Info("Use ")).
|
||||
Write(Bold("lnk status")).
|
||||
WritelnString(" to check sync status")
|
||||
return w.Err()
|
||||
}
|
||||
|
||||
func listAllConfigs(cmd *cobra.Command) error {
|
||||
w := GetWriter(cmd)
|
||||
|
||||
// List common configuration
|
||||
w.Writeln(Message{Text: "All configurations managed by lnk", Emoji: "📋", Bold: true}).
|
||||
WritelnString("")
|
||||
|
||||
lnk := core.NewLnk()
|
||||
commonItems, err := lnk.List()
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
countText := fmt.Sprintf("Common configuration (%d item", len(commonItems))
|
||||
if len(commonItems) > 1 {
|
||||
countText += "s"
|
||||
}
|
||||
countText += "):"
|
||||
|
||||
w.Writeln(Message{Text: countText, Emoji: "🌐", Bold: true})
|
||||
|
||||
if len(commonItems) == 0 {
|
||||
w.WriteString(" ").
|
||||
Writeln(Colored("(no files)", ColorGray))
|
||||
} else {
|
||||
for _, item := range commonItems {
|
||||
w.WriteString(" ").
|
||||
Writeln(Link(item))
|
||||
}
|
||||
}
|
||||
|
||||
// Find all host-specific configurations
|
||||
hosts, err := findHostConfigs()
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
for _, host := range hosts {
|
||||
w.WritelnString("").
|
||||
Write(Message{Text: fmt.Sprintf("Host: %s", host), Emoji: "🖥️", Bold: true})
|
||||
|
||||
hostLnk := core.NewLnk(core.WithHost(host))
|
||||
hostItems, err := hostLnk.List()
|
||||
if err != nil {
|
||||
w.WriteString(" ").
|
||||
Writeln(Colored(fmt.Sprintf("(error: %v)", err), ColorRed))
|
||||
continue
|
||||
}
|
||||
|
||||
countText := fmt.Sprintf(" (%d item", len(hostItems))
|
||||
if len(hostItems) > 1 {
|
||||
countText += "s"
|
||||
}
|
||||
countText += "):"
|
||||
|
||||
w.WriteString(countText).
|
||||
WritelnString("")
|
||||
|
||||
if len(hostItems) == 0 {
|
||||
w.WriteString(" ").
|
||||
Writeln(Colored("(no files)", ColorGray))
|
||||
} else {
|
||||
for _, item := range hostItems {
|
||||
w.WriteString(" ").
|
||||
Writeln(Link(item))
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
w.WritelnString("").
|
||||
Write(Info("Use ")).
|
||||
Write(Bold("lnk list --host <hostname>")).
|
||||
WritelnString(" to see specific host configuration")
|
||||
return w.Err()
|
||||
}
|
||||
|
||||
func findHostConfigs() ([]string, error) {
|
||||
repoPath := getRepoPath()
|
||||
|
||||
// Check if repo exists
|
||||
if _, err := os.Stat(repoPath); os.IsNotExist(err) {
|
||||
return []string{}, nil
|
||||
}
|
||||
|
||||
entries, err := os.ReadDir(repoPath)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
var hosts []string
|
||||
for _, entry := range entries {
|
||||
name := entry.Name()
|
||||
// Look for .lnk.<hostname> files
|
||||
if strings.HasPrefix(name, ".lnk.") && name != ".lnk" {
|
||||
host := strings.TrimPrefix(name, ".lnk.")
|
||||
hosts = append(hosts, host)
|
||||
}
|
||||
}
|
||||
|
||||
return hosts, nil
|
||||
}
|
||||
|
||||
func getRepoPath() string {
|
||||
xdgConfig := os.Getenv("XDG_CONFIG_HOME")
|
||||
if xdgConfig == "" {
|
||||
homeDir, err := os.UserHomeDir()
|
||||
if err != nil {
|
||||
xdgConfig = "."
|
||||
} else {
|
||||
xdgConfig = filepath.Join(homeDir, ".config")
|
||||
}
|
||||
}
|
||||
return filepath.Join(xdgConfig, "lnk")
|
||||
}
|
230
cmd/output.go
Normal file
230
cmd/output.go
Normal file
@@ -0,0 +1,230 @@
|
||||
package cmd
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"io"
|
||||
"os"
|
||||
|
||||
"github.com/spf13/cobra"
|
||||
)
|
||||
|
||||
// OutputConfig controls formatting behavior
|
||||
type OutputConfig struct {
|
||||
Colors bool
|
||||
Emoji bool
|
||||
}
|
||||
|
||||
// Writer provides formatted output with configurable styling
|
||||
type Writer struct {
|
||||
out io.Writer
|
||||
config OutputConfig
|
||||
err error // first error encountered
|
||||
}
|
||||
|
||||
// NewWriter creates a new Writer with the given configuration
|
||||
func NewWriter(out io.Writer, config OutputConfig) *Writer {
|
||||
return &Writer{
|
||||
out: out,
|
||||
config: config,
|
||||
}
|
||||
}
|
||||
|
||||
// Message represents a structured message with optional formatting
|
||||
type Message struct {
|
||||
Text string
|
||||
Color string
|
||||
Emoji string
|
||||
Bold bool
|
||||
}
|
||||
|
||||
// Write outputs a message according to the writer's configuration
|
||||
func (w *Writer) Write(msg Message) *Writer {
|
||||
if w.err != nil {
|
||||
return w
|
||||
}
|
||||
|
||||
var output string
|
||||
|
||||
// Add emoji if enabled
|
||||
if w.config.Emoji && msg.Emoji != "" {
|
||||
output = msg.Emoji + " "
|
||||
}
|
||||
|
||||
// Add color/bold if enabled
|
||||
if w.config.Colors {
|
||||
if msg.Bold {
|
||||
output += "\033[1m"
|
||||
}
|
||||
if msg.Color != "" {
|
||||
output += msg.Color
|
||||
}
|
||||
}
|
||||
|
||||
output += msg.Text
|
||||
|
||||
// Close formatting if enabled
|
||||
if w.config.Colors && (msg.Bold || msg.Color != "") {
|
||||
output += "\033[0m"
|
||||
}
|
||||
|
||||
_, w.err = fmt.Fprint(w.out, output)
|
||||
return w
|
||||
}
|
||||
|
||||
// Printf is like Write but with format string
|
||||
func (w *Writer) Printf(msg Message, args ...any) *Writer {
|
||||
newMsg := msg
|
||||
newMsg.Text = fmt.Sprintf(msg.Text, args...)
|
||||
return w.Write(newMsg)
|
||||
}
|
||||
|
||||
// Writeln writes a message followed by a newline
|
||||
func (w *Writer) Writeln(msg Message) *Writer {
|
||||
return w.Write(msg).WriteString("\n")
|
||||
}
|
||||
|
||||
// WriteString outputs plain text (no formatting)
|
||||
func (w *Writer) WriteString(text string) *Writer {
|
||||
if w.err != nil {
|
||||
return w
|
||||
}
|
||||
_, w.err = fmt.Fprint(w.out, text)
|
||||
return w
|
||||
}
|
||||
|
||||
// WritelnString outputs plain text followed by a newline
|
||||
func (w *Writer) WritelnString(text string) *Writer {
|
||||
if w.err != nil {
|
||||
return w
|
||||
}
|
||||
|
||||
_, w.err = fmt.Fprintln(w.out, text)
|
||||
return w
|
||||
}
|
||||
|
||||
// ANSI color codes
|
||||
const (
|
||||
ColorRed = "\033[31m"
|
||||
ColorYellow = "\033[33m"
|
||||
ColorCyan = "\033[36m"
|
||||
ColorGray = "\033[90m"
|
||||
ColorBrightGreen = "\033[1;32m"
|
||||
ColorBrightYellow = "\033[1;33m"
|
||||
ColorBrightRed = "\033[1;31m"
|
||||
)
|
||||
|
||||
// Predefined message constructors for common patterns
|
||||
|
||||
func Success(text string) Message {
|
||||
return Message{Text: text, Color: ColorBrightGreen, Emoji: "✅", Bold: true}
|
||||
}
|
||||
|
||||
func Error(text string) Message {
|
||||
return Message{Text: text, Emoji: "❌"}
|
||||
}
|
||||
|
||||
func Warning(text string) Message {
|
||||
return Message{Text: text, Color: ColorBrightYellow, Emoji: "⚠️", Bold: true}
|
||||
}
|
||||
|
||||
func Info(text string) Message {
|
||||
return Message{Text: text, Color: ColorYellow, Emoji: "💡"}
|
||||
}
|
||||
|
||||
func Target(text string) Message {
|
||||
return Message{Text: text, Emoji: "🎯", Bold: true}
|
||||
}
|
||||
|
||||
func Rocket(text string) Message {
|
||||
return Message{Text: text, Emoji: "🚀", Bold: true}
|
||||
}
|
||||
|
||||
func Sparkles(text string) Message {
|
||||
return Message{Text: text, Emoji: "✨", Bold: true}
|
||||
}
|
||||
|
||||
func Link(text string) Message {
|
||||
return Message{Text: text, Color: ColorCyan, Emoji: "🔗"}
|
||||
}
|
||||
|
||||
func Plain(text string) Message {
|
||||
return Message{Text: text}
|
||||
}
|
||||
|
||||
func Bold(text string) Message {
|
||||
return Message{Text: text, Bold: true}
|
||||
}
|
||||
|
||||
func Colored(text, color string) Message {
|
||||
return Message{Text: text, Color: color}
|
||||
}
|
||||
|
||||
// Global output configuration
|
||||
var (
|
||||
globalConfig = OutputConfig{
|
||||
Colors: true, // auto-detect on first use
|
||||
Emoji: true,
|
||||
}
|
||||
autoDetected bool
|
||||
)
|
||||
|
||||
// SetGlobalConfig updates the global output configuration
|
||||
func SetGlobalConfig(colors string, emoji bool) error {
|
||||
switch colors {
|
||||
case "auto":
|
||||
globalConfig.Colors = isTerminal()
|
||||
case "always":
|
||||
globalConfig.Colors = true
|
||||
case "never":
|
||||
globalConfig.Colors = false
|
||||
default:
|
||||
return fmt.Errorf("invalid color mode: %s (valid: auto, always, never)", colors)
|
||||
}
|
||||
|
||||
// Check NO_COLOR environment variable (explicit flag takes precedence)
|
||||
if os.Getenv("NO_COLOR") != "" && colors == "auto" {
|
||||
globalConfig.Colors = false
|
||||
}
|
||||
|
||||
globalConfig.Emoji = emoji
|
||||
autoDetected = true
|
||||
return nil
|
||||
}
|
||||
|
||||
// isTerminal checks if stdout is a terminal
|
||||
func isTerminal() bool {
|
||||
fileInfo, err := os.Stdout.Stat()
|
||||
if err != nil {
|
||||
return false
|
||||
}
|
||||
return (fileInfo.Mode() & os.ModeCharDevice) != 0
|
||||
}
|
||||
|
||||
// autoDetectConfig performs one-time auto-detection if not explicitly configured
|
||||
func autoDetectConfig() {
|
||||
if !autoDetected {
|
||||
if os.Getenv("NO_COLOR") != "" {
|
||||
globalConfig.Colors = false
|
||||
} else {
|
||||
globalConfig.Colors = isTerminal()
|
||||
}
|
||||
autoDetected = true
|
||||
}
|
||||
}
|
||||
|
||||
// GetWriter returns a writer for the given cobra command
|
||||
func GetWriter(cmd *cobra.Command) *Writer {
|
||||
autoDetectConfig()
|
||||
return NewWriter(cmd.OutOrStdout(), globalConfig)
|
||||
}
|
||||
|
||||
// GetErrorWriter returns a writer for stderr
|
||||
func GetErrorWriter() *Writer {
|
||||
autoDetectConfig()
|
||||
return NewWriter(os.Stderr, globalConfig)
|
||||
}
|
||||
|
||||
// Err returns the first error encountered during writing
|
||||
func (w *Writer) Err() error {
|
||||
return w.err
|
||||
}
|
271
cmd/output_test.go
Normal file
271
cmd/output_test.go
Normal file
@@ -0,0 +1,271 @@
|
||||
package cmd
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"os"
|
||||
"strings"
|
||||
"testing"
|
||||
|
||||
"github.com/yarlson/lnk/internal/core"
|
||||
)
|
||||
|
||||
func TestOutputConfig(t *testing.T) {
|
||||
tests := []struct {
|
||||
name string
|
||||
colors string
|
||||
emoji bool
|
||||
expectError bool
|
||||
expectedColors bool
|
||||
expectedEmoji bool
|
||||
}{
|
||||
{
|
||||
name: "auto mode",
|
||||
colors: "auto",
|
||||
emoji: true,
|
||||
expectError: false,
|
||||
expectedColors: false, // TTY detection will return false in tests
|
||||
expectedEmoji: true,
|
||||
},
|
||||
{
|
||||
name: "always mode",
|
||||
colors: "always",
|
||||
emoji: false,
|
||||
expectError: false,
|
||||
expectedColors: true,
|
||||
expectedEmoji: false,
|
||||
},
|
||||
{
|
||||
name: "never mode",
|
||||
colors: "never",
|
||||
emoji: true,
|
||||
expectError: false,
|
||||
expectedColors: false,
|
||||
expectedEmoji: true,
|
||||
},
|
||||
{
|
||||
name: "invalid mode",
|
||||
colors: "invalid",
|
||||
emoji: true,
|
||||
expectError: true,
|
||||
},
|
||||
}
|
||||
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
// Clear NO_COLOR for consistent testing
|
||||
_ = os.Unsetenv("NO_COLOR")
|
||||
|
||||
err := SetGlobalConfig(tt.colors, tt.emoji)
|
||||
|
||||
if tt.expectError && err == nil {
|
||||
t.Errorf("expected error but got none")
|
||||
}
|
||||
if !tt.expectError && err != nil {
|
||||
t.Errorf("unexpected error: %v", err)
|
||||
}
|
||||
|
||||
if !tt.expectError {
|
||||
if globalConfig.Colors != tt.expectedColors {
|
||||
t.Errorf("expected colors %v, got %v", tt.expectedColors, globalConfig.Colors)
|
||||
}
|
||||
if globalConfig.Emoji != tt.expectedEmoji {
|
||||
t.Errorf("expected emoji %v, got %v", tt.expectedEmoji, globalConfig.Emoji)
|
||||
}
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestNOCOLOREnvironmentVariable(t *testing.T) {
|
||||
// Test NO_COLOR environment variable with auto mode
|
||||
_ = os.Setenv("NO_COLOR", "1")
|
||||
defer func() { _ = os.Unsetenv("NO_COLOR") }()
|
||||
|
||||
err := SetGlobalConfig("auto", true)
|
||||
if err != nil {
|
||||
t.Errorf("unexpected error: %v", err)
|
||||
}
|
||||
|
||||
if globalConfig.Colors != false {
|
||||
t.Errorf("expected colors disabled when NO_COLOR is set, got %v", globalConfig.Colors)
|
||||
}
|
||||
}
|
||||
|
||||
func TestWriterOutput(t *testing.T) {
|
||||
tests := []struct {
|
||||
name string
|
||||
config OutputConfig
|
||||
message Message
|
||||
expectedOutput string
|
||||
}{
|
||||
{
|
||||
name: "full formatting",
|
||||
config: OutputConfig{Colors: true, Emoji: true},
|
||||
message: Message{
|
||||
Text: "test message",
|
||||
Color: ColorRed,
|
||||
Emoji: "✅",
|
||||
Bold: true,
|
||||
},
|
||||
expectedOutput: "✅ \033[1m\033[31mtest message\033[0m",
|
||||
},
|
||||
{
|
||||
name: "colors only",
|
||||
config: OutputConfig{Colors: true, Emoji: false},
|
||||
message: Message{
|
||||
Text: "test message",
|
||||
Color: ColorRed,
|
||||
Emoji: "✅",
|
||||
Bold: true,
|
||||
},
|
||||
expectedOutput: "\033[1m\033[31mtest message\033[0m",
|
||||
},
|
||||
{
|
||||
name: "emoji only",
|
||||
config: OutputConfig{Colors: false, Emoji: true},
|
||||
message: Message{
|
||||
Text: "test message",
|
||||
Color: ColorRed,
|
||||
Emoji: "✅",
|
||||
Bold: true,
|
||||
},
|
||||
expectedOutput: "✅ test message",
|
||||
},
|
||||
{
|
||||
name: "no formatting",
|
||||
config: OutputConfig{Colors: false, Emoji: false},
|
||||
message: Message{
|
||||
Text: "test message",
|
||||
Color: ColorRed,
|
||||
Emoji: "✅",
|
||||
Bold: true,
|
||||
},
|
||||
expectedOutput: "test message",
|
||||
},
|
||||
{
|
||||
name: "plain message",
|
||||
config: OutputConfig{Colors: true, Emoji: true},
|
||||
message: Plain("plain text"),
|
||||
expectedOutput: "plain text",
|
||||
},
|
||||
}
|
||||
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
var buf bytes.Buffer
|
||||
writer := NewWriter(&buf, tt.config)
|
||||
|
||||
writer.Write(tt.message)
|
||||
if err := writer.Err(); err != nil {
|
||||
t.Errorf("unexpected error: %v", err)
|
||||
}
|
||||
|
||||
if buf.String() != tt.expectedOutput {
|
||||
t.Errorf("expected %q, got %q", tt.expectedOutput, buf.String())
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestPredefinedMessages(t *testing.T) {
|
||||
tests := []struct {
|
||||
name string
|
||||
creator func(string) Message
|
||||
text string
|
||||
}{
|
||||
{"Success", Success, "operation succeeded"},
|
||||
{"Error", Error, "something failed"},
|
||||
{"Warning", Warning, "be careful"},
|
||||
{"Info", Info, "useful information"},
|
||||
{"Target", Target, "target reached"},
|
||||
{"Rocket", Rocket, "launching"},
|
||||
{"Sparkles", Sparkles, "amazing"},
|
||||
{"Link", Link, "connected"},
|
||||
{"Plain", Plain, "no formatting"},
|
||||
{"Bold", Bold, "emphasis"},
|
||||
}
|
||||
|
||||
var buf bytes.Buffer
|
||||
writer := NewWriter(&buf, OutputConfig{Colors: true, Emoji: true})
|
||||
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
buf.Reset()
|
||||
msg := tt.creator(tt.text)
|
||||
|
||||
writer.Write(msg)
|
||||
if err := writer.Err(); err != nil {
|
||||
t.Errorf("unexpected error: %v", err)
|
||||
}
|
||||
|
||||
output := buf.String()
|
||||
if !strings.Contains(output, tt.text) {
|
||||
t.Errorf("output should contain text %q, got %q", tt.text, output)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestStructuredErrors(t *testing.T) {
|
||||
tests := []struct {
|
||||
name string
|
||||
err *core.LnkError
|
||||
config OutputConfig
|
||||
contains []string
|
||||
notContains []string
|
||||
}{
|
||||
{
|
||||
name: "structured error with full formatting",
|
||||
err: &core.LnkError{
|
||||
Message: "Something went wrong",
|
||||
Suggestion: "Try this instead",
|
||||
Path: "/some/path",
|
||||
ErrorType: "test_error",
|
||||
},
|
||||
config: OutputConfig{Colors: true, Emoji: true},
|
||||
contains: []string{"❌", "Something went wrong", "/some/path", "💡", "Try this instead"},
|
||||
},
|
||||
{
|
||||
name: "structured error without emojis",
|
||||
err: &core.LnkError{
|
||||
Message: "Something went wrong",
|
||||
Suggestion: "Try this instead",
|
||||
Path: "/some/path",
|
||||
ErrorType: "test_error",
|
||||
},
|
||||
config: OutputConfig{Colors: true, Emoji: false},
|
||||
contains: []string{"Something went wrong", "/some/path", "Try this instead"},
|
||||
notContains: []string{"❌", "💡"},
|
||||
},
|
||||
}
|
||||
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
var buf bytes.Buffer
|
||||
w := NewWriter(&buf, tt.config)
|
||||
|
||||
// Test the component messages directly
|
||||
_ = w.Write(Error(tt.err.Message))
|
||||
if tt.err.Path != "" {
|
||||
_ = w.WriteString("\n ")
|
||||
_ = w.Write(Colored(tt.err.Path, ColorRed))
|
||||
}
|
||||
if tt.err.Suggestion != "" {
|
||||
_ = w.WriteString("\n ")
|
||||
_ = w.Write(Info(tt.err.Suggestion))
|
||||
}
|
||||
|
||||
output := buf.String()
|
||||
for _, expected := range tt.contains {
|
||||
if !strings.Contains(output, expected) {
|
||||
t.Errorf("output should contain %q, got %q", expected, output)
|
||||
}
|
||||
}
|
||||
for _, notExpected := range tt.notContains {
|
||||
if strings.Contains(output, notExpected) {
|
||||
t.Errorf("output should not contain %q, got %q", notExpected, output)
|
||||
}
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
90
cmd/pull.go
90
cmd/pull.go
@@ -4,42 +4,72 @@ import (
|
||||
"fmt"
|
||||
|
||||
"github.com/spf13/cobra"
|
||||
|
||||
"github.com/yarlson/lnk/internal/core"
|
||||
)
|
||||
|
||||
var pullCmd = &cobra.Command{
|
||||
Use: "pull",
|
||||
Short: "⬇️ Pull changes from remote and restore symlinks",
|
||||
Long: "Fetches changes from remote repository and automatically restores symlinks for all managed files.",
|
||||
SilenceUsage: true,
|
||||
RunE: func(cmd *cobra.Command, args []string) error {
|
||||
lnk := core.NewLnk()
|
||||
restored, err := lnk.Pull()
|
||||
if err != nil {
|
||||
return fmt.Errorf("failed to pull changes: %w", err)
|
||||
}
|
||||
func newPullCmd() *cobra.Command {
|
||||
cmd := &cobra.Command{
|
||||
Use: "pull",
|
||||
Short: "⬇️ Pull changes from remote and restore symlinks",
|
||||
Long: "Fetches changes from remote repository and automatically restores symlinks for all managed files.",
|
||||
SilenceUsage: true,
|
||||
SilenceErrors: true,
|
||||
RunE: func(cmd *cobra.Command, args []string) error {
|
||||
host, _ := cmd.Flags().GetString("host")
|
||||
lnk := core.NewLnk(core.WithHost(host))
|
||||
w := GetWriter(cmd)
|
||||
|
||||
if len(restored) > 0 {
|
||||
fmt.Printf("⬇️ \033[1;32mSuccessfully pulled changes\033[0m\n")
|
||||
fmt.Printf(" 🔗 Restored \033[1m%d symlink", len(restored))
|
||||
if len(restored) > 1 {
|
||||
fmt.Printf("s")
|
||||
restored, err := lnk.Pull()
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
fmt.Printf("\033[0m:\n")
|
||||
for _, file := range restored {
|
||||
fmt.Printf(" ✨ \033[36m%s\033[0m\n", file)
|
||||
|
||||
if len(restored) > 0 {
|
||||
var successMsg string
|
||||
if host != "" {
|
||||
successMsg = fmt.Sprintf("Successfully pulled changes (host: %s)", host)
|
||||
} else {
|
||||
successMsg = "Successfully pulled changes"
|
||||
}
|
||||
|
||||
symlinkText := fmt.Sprintf("Restored %d symlink", len(restored))
|
||||
if len(restored) > 1 {
|
||||
symlinkText += "s"
|
||||
}
|
||||
symlinkText += ":"
|
||||
|
||||
w.Writeln(Message{Text: successMsg, Emoji: "⬇️", Color: ColorBrightGreen, Bold: true}).
|
||||
WriteString(" ").
|
||||
Writeln(Link(symlinkText))
|
||||
|
||||
for _, file := range restored {
|
||||
w.WriteString(" ").
|
||||
Writeln(Sparkles(file))
|
||||
}
|
||||
|
||||
w.WritelnString("").
|
||||
WriteString(" ").
|
||||
Writeln(Message{Text: "Your dotfiles are synced and ready!", Emoji: "🎉"})
|
||||
} else {
|
||||
var successMsg string
|
||||
if host != "" {
|
||||
successMsg = fmt.Sprintf("Successfully pulled changes (host: %s)", host)
|
||||
} else {
|
||||
successMsg = "Successfully pulled changes"
|
||||
}
|
||||
|
||||
w.Writeln(Message{Text: successMsg, Emoji: "⬇️", Color: ColorBrightGreen, Bold: true}).
|
||||
WriteString(" ").
|
||||
Writeln(Success("All symlinks already in place")).
|
||||
WriteString(" ").
|
||||
Writeln(Message{Text: "Everything is up to date!", Emoji: "🎉"})
|
||||
}
|
||||
fmt.Printf("\n 🎉 Your dotfiles are synced and ready!\n")
|
||||
} else {
|
||||
fmt.Printf("⬇️ \033[1;32mSuccessfully pulled changes\033[0m\n")
|
||||
fmt.Printf(" ✅ All symlinks already in place\n")
|
||||
fmt.Printf(" 🎉 Everything is up to date!\n")
|
||||
}
|
||||
|
||||
return nil
|
||||
},
|
||||
}
|
||||
return w.Err()
|
||||
},
|
||||
}
|
||||
|
||||
func init() {
|
||||
rootCmd.AddCommand(pullCmd)
|
||||
cmd.Flags().StringP("host", "H", "", "Pull and restore symlinks for specific host (default: common configuration)")
|
||||
return cmd
|
||||
}
|
||||
|
59
cmd/push.go
59
cmd/push.go
@@ -1,37 +1,42 @@
|
||||
package cmd
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
|
||||
"github.com/spf13/cobra"
|
||||
|
||||
"github.com/yarlson/lnk/internal/core"
|
||||
)
|
||||
|
||||
var pushCmd = &cobra.Command{
|
||||
Use: "push [message]",
|
||||
Short: "🚀 Push local changes to remote repository",
|
||||
Long: "Stages all changes, creates a sync commit with the provided message, and pushes to remote.",
|
||||
Args: cobra.MaximumNArgs(1),
|
||||
SilenceUsage: true,
|
||||
RunE: func(cmd *cobra.Command, args []string) error {
|
||||
message := "lnk: sync configuration files"
|
||||
if len(args) > 0 {
|
||||
message = args[0]
|
||||
}
|
||||
func newPushCmd() *cobra.Command {
|
||||
return &cobra.Command{
|
||||
Use: "push [message]",
|
||||
Short: "🚀 Push local changes to remote repository",
|
||||
Long: "Stages all changes, creates a sync commit with the provided message, and pushes to remote.",
|
||||
Args: cobra.MaximumNArgs(1),
|
||||
SilenceUsage: true,
|
||||
SilenceErrors: true,
|
||||
RunE: func(cmd *cobra.Command, args []string) error {
|
||||
message := "lnk: sync configuration files"
|
||||
if len(args) > 0 {
|
||||
message = args[0]
|
||||
}
|
||||
|
||||
lnk := core.NewLnk()
|
||||
if err := lnk.Push(message); err != nil {
|
||||
return fmt.Errorf("failed to push changes: %w", err)
|
||||
}
|
||||
lnk := core.NewLnk()
|
||||
w := GetWriter(cmd)
|
||||
|
||||
fmt.Printf("🚀 \033[1;32mSuccessfully pushed changes\033[0m\n")
|
||||
fmt.Printf(" 💾 Commit: \033[90m%s\033[0m\n", message)
|
||||
fmt.Printf(" 📡 Synced to remote\n")
|
||||
fmt.Printf(" ✨ Your dotfiles are up to date!\n")
|
||||
return nil
|
||||
},
|
||||
}
|
||||
|
||||
func init() {
|
||||
rootCmd.AddCommand(pushCmd)
|
||||
if err := lnk.Push(message); err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
w.Writeln(Rocket("Successfully pushed changes")).
|
||||
WriteString(" ").
|
||||
Write(Message{Text: "Commit: ", Emoji: "💾"}).
|
||||
Writeln(Colored(message, ColorGray)).
|
||||
WriteString(" ").
|
||||
Writeln(Message{Text: "Synced to remote", Emoji: "📡"}).
|
||||
WriteString(" ").
|
||||
Writeln(Sparkles("Your dotfiles are up to date!"))
|
||||
|
||||
return w.Err()
|
||||
},
|
||||
}
|
||||
}
|
||||
|
63
cmd/rm.go
63
cmd/rm.go
@@ -5,31 +5,50 @@ import (
|
||||
"path/filepath"
|
||||
|
||||
"github.com/spf13/cobra"
|
||||
|
||||
"github.com/yarlson/lnk/internal/core"
|
||||
)
|
||||
|
||||
var rmCmd = &cobra.Command{
|
||||
Use: "rm <file>",
|
||||
Short: "🗑️ Remove a file from lnk management",
|
||||
Long: "Removes a symlink and restores the original file from the lnk repository.",
|
||||
Args: cobra.ExactArgs(1),
|
||||
SilenceUsage: true,
|
||||
RunE: func(cmd *cobra.Command, args []string) error {
|
||||
filePath := args[0]
|
||||
func newRemoveCmd() *cobra.Command {
|
||||
cmd := &cobra.Command{
|
||||
Use: "rm <file>",
|
||||
Short: "🗑️ Remove a file from lnk management",
|
||||
Long: "Removes a symlink and restores the original file from the lnk repository.",
|
||||
Args: cobra.ExactArgs(1),
|
||||
SilenceUsage: true,
|
||||
SilenceErrors: true,
|
||||
RunE: func(cmd *cobra.Command, args []string) error {
|
||||
filePath := args[0]
|
||||
host, _ := cmd.Flags().GetString("host")
|
||||
lnk := core.NewLnk(core.WithHost(host))
|
||||
w := GetWriter(cmd)
|
||||
|
||||
lnk := core.NewLnk()
|
||||
if err := lnk.Remove(filePath); err != nil {
|
||||
return fmt.Errorf("failed to remove file: %w", err)
|
||||
}
|
||||
if err := lnk.Remove(filePath); err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
basename := filepath.Base(filePath)
|
||||
fmt.Printf("🗑️ \033[1mRemoved %s from lnk\033[0m\n", basename)
|
||||
fmt.Printf(" ↩️ \033[90m~/.config/lnk/%s\033[0m → \033[36m%s\033[0m\n", basename, filePath)
|
||||
fmt.Printf(" 📄 Original file restored\n")
|
||||
return nil
|
||||
},
|
||||
}
|
||||
|
||||
func init() {
|
||||
rootCmd.AddCommand(rmCmd)
|
||||
basename := filepath.Base(filePath)
|
||||
if host != "" {
|
||||
w.Writeln(Message{Text: fmt.Sprintf("Removed %s from lnk (host: %s)", basename, host), Emoji: "🗑️", Bold: true}).
|
||||
WriteString(" ").
|
||||
Write(Message{Text: fmt.Sprintf("~/.config/lnk/%s.lnk/%s", host, basename), Emoji: "↩️"}).
|
||||
WriteString(" → ").
|
||||
Writeln(Colored(filePath, ColorCyan))
|
||||
} else {
|
||||
w.Writeln(Message{Text: fmt.Sprintf("Removed %s from lnk", basename), Emoji: "🗑️", Bold: true}).
|
||||
WriteString(" ").
|
||||
Write(Message{Text: fmt.Sprintf("~/.config/lnk/%s", basename), Emoji: "↩️"}).
|
||||
WriteString(" → ").
|
||||
Writeln(Colored(filePath, ColorCyan))
|
||||
}
|
||||
|
||||
w.WriteString(" ").
|
||||
Writeln(Message{Text: "Original file restored", Emoji: "📄"})
|
||||
|
||||
return w.Err()
|
||||
},
|
||||
}
|
||||
|
||||
cmd.Flags().StringP("host", "H", "", "Remove file from specific host configuration (default: common configuration)")
|
||||
return cmd
|
||||
}
|
||||
|
177
cmd/root.go
177
cmd/root.go
@@ -1,10 +1,15 @@
|
||||
package cmd
|
||||
|
||||
import (
|
||||
"errors"
|
||||
"fmt"
|
||||
"os"
|
||||
|
||||
"github.com/spf13/cobra"
|
||||
|
||||
"github.com/yarlson/lnk/internal/core"
|
||||
"github.com/yarlson/lnk/internal/fs"
|
||||
"github.com/yarlson/lnk/internal/git"
|
||||
)
|
||||
|
||||
var (
|
||||
@@ -12,35 +17,179 @@ var (
|
||||
buildTime = "unknown"
|
||||
)
|
||||
|
||||
var rootCmd = &cobra.Command{
|
||||
Use: "lnk",
|
||||
Short: "🔗 Dotfiles, linked. No fluff.",
|
||||
Long: `🔗 Lnk - Git-native dotfiles management that doesn't suck.
|
||||
// NewRootCommand creates a new root command (testable)
|
||||
func NewRootCommand() *cobra.Command {
|
||||
var (
|
||||
colors string
|
||||
emoji bool
|
||||
noEmoji bool
|
||||
)
|
||||
|
||||
rootCmd := &cobra.Command{
|
||||
Use: "lnk",
|
||||
Short: "🔗 Dotfiles, linked. No fluff.",
|
||||
Long: `🔗 Lnk - Git-native dotfiles management that doesn't suck.
|
||||
|
||||
Move your dotfiles to ~/.config/lnk, symlink them back, and use Git like normal.
|
||||
That's it.
|
||||
Supports both common configurations, host-specific setups, and bulk operations for multiple files.
|
||||
|
||||
✨ Examples:
|
||||
lnk init # Fresh start
|
||||
lnk init -r <repo-url> # Clone existing dotfiles
|
||||
lnk add ~/.vimrc ~/.bashrc # Start managing files
|
||||
lnk push "setup complete" # Sync to remote
|
||||
lnk pull # Get latest changes
|
||||
lnk init # Fresh start
|
||||
lnk init -r <repo-url> # Clone existing dotfiles (runs bootstrap automatically)
|
||||
lnk add ~/.vimrc ~/.bashrc # Start managing common files
|
||||
lnk add --recursive ~/.config/nvim # Add directory contents individually
|
||||
lnk add --dry-run ~/.gitconfig # Preview changes without applying
|
||||
lnk add --host work ~/.ssh/config # Manage host-specific files
|
||||
lnk list --all # Show all configurations
|
||||
lnk pull --host work # Pull host-specific changes
|
||||
lnk push "setup complete" # Sync to remote
|
||||
lnk bootstrap # Run bootstrap script manually
|
||||
|
||||
🎯 Simple, fast, and Git-native.`,
|
||||
SilenceUsage: true,
|
||||
🚀 Bootstrap Support:
|
||||
Automatically runs bootstrap.sh when cloning a repository.
|
||||
Use --no-bootstrap to disable.
|
||||
|
||||
🎯 Simple, fast, Git-native, and multi-host ready.`,
|
||||
SilenceUsage: true,
|
||||
SilenceErrors: true,
|
||||
Version: fmt.Sprintf("%s (built %s)", version, buildTime),
|
||||
PersistentPreRunE: func(cmd *cobra.Command, args []string) error {
|
||||
// Handle emoji flag logic
|
||||
emojiEnabled := emoji
|
||||
if noEmoji {
|
||||
emojiEnabled = false
|
||||
}
|
||||
err := SetGlobalConfig(colors, emojiEnabled)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
return nil
|
||||
},
|
||||
}
|
||||
|
||||
// Add global flags for output formatting
|
||||
rootCmd.PersistentFlags().StringVar(&colors, "colors", "auto", "when to use colors (auto, always, never)")
|
||||
rootCmd.PersistentFlags().BoolVar(&emoji, "emoji", true, "enable emoji in output")
|
||||
rootCmd.PersistentFlags().BoolVar(&noEmoji, "no-emoji", false, "disable emoji in output")
|
||||
|
||||
// Mark emoji flags as mutually exclusive
|
||||
rootCmd.MarkFlagsMutuallyExclusive("emoji", "no-emoji")
|
||||
|
||||
// Add subcommands
|
||||
rootCmd.AddCommand(newInitCmd())
|
||||
rootCmd.AddCommand(newAddCmd())
|
||||
rootCmd.AddCommand(newRemoveCmd())
|
||||
rootCmd.AddCommand(newListCmd())
|
||||
rootCmd.AddCommand(newStatusCmd())
|
||||
rootCmd.AddCommand(newPushCmd())
|
||||
rootCmd.AddCommand(newPullCmd())
|
||||
rootCmd.AddCommand(newBootstrapCmd())
|
||||
|
||||
return rootCmd
|
||||
}
|
||||
|
||||
// SetVersion sets the version information for the CLI
|
||||
func SetVersion(v, bt string) {
|
||||
version = v
|
||||
buildTime = bt
|
||||
rootCmd.Version = fmt.Sprintf("%s (built %s)", version, buildTime)
|
||||
}
|
||||
|
||||
func Execute() {
|
||||
rootCmd := NewRootCommand()
|
||||
if err := rootCmd.Execute(); err != nil {
|
||||
fmt.Fprintln(os.Stderr, err)
|
||||
DisplayError(err)
|
||||
os.Exit(1)
|
||||
}
|
||||
}
|
||||
|
||||
// DisplayError formats and displays an error with appropriate styling
|
||||
func DisplayError(err error) {
|
||||
w := GetErrorWriter()
|
||||
|
||||
// Handle structured errors from core package
|
||||
var lnkErr *core.LnkError
|
||||
if errors.As(err, &lnkErr) {
|
||||
w.Write(Error(lnkErr.Message))
|
||||
if lnkErr.Path != "" {
|
||||
w.WritelnString("").
|
||||
WriteString(" ").
|
||||
Write(Colored(lnkErr.Path, ColorRed))
|
||||
}
|
||||
if lnkErr.Suggestion != "" {
|
||||
w.WritelnString("").
|
||||
WriteString(" ").
|
||||
Write(Info(lnkErr.Suggestion))
|
||||
}
|
||||
w.WritelnString("")
|
||||
return
|
||||
}
|
||||
|
||||
// Handle structured errors from fs package
|
||||
var pathErr fs.ErrorWithPath
|
||||
if errors.As(err, &pathErr) {
|
||||
w.Write(Error(err.Error()))
|
||||
if pathErr.GetPath() != "" {
|
||||
w.WritelnString("").
|
||||
WriteString(" ").
|
||||
Write(Colored(pathErr.GetPath(), ColorRed))
|
||||
}
|
||||
var suggErr fs.ErrorWithSuggestion
|
||||
if errors.As(err, &suggErr) {
|
||||
w.WritelnString("").
|
||||
WriteString(" ").
|
||||
Write(Info(suggErr.GetSuggestion()))
|
||||
}
|
||||
w.WritelnString("")
|
||||
return
|
||||
}
|
||||
|
||||
// Handle fs errors that only have suggestions
|
||||
var suggErr fs.ErrorWithSuggestion
|
||||
if errors.As(err, &suggErr) {
|
||||
w.Write(Error(err.Error())).
|
||||
WritelnString("").
|
||||
WriteString(" ").
|
||||
Write(Info(suggErr.GetSuggestion())).
|
||||
WritelnString("")
|
||||
return
|
||||
}
|
||||
|
||||
// Handle git errors with paths
|
||||
var gitPathErr git.ErrorWithPath
|
||||
if errors.As(err, &gitPathErr) {
|
||||
w.Write(Error(err.Error())).
|
||||
WritelnString("").
|
||||
WriteString(" ").
|
||||
Write(Colored(gitPathErr.GetPath(), ColorRed)).
|
||||
WritelnString("")
|
||||
return
|
||||
}
|
||||
|
||||
// Handle git errors with remotes
|
||||
var gitRemoteErr git.ErrorWithRemote
|
||||
if errors.As(err, &gitRemoteErr) {
|
||||
w.Write(Error(err.Error())).
|
||||
WritelnString("").
|
||||
WriteString(" Remote: ").
|
||||
Write(Colored(gitRemoteErr.GetRemote(), ColorCyan)).
|
||||
WritelnString("")
|
||||
return
|
||||
}
|
||||
|
||||
// Handle git errors with reasons
|
||||
var gitReasonErr git.ErrorWithReason
|
||||
if errors.As(err, &gitReasonErr) {
|
||||
w.Write(Error(err.Error()))
|
||||
if gitReasonErr.GetReason() != "" {
|
||||
w.WritelnString("").
|
||||
WriteString(" Reason: ").
|
||||
Write(Colored(gitReasonErr.GetReason(), ColorYellow))
|
||||
}
|
||||
w.WritelnString("")
|
||||
return
|
||||
}
|
||||
|
||||
// Handle generic errors
|
||||
w.Writeln(Error(err.Error()))
|
||||
}
|
||||
|
1810
cmd/root_test.go
Normal file
1810
cmd/root_test.go
Normal file
File diff suppressed because it is too large
Load Diff
163
cmd/status.go
163
cmd/status.go
@@ -4,55 +4,134 @@ import (
|
||||
"fmt"
|
||||
|
||||
"github.com/spf13/cobra"
|
||||
|
||||
"github.com/yarlson/lnk/internal/core"
|
||||
)
|
||||
|
||||
var statusCmd = &cobra.Command{
|
||||
Use: "status",
|
||||
Short: "📊 Show repository sync status",
|
||||
Long: "Display how many commits ahead/behind the local repository is relative to the remote.",
|
||||
SilenceUsage: true,
|
||||
RunE: func(cmd *cobra.Command, args []string) error {
|
||||
lnk := core.NewLnk()
|
||||
status, err := lnk.Status()
|
||||
if err != nil {
|
||||
return fmt.Errorf("failed to get status: %w", err)
|
||||
}
|
||||
func newStatusCmd() *cobra.Command {
|
||||
return &cobra.Command{
|
||||
Use: "status",
|
||||
Short: "📊 Show repository sync status",
|
||||
Long: "Display how many commits ahead/behind the local repository is relative to the remote and check for uncommitted changes.",
|
||||
SilenceUsage: true,
|
||||
SilenceErrors: true,
|
||||
RunE: func(cmd *cobra.Command, args []string) error {
|
||||
lnk := core.NewLnk()
|
||||
status, err := lnk.Status()
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
if status.Ahead == 0 && status.Behind == 0 {
|
||||
fmt.Printf("✅ \033[1;32mRepository is up to date\033[0m\n")
|
||||
fmt.Printf(" 📡 Synced with \033[36m%s\033[0m\n", status.Remote)
|
||||
if status.Dirty {
|
||||
displayDirtyStatus(cmd, status)
|
||||
return nil
|
||||
}
|
||||
|
||||
if status.Ahead == 0 && status.Behind == 0 {
|
||||
displayUpToDateStatus(cmd, status)
|
||||
return nil
|
||||
}
|
||||
|
||||
displaySyncStatus(cmd, status)
|
||||
return nil
|
||||
},
|
||||
}
|
||||
}
|
||||
|
||||
func displayDirtyStatus(cmd *cobra.Command, status *core.StatusInfo) {
|
||||
w := GetWriter(cmd)
|
||||
|
||||
w.Writeln(Warning("Repository has uncommitted changes")).
|
||||
WriteString(" ").
|
||||
Write(Message{Text: "Remote: ", Emoji: "📡"}).
|
||||
Writeln(Colored(status.Remote, ColorCyan))
|
||||
|
||||
if status.Ahead == 0 && status.Behind == 0 {
|
||||
w.WritelnString("").
|
||||
Write(Info("Run ")).
|
||||
Write(Bold("git add && git commit")).
|
||||
WriteString(" in ").
|
||||
Write(Colored("~/.config/lnk", ColorCyan)).
|
||||
WriteString(" or ").
|
||||
Write(Bold("lnk push")).
|
||||
WritelnString(" to commit changes")
|
||||
return
|
||||
}
|
||||
|
||||
w.WritelnString("")
|
||||
displayAheadBehindInfo(cmd, status, true)
|
||||
w.WritelnString("").
|
||||
Write(Info("Run ")).
|
||||
Write(Bold("git add && git commit")).
|
||||
WriteString(" in ").
|
||||
Write(Colored("~/.config/lnk", ColorCyan)).
|
||||
WriteString(" or ").
|
||||
Write(Bold("lnk push")).
|
||||
WritelnString(" to commit changes")
|
||||
}
|
||||
|
||||
func displayUpToDateStatus(cmd *cobra.Command, status *core.StatusInfo) {
|
||||
w := GetWriter(cmd)
|
||||
|
||||
w.Writeln(Success("Repository is up to date")).
|
||||
WriteString(" ").
|
||||
Write(Message{Text: "Synced with ", Emoji: "📡"}).
|
||||
Writeln(Colored(status.Remote, ColorCyan))
|
||||
}
|
||||
|
||||
func displaySyncStatus(cmd *cobra.Command, status *core.StatusInfo) {
|
||||
w := GetWriter(cmd)
|
||||
|
||||
w.Writeln(Message{Text: "Repository Status", Emoji: "📊", Bold: true}).
|
||||
WriteString(" ").
|
||||
Write(Message{Text: "Remote: ", Emoji: "📡"}).
|
||||
Writeln(Colored(status.Remote, ColorCyan)).
|
||||
WritelnString("")
|
||||
|
||||
displayAheadBehindInfo(cmd, status, false)
|
||||
|
||||
if status.Ahead > 0 && status.Behind == 0 {
|
||||
w.WritelnString("").
|
||||
Write(Info("Run ")).
|
||||
Write(Bold("lnk push")).
|
||||
WritelnString(" to sync your changes")
|
||||
} else if status.Behind > 0 {
|
||||
w.WritelnString("").
|
||||
Write(Info("Run ")).
|
||||
Write(Bold("lnk pull")).
|
||||
WritelnString(" to get latest changes")
|
||||
}
|
||||
}
|
||||
|
||||
func displayAheadBehindInfo(cmd *cobra.Command, status *core.StatusInfo, isDirty bool) {
|
||||
w := GetWriter(cmd)
|
||||
|
||||
if status.Ahead > 0 {
|
||||
commitText := getCommitText(status.Ahead)
|
||||
if isDirty {
|
||||
w.WriteString(" ").
|
||||
Write(Message{Text: fmt.Sprintf("%d %s ahead", status.Ahead, commitText), Emoji: "⬆️", Color: ColorBrightYellow, Bold: true}).
|
||||
WritelnString(" (excluding uncommitted changes)")
|
||||
} else {
|
||||
fmt.Printf("📊 \033[1mRepository Status\033[0m\n")
|
||||
fmt.Printf(" 📡 Remote: \033[36m%s\033[0m\n", status.Remote)
|
||||
fmt.Printf("\n")
|
||||
|
||||
if status.Ahead > 0 {
|
||||
commitText := "commit"
|
||||
if status.Ahead > 1 {
|
||||
commitText = "commits"
|
||||
}
|
||||
fmt.Printf(" ⬆️ \033[1;33m%d %s ahead\033[0m - ready to push\n", status.Ahead, commitText)
|
||||
}
|
||||
if status.Behind > 0 {
|
||||
commitText := "commit"
|
||||
if status.Behind > 1 {
|
||||
commitText = "commits"
|
||||
}
|
||||
fmt.Printf(" ⬇️ \033[1;31m%d %s behind\033[0m - run \033[1mlnk pull\033[0m\n", status.Behind, commitText)
|
||||
}
|
||||
|
||||
if status.Ahead > 0 && status.Behind == 0 {
|
||||
fmt.Printf("\n💡 Run \033[1mlnk push\033[0m to sync your changes")
|
||||
} else if status.Behind > 0 {
|
||||
fmt.Printf("\n💡 Run \033[1mlnk pull\033[0m to get latest changes")
|
||||
}
|
||||
w.WriteString(" ").
|
||||
Write(Message{Text: fmt.Sprintf("%d %s ahead", status.Ahead, commitText), Emoji: "⬆️", Color: ColorBrightYellow, Bold: true}).
|
||||
WritelnString(" - ready to push")
|
||||
}
|
||||
}
|
||||
|
||||
return nil
|
||||
},
|
||||
if status.Behind > 0 {
|
||||
commitText := getCommitText(status.Behind)
|
||||
w.WriteString(" ").
|
||||
Write(Message{Text: fmt.Sprintf("%d %s behind", status.Behind, commitText), Emoji: "⬇️", Color: ColorBrightRed, Bold: true}).
|
||||
WriteString(" - run ").
|
||||
Write(Bold("lnk pull")).
|
||||
WritelnString("")
|
||||
}
|
||||
}
|
||||
|
||||
func init() {
|
||||
rootCmd.AddCommand(statusCmd)
|
||||
func getCommitText(count int) string {
|
||||
if count == 1 {
|
||||
return "commit"
|
||||
}
|
||||
return "commits"
|
||||
}
|
||||
|
2
go.mod
2
go.mod
@@ -11,6 +11,6 @@ require (
|
||||
github.com/davecgh/go-spew v1.1.1 // indirect
|
||||
github.com/inconshreveable/mousetrap v1.1.0 // indirect
|
||||
github.com/pmezard/go-difflib v1.0.0 // indirect
|
||||
github.com/spf13/pflag v1.0.6 // indirect
|
||||
github.com/spf13/pflag v1.0.7 // indirect
|
||||
gopkg.in/yaml.v3 v3.0.1 // indirect
|
||||
)
|
||||
|
2
go.sum
2
go.sum
@@ -10,6 +10,8 @@ github.com/spf13/cobra v1.9.1 h1:CXSaggrXdbHK9CF+8ywj8Amf7PBRmPCOJugH954Nnlo=
|
||||
github.com/spf13/cobra v1.9.1/go.mod h1:nDyEzZ8ogv936Cinf6g1RU9MRY64Ir93oCnqb9wxYW0=
|
||||
github.com/spf13/pflag v1.0.6 h1:jFzHGLGAlb3ruxLB8MhbI6A8+AQX/2eW4qeyNZXNp2o=
|
||||
github.com/spf13/pflag v1.0.6/go.mod h1:McXfInJRrz4CZXVZOBLb0bTZqETkiAhM9Iw0y3An2Bg=
|
||||
github.com/spf13/pflag v1.0.7 h1:vN6T9TfwStFPFM5XzjsvmzZkLuaLX+HS+0SeFLRgU6M=
|
||||
github.com/spf13/pflag v1.0.7/go.mod h1:McXfInJRrz4CZXVZOBLb0bTZqETkiAhM9Iw0y3An2Bg=
|
||||
github.com/stretchr/testify v1.10.0 h1:Xv5erBjTwe/5IxqUQTdXv5kgmIvbHo3QQyRwhJsOfJA=
|
||||
github.com/stretchr/testify v1.10.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY=
|
||||
gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM=
|
||||
|
@@ -18,7 +18,7 @@ INSTALL_DIR="/usr/local/bin"
|
||||
BINARY_NAME="lnk"
|
||||
|
||||
# Fallback version if redirect fails
|
||||
FALLBACK_VERSION="v0.0.2"
|
||||
FALLBACK_VERSION="v0.3.0"
|
||||
|
||||
# Detect OS and architecture
|
||||
detect_platform() {
|
||||
|
84
internal/core/errors.go
Normal file
84
internal/core/errors.go
Normal file
@@ -0,0 +1,84 @@
|
||||
package core
|
||||
|
||||
import "fmt"
|
||||
|
||||
// LnkError represents a structured error with separate content and formatting hints
|
||||
type LnkError struct {
|
||||
Message string
|
||||
Suggestion string
|
||||
Path string
|
||||
ErrorType string
|
||||
}
|
||||
|
||||
func (e *LnkError) Error() string {
|
||||
if e.Suggestion != "" {
|
||||
return fmt.Sprintf("%s\n %s", e.Message, e.Suggestion)
|
||||
}
|
||||
return e.Message
|
||||
}
|
||||
|
||||
// Error constructors that separate content from presentation
|
||||
|
||||
func ErrDirectoryContainsManagedFiles(path string) error {
|
||||
return &LnkError{
|
||||
Message: fmt.Sprintf("Directory %s already contains managed files", path),
|
||||
Suggestion: "Use 'lnk pull' to update from remote instead of 'lnk init -r'",
|
||||
Path: path,
|
||||
ErrorType: "managed_files_exist",
|
||||
}
|
||||
}
|
||||
|
||||
func ErrDirectoryContainsGitRepo(path string) error {
|
||||
return &LnkError{
|
||||
Message: fmt.Sprintf("Directory %s contains an existing Git repository", path),
|
||||
Suggestion: "Please backup or move the existing repository before initializing lnk",
|
||||
Path: path,
|
||||
ErrorType: "git_repo_exists",
|
||||
}
|
||||
}
|
||||
|
||||
func ErrFileAlreadyManaged(path string) error {
|
||||
return &LnkError{
|
||||
Message: fmt.Sprintf("File is already managed by lnk: %s", path),
|
||||
Path: path,
|
||||
ErrorType: "already_managed",
|
||||
}
|
||||
}
|
||||
|
||||
func ErrFileNotManaged(path string) error {
|
||||
return &LnkError{
|
||||
Message: fmt.Sprintf("File is not managed by lnk: %s", path),
|
||||
Path: path,
|
||||
ErrorType: "not_managed",
|
||||
}
|
||||
}
|
||||
|
||||
func ErrRepositoryNotInitialized() error {
|
||||
return &LnkError{
|
||||
Message: "Lnk repository not initialized",
|
||||
Suggestion: "Run 'lnk init' first",
|
||||
ErrorType: "not_initialized",
|
||||
}
|
||||
}
|
||||
|
||||
func ErrBootstrapScriptNotFound(script string) error {
|
||||
return &LnkError{
|
||||
Message: fmt.Sprintf("Bootstrap script not found: %s", script),
|
||||
Path: script,
|
||||
ErrorType: "script_not_found",
|
||||
}
|
||||
}
|
||||
|
||||
func ErrBootstrapScriptFailed(err error) error {
|
||||
return &LnkError{
|
||||
Message: fmt.Sprintf("Bootstrap script failed with error: %v", err),
|
||||
ErrorType: "script_failed",
|
||||
}
|
||||
}
|
||||
|
||||
func ErrBootstrapScriptNotExecutable(err error) error {
|
||||
return &LnkError{
|
||||
Message: fmt.Sprintf("Failed to make bootstrap script executable: %v", err),
|
||||
ErrorType: "script_permissions",
|
||||
}
|
||||
}
|
File diff suppressed because it is too large
Load Diff
1602
internal/core/lnk_test.go
Normal file
1602
internal/core/lnk_test.go
Normal file
File diff suppressed because it is too large
Load Diff
130
internal/fs/errors.go
Normal file
130
internal/fs/errors.go
Normal file
@@ -0,0 +1,130 @@
|
||||
package fs
|
||||
|
||||
// Structured errors that separate content from presentation
|
||||
// These will be formatted by the cmd package based on user preferences
|
||||
|
||||
// FileNotExistsError represents an error when a file does not exist
|
||||
type FileNotExistsError struct {
|
||||
Path string
|
||||
Err error
|
||||
}
|
||||
|
||||
func (e *FileNotExistsError) Error() string {
|
||||
return "File or directory not found: " + e.Path
|
||||
}
|
||||
|
||||
func (e *FileNotExistsError) Unwrap() error {
|
||||
return e.Err
|
||||
}
|
||||
|
||||
// GetPath returns the path for formatting purposes
|
||||
func (e *FileNotExistsError) GetPath() string {
|
||||
return e.Path
|
||||
}
|
||||
|
||||
// FileCheckError represents an error when failing to check a file
|
||||
type FileCheckError struct {
|
||||
Err error
|
||||
}
|
||||
|
||||
func (e *FileCheckError) Error() string {
|
||||
return "Unable to access file. Please check file permissions and try again."
|
||||
}
|
||||
|
||||
func (e *FileCheckError) Unwrap() error {
|
||||
return e.Err
|
||||
}
|
||||
|
||||
// UnsupportedFileTypeError represents an error when a file type is not supported
|
||||
type UnsupportedFileTypeError struct {
|
||||
Path string
|
||||
}
|
||||
|
||||
func (e *UnsupportedFileTypeError) Error() string {
|
||||
return "Cannot manage this type of file: " + e.Path
|
||||
}
|
||||
|
||||
func (e *UnsupportedFileTypeError) GetPath() string {
|
||||
return e.Path
|
||||
}
|
||||
|
||||
func (e *UnsupportedFileTypeError) GetSuggestion() string {
|
||||
return "lnk can only manage regular files and directories"
|
||||
}
|
||||
|
||||
func (e *UnsupportedFileTypeError) Unwrap() error {
|
||||
return nil
|
||||
}
|
||||
|
||||
// NotManagedByLnkError represents an error when a file is not managed by lnk
|
||||
type NotManagedByLnkError struct {
|
||||
Path string
|
||||
}
|
||||
|
||||
func (e *NotManagedByLnkError) Error() string {
|
||||
return "File is not managed by lnk: " + e.Path
|
||||
}
|
||||
|
||||
func (e *NotManagedByLnkError) GetPath() string {
|
||||
return e.Path
|
||||
}
|
||||
|
||||
func (e *NotManagedByLnkError) GetSuggestion() string {
|
||||
return "Use 'lnk add' to manage this file first"
|
||||
}
|
||||
|
||||
func (e *NotManagedByLnkError) Unwrap() error {
|
||||
return nil
|
||||
}
|
||||
|
||||
// SymlinkReadError represents an error when failing to read a symlink
|
||||
type SymlinkReadError struct {
|
||||
Err error
|
||||
}
|
||||
|
||||
func (e *SymlinkReadError) Error() string {
|
||||
return "Unable to read symlink. The file may be corrupted or have invalid permissions."
|
||||
}
|
||||
|
||||
func (e *SymlinkReadError) Unwrap() error {
|
||||
return e.Err
|
||||
}
|
||||
|
||||
// DirectoryCreationError represents an error when failing to create a directory
|
||||
type DirectoryCreationError struct {
|
||||
Operation string
|
||||
Err error
|
||||
}
|
||||
|
||||
func (e *DirectoryCreationError) Error() string {
|
||||
return "Failed to create directory. Please check permissions and available disk space."
|
||||
}
|
||||
|
||||
func (e *DirectoryCreationError) Unwrap() error {
|
||||
return e.Err
|
||||
}
|
||||
|
||||
// RelativePathCalculationError represents an error when failing to calculate relative path
|
||||
type RelativePathCalculationError struct {
|
||||
Err error
|
||||
}
|
||||
|
||||
func (e *RelativePathCalculationError) Error() string {
|
||||
return "Unable to create symlink due to path configuration issues. Please check file locations."
|
||||
}
|
||||
|
||||
func (e *RelativePathCalculationError) Unwrap() error {
|
||||
return e.Err
|
||||
}
|
||||
|
||||
// ErrorWithPath is an interface for errors that have an associated file path
|
||||
type ErrorWithPath interface {
|
||||
error
|
||||
GetPath() string
|
||||
}
|
||||
|
||||
// ErrorWithSuggestion is an interface for errors that provide helpful suggestions
|
||||
type ErrorWithSuggestion interface {
|
||||
error
|
||||
GetSuggestion() string
|
||||
}
|
@@ -1,7 +1,6 @@
|
||||
package fs
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"os"
|
||||
"path/filepath"
|
||||
"strings"
|
||||
@@ -17,18 +16,19 @@ func New() *FileSystem {
|
||||
|
||||
// ValidateFileForAdd validates that a file or directory can be added to lnk
|
||||
func (fs *FileSystem) ValidateFileForAdd(filePath string) error {
|
||||
// Check if file exists
|
||||
// Check if file exists and get its info
|
||||
info, err := os.Stat(filePath)
|
||||
if err != nil {
|
||||
if os.IsNotExist(err) {
|
||||
return fmt.Errorf("❌ File does not exist: \033[31m%s\033[0m", filePath)
|
||||
return &FileNotExistsError{Path: filePath, Err: err}
|
||||
}
|
||||
return fmt.Errorf("❌ Failed to check file: %w", err)
|
||||
|
||||
return &FileCheckError{Err: err}
|
||||
}
|
||||
|
||||
// Allow both regular files and directories
|
||||
if !info.Mode().IsRegular() && !info.IsDir() {
|
||||
return fmt.Errorf("❌ Only regular files and directories are supported: \033[31m%s\033[0m", filePath)
|
||||
return &UnsupportedFileTypeError{Path: filePath}
|
||||
}
|
||||
|
||||
return nil
|
||||
@@ -36,98 +36,79 @@ func (fs *FileSystem) ValidateFileForAdd(filePath string) error {
|
||||
|
||||
// ValidateSymlinkForRemove validates that a symlink can be removed from lnk
|
||||
func (fs *FileSystem) ValidateSymlinkForRemove(filePath, repoPath string) error {
|
||||
// Check if file exists
|
||||
// Check if file exists and is a symlink
|
||||
info, err := os.Lstat(filePath) // Use Lstat to not follow symlinks
|
||||
if err != nil {
|
||||
if os.IsNotExist(err) {
|
||||
return fmt.Errorf("❌ File does not exist: \033[31m%s\033[0m", filePath)
|
||||
return &FileNotExistsError{Path: filePath, Err: err}
|
||||
}
|
||||
return fmt.Errorf("❌ Failed to check file: %w", err)
|
||||
|
||||
return &FileCheckError{Err: err}
|
||||
}
|
||||
|
||||
// Check if it's a symlink
|
||||
if info.Mode()&os.ModeSymlink == 0 {
|
||||
return fmt.Errorf("❌ File is not managed by lnk: \033[31m%s\033[0m\n 💡 Use \033[1mlnk add\033[0m to manage this file first", filePath)
|
||||
return &NotManagedByLnkError{Path: filePath}
|
||||
}
|
||||
|
||||
// Check if symlink points to the repository
|
||||
// Get symlink target and resolve to absolute path
|
||||
target, err := os.Readlink(filePath)
|
||||
if err != nil {
|
||||
return fmt.Errorf("failed to read symlink: %w", err)
|
||||
return &SymlinkReadError{Err: err}
|
||||
}
|
||||
|
||||
// Convert relative path to absolute if needed
|
||||
if !filepath.IsAbs(target) {
|
||||
target = filepath.Join(filepath.Dir(filePath), target)
|
||||
}
|
||||
|
||||
// Clean the path to resolve any .. or . components
|
||||
// Clean paths and check if target is inside the repository
|
||||
target = filepath.Clean(target)
|
||||
repoPath = filepath.Clean(repoPath)
|
||||
|
||||
// Check if target is inside the repository
|
||||
if !strings.HasPrefix(target, repoPath+string(filepath.Separator)) && target != repoPath {
|
||||
return fmt.Errorf("❌ File is not managed by lnk: \033[31m%s\033[0m", filePath)
|
||||
return &NotManagedByLnkError{Path: filePath}
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
// Move moves a file or directory from source to destination based on the file info
|
||||
func (fs *FileSystem) Move(src, dst string, info os.FileInfo) error {
|
||||
if info.IsDir() {
|
||||
return fs.MoveDirectory(src, dst)
|
||||
}
|
||||
return fs.MoveFile(src, dst)
|
||||
}
|
||||
|
||||
// MoveFile moves a file from source to destination
|
||||
func (fs *FileSystem) MoveFile(src, dst string) error {
|
||||
// Ensure destination directory exists
|
||||
dstDir := filepath.Dir(dst)
|
||||
if err := os.MkdirAll(dstDir, 0755); err != nil {
|
||||
return fmt.Errorf("failed to create destination directory: %w", err)
|
||||
if err := os.MkdirAll(filepath.Dir(dst), 0755); err != nil {
|
||||
return &DirectoryCreationError{Operation: "destination directory", Err: err}
|
||||
}
|
||||
|
||||
// Move the file
|
||||
if err := os.Rename(src, dst); err != nil {
|
||||
return fmt.Errorf("failed to move file from %s to %s: %w", src, dst, err)
|
||||
}
|
||||
|
||||
return nil
|
||||
return os.Rename(src, dst)
|
||||
}
|
||||
|
||||
// CreateSymlink creates a relative symlink from target to linkPath
|
||||
func (fs *FileSystem) CreateSymlink(target, linkPath string) error {
|
||||
// Calculate relative path from linkPath to target
|
||||
linkDir := filepath.Dir(linkPath)
|
||||
relTarget, err := filepath.Rel(linkDir, target)
|
||||
relTarget, err := filepath.Rel(filepath.Dir(linkPath), target)
|
||||
if err != nil {
|
||||
return fmt.Errorf("failed to calculate relative path: %w", err)
|
||||
return &RelativePathCalculationError{Err: err}
|
||||
}
|
||||
|
||||
// Create the symlink
|
||||
if err := os.Symlink(relTarget, linkPath); err != nil {
|
||||
return fmt.Errorf("failed to create symlink: %w", err)
|
||||
}
|
||||
|
||||
return nil
|
||||
return os.Symlink(relTarget, linkPath)
|
||||
}
|
||||
|
||||
// MoveDirectory moves a directory from source to destination recursively
|
||||
func (fs *FileSystem) MoveDirectory(src, dst string) error {
|
||||
// Check if source is a directory
|
||||
info, err := os.Stat(src)
|
||||
if err != nil {
|
||||
return fmt.Errorf("failed to stat source: %w", err)
|
||||
}
|
||||
|
||||
if !info.IsDir() {
|
||||
return fmt.Errorf("source is not a directory: %s", src)
|
||||
}
|
||||
|
||||
// Ensure destination parent directory exists
|
||||
dstParent := filepath.Dir(dst)
|
||||
if err := os.MkdirAll(dstParent, 0755); err != nil {
|
||||
return fmt.Errorf("failed to create destination parent directory: %w", err)
|
||||
if err := os.MkdirAll(filepath.Dir(dst), 0755); err != nil {
|
||||
return &DirectoryCreationError{Operation: "destination parent directory", Err: err}
|
||||
}
|
||||
|
||||
// Use os.Rename which works for directories
|
||||
if err := os.Rename(src, dst); err != nil {
|
||||
return fmt.Errorf("failed to move directory from %s to %s: %w", src, dst, err)
|
||||
}
|
||||
|
||||
return nil
|
||||
// Move the directory
|
||||
return os.Rename(src, dst)
|
||||
}
|
||||
|
249
internal/git/errors.go
Normal file
249
internal/git/errors.go
Normal file
@@ -0,0 +1,249 @@
|
||||
package git
|
||||
|
||||
// Structured errors that separate content from presentation
|
||||
// These will be formatted by the cmd package based on user preferences
|
||||
|
||||
// GitInitError represents an error during git initialization
|
||||
type GitInitError struct {
|
||||
Output string
|
||||
Err error
|
||||
}
|
||||
|
||||
func (e *GitInitError) Error() string {
|
||||
return "Failed to initialize git repository. Please ensure git is installed and try again."
|
||||
}
|
||||
|
||||
func (e *GitInitError) Unwrap() error {
|
||||
return e.Err
|
||||
}
|
||||
|
||||
// BranchSetupError represents an error setting up the default branch
|
||||
type BranchSetupError struct {
|
||||
Err error
|
||||
}
|
||||
|
||||
func (e *BranchSetupError) Error() string {
|
||||
return "Failed to set up the default branch. Please check your git installation."
|
||||
}
|
||||
|
||||
func (e *BranchSetupError) Unwrap() error {
|
||||
return e.Err
|
||||
}
|
||||
|
||||
// RemoteExistsError represents an error when a remote already exists with different URL
|
||||
type RemoteExistsError struct {
|
||||
Remote string
|
||||
ExistingURL string
|
||||
NewURL string
|
||||
}
|
||||
|
||||
func (e *RemoteExistsError) Error() string {
|
||||
return "Remote " + e.Remote + " is already configured with a different repository (" + e.ExistingURL + "). Cannot add " + e.NewURL + "."
|
||||
}
|
||||
|
||||
func (e *RemoteExistsError) GetRemote() string {
|
||||
return e.Remote
|
||||
}
|
||||
|
||||
func (e *RemoteExistsError) GetExistingURL() string {
|
||||
return e.ExistingURL
|
||||
}
|
||||
|
||||
func (e *RemoteExistsError) GetNewURL() string {
|
||||
return e.NewURL
|
||||
}
|
||||
|
||||
func (e *RemoteExistsError) Unwrap() error {
|
||||
return nil
|
||||
}
|
||||
|
||||
// GitCommandError represents a generic git command execution error
|
||||
type GitCommandError struct {
|
||||
Command string
|
||||
Output string
|
||||
Err error
|
||||
}
|
||||
|
||||
func (e *GitCommandError) Error() string {
|
||||
// Provide user-friendly messages based on common command types
|
||||
switch e.Command {
|
||||
case "add":
|
||||
return "Failed to stage files for commit. Please check file permissions and try again."
|
||||
case "commit":
|
||||
return "Failed to create commit. Please ensure you have staged changes and try again."
|
||||
case "remote add":
|
||||
return "Failed to add remote repository. Please check the repository URL and try again."
|
||||
case "rm":
|
||||
return "Failed to remove file from git tracking. Please check if the file exists and try again."
|
||||
case "log":
|
||||
return "Failed to retrieve commit history."
|
||||
case "remote":
|
||||
return "Failed to retrieve remote repository information."
|
||||
case "clone":
|
||||
return "Failed to clone repository. Please check the repository URL and your network connection."
|
||||
default:
|
||||
return "Git operation failed. Please check your repository state and try again."
|
||||
}
|
||||
}
|
||||
|
||||
func (e *GitCommandError) GetCommand() string {
|
||||
return e.Command
|
||||
}
|
||||
|
||||
func (e *GitCommandError) Unwrap() error {
|
||||
return e.Err
|
||||
}
|
||||
|
||||
// NoRemoteError represents an error when no remote is configured
|
||||
type NoRemoteError struct{}
|
||||
|
||||
func (e *NoRemoteError) Error() string {
|
||||
return "No remote repository is configured. Please add a remote repository first."
|
||||
}
|
||||
|
||||
func (e *NoRemoteError) Unwrap() error {
|
||||
return nil
|
||||
}
|
||||
|
||||
// RemoteNotFoundError represents an error when a specific remote is not found
|
||||
type RemoteNotFoundError struct {
|
||||
Remote string
|
||||
Err error
|
||||
}
|
||||
|
||||
func (e *RemoteNotFoundError) Error() string {
|
||||
return "Remote repository " + e.Remote + " is not configured."
|
||||
}
|
||||
|
||||
func (e *RemoteNotFoundError) GetRemote() string {
|
||||
return e.Remote
|
||||
}
|
||||
|
||||
func (e *RemoteNotFoundError) Unwrap() error {
|
||||
return e.Err
|
||||
}
|
||||
|
||||
// GitConfigError represents an error with git configuration
|
||||
type GitConfigError struct {
|
||||
Setting string
|
||||
Err error
|
||||
}
|
||||
|
||||
func (e *GitConfigError) Error() string {
|
||||
return "Failed to configure git settings. Please check your git installation."
|
||||
}
|
||||
|
||||
func (e *GitConfigError) Unwrap() error {
|
||||
return e.Err
|
||||
}
|
||||
|
||||
// UncommittedChangesError represents an error checking for uncommitted changes
|
||||
type UncommittedChangesError struct {
|
||||
Err error
|
||||
}
|
||||
|
||||
func (e *UncommittedChangesError) Error() string {
|
||||
return "Failed to check repository status. Please verify your git repository is valid."
|
||||
}
|
||||
|
||||
func (e *UncommittedChangesError) Unwrap() error {
|
||||
return e.Err
|
||||
}
|
||||
|
||||
// DirectoryRemovalError represents an error removing a directory
|
||||
type DirectoryRemovalError struct {
|
||||
Path string
|
||||
Err error
|
||||
}
|
||||
|
||||
func (e *DirectoryRemovalError) Error() string {
|
||||
return "Failed to prepare directory for operation. Please check directory permissions."
|
||||
}
|
||||
|
||||
func (e *DirectoryRemovalError) GetPath() string {
|
||||
return e.Path
|
||||
}
|
||||
|
||||
func (e *DirectoryRemovalError) Unwrap() error {
|
||||
return e.Err
|
||||
}
|
||||
|
||||
// DirectoryCreationError represents an error creating a directory
|
||||
type DirectoryCreationError struct {
|
||||
Path string
|
||||
Err error
|
||||
}
|
||||
|
||||
func (e *DirectoryCreationError) Error() string {
|
||||
return "Failed to create directory. Please check permissions and available disk space."
|
||||
}
|
||||
|
||||
func (e *DirectoryCreationError) GetPath() string {
|
||||
return e.Path
|
||||
}
|
||||
|
||||
func (e *DirectoryCreationError) Unwrap() error {
|
||||
return e.Err
|
||||
}
|
||||
|
||||
// PushError represents an error during git push operation
|
||||
type PushError struct {
|
||||
Reason string
|
||||
Output string
|
||||
Err error
|
||||
}
|
||||
|
||||
func (e *PushError) Error() string {
|
||||
if e.Reason != "" {
|
||||
return "Cannot push changes: " + e.Reason
|
||||
}
|
||||
return "Failed to push changes to remote repository. Please check your network connection and repository permissions."
|
||||
}
|
||||
|
||||
func (e *PushError) GetReason() string {
|
||||
return e.Reason
|
||||
}
|
||||
|
||||
func (e *PushError) Unwrap() error {
|
||||
return e.Err
|
||||
}
|
||||
|
||||
// PullError represents an error during git pull operation
|
||||
type PullError struct {
|
||||
Reason string
|
||||
Output string
|
||||
Err error
|
||||
}
|
||||
|
||||
func (e *PullError) Error() string {
|
||||
if e.Reason != "" {
|
||||
return "Cannot pull changes: " + e.Reason
|
||||
}
|
||||
return "Failed to pull changes from remote repository. Please check your network connection and resolve any conflicts."
|
||||
}
|
||||
|
||||
func (e *PullError) GetReason() string {
|
||||
return e.Reason
|
||||
}
|
||||
|
||||
func (e *PullError) Unwrap() error {
|
||||
return e.Err
|
||||
}
|
||||
|
||||
// ErrorWithPath is an interface for git errors that have an associated file path
|
||||
type ErrorWithPath interface {
|
||||
error
|
||||
GetPath() string
|
||||
}
|
||||
|
||||
// ErrorWithRemote is an interface for git errors that involve a remote
|
||||
type ErrorWithRemote interface {
|
||||
error
|
||||
GetRemote() string
|
||||
}
|
||||
|
||||
// ErrorWithReason is an interface for git errors that have a specific reason
|
||||
type ErrorWithReason interface {
|
||||
error
|
||||
GetReason() string
|
||||
}
|
@@ -34,7 +34,7 @@ func (g *Git) Init() error {
|
||||
|
||||
output, err := cmd.CombinedOutput()
|
||||
if err != nil {
|
||||
return fmt.Errorf("git init failed: %w\nOutput: %s", err, string(output))
|
||||
return &GitInitError{Output: string(output), Err: err}
|
||||
}
|
||||
|
||||
// Set the default branch to main
|
||||
@@ -42,7 +42,7 @@ func (g *Git) Init() error {
|
||||
cmd.Dir = g.repoPath
|
||||
|
||||
if err := cmd.Run(); err != nil {
|
||||
return fmt.Errorf("failed to set default branch to main: %w", err)
|
||||
return &BranchSetupError{Err: err}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -60,7 +60,7 @@ func (g *Git) AddRemote(name, url string) error {
|
||||
return nil
|
||||
}
|
||||
// Different URL, error
|
||||
return fmt.Errorf("remote %s already exists with different URL: %s (trying to add: %s)", name, existingURL, url)
|
||||
return &RemoteExistsError{Remote: name, ExistingURL: existingURL, NewURL: url}
|
||||
}
|
||||
|
||||
// Remote doesn't exist, add it
|
||||
@@ -69,7 +69,7 @@ func (g *Git) AddRemote(name, url string) error {
|
||||
|
||||
output, err := cmd.CombinedOutput()
|
||||
if err != nil {
|
||||
return fmt.Errorf("git remote add failed: %w\nOutput: %s", err, string(output))
|
||||
return &GitCommandError{Command: "remote add", Output: string(output), Err: err}
|
||||
}
|
||||
|
||||
return nil
|
||||
@@ -164,7 +164,7 @@ func (g *Git) Add(filename string) error {
|
||||
|
||||
output, err := cmd.CombinedOutput()
|
||||
if err != nil {
|
||||
return fmt.Errorf("git add failed: %w\nOutput: %s", err, string(output))
|
||||
return &GitCommandError{Command: "add", Output: string(output), Err: err}
|
||||
}
|
||||
|
||||
return nil
|
||||
@@ -189,7 +189,7 @@ func (g *Git) Remove(filename string) error {
|
||||
|
||||
output, err := cmd.CombinedOutput()
|
||||
if err != nil {
|
||||
return fmt.Errorf("git rm failed: %w\nOutput: %s", err, string(output))
|
||||
return &GitCommandError{Command: "rm", Output: string(output), Err: err}
|
||||
}
|
||||
|
||||
return nil
|
||||
@@ -207,7 +207,7 @@ func (g *Git) Commit(message string) error {
|
||||
|
||||
output, err := cmd.CombinedOutput()
|
||||
if err != nil {
|
||||
return fmt.Errorf("git commit failed: %w\nOutput: %s", err, string(output))
|
||||
return &GitCommandError{Command: "commit", Output: string(output), Err: err}
|
||||
}
|
||||
|
||||
return nil
|
||||
@@ -223,7 +223,7 @@ func (g *Git) ensureGitConfig() error {
|
||||
cmd = exec.Command("git", "config", "user.name", "Lnk User")
|
||||
cmd.Dir = g.repoPath
|
||||
if err := cmd.Run(); err != nil {
|
||||
return fmt.Errorf("failed to set git user.name: %w", err)
|
||||
return &GitConfigError{Setting: "user.name", Err: err}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -235,7 +235,7 @@ func (g *Git) ensureGitConfig() error {
|
||||
cmd = exec.Command("git", "config", "user.email", "lnk@localhost")
|
||||
cmd.Dir = g.repoPath
|
||||
if err := cmd.Run(); err != nil {
|
||||
return fmt.Errorf("failed to set git user.email: %w", err)
|
||||
return &GitConfigError{Setting: "user.email", Err: err}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -260,7 +260,7 @@ func (g *Git) GetCommits() ([]string, error) {
|
||||
if strings.Contains(outputStr, "does not have any commits yet") {
|
||||
return []string{}, nil
|
||||
}
|
||||
return nil, fmt.Errorf("git log failed: %w", err)
|
||||
return nil, &GitCommandError{Command: "log", Output: outputStr, Err: err}
|
||||
}
|
||||
|
||||
commits := strings.Split(strings.TrimSpace(string(output)), "\n")
|
||||
@@ -282,18 +282,18 @@ func (g *Git) GetRemoteInfo() (string, error) {
|
||||
|
||||
output, err := cmd.Output()
|
||||
if err != nil {
|
||||
return "", fmt.Errorf("failed to list remotes: %w", err)
|
||||
return "", &GitCommandError{Command: "remote", Output: string(output), Err: err}
|
||||
}
|
||||
|
||||
remotes := strings.Split(strings.TrimSpace(string(output)), "\n")
|
||||
if len(remotes) == 0 || remotes[0] == "" {
|
||||
return "", fmt.Errorf("no remote configured")
|
||||
return "", &NoRemoteError{}
|
||||
}
|
||||
|
||||
// Use the first remote
|
||||
url, err = g.getRemoteURL(remotes[0])
|
||||
if err != nil {
|
||||
return "", fmt.Errorf("failed to get remote URL: %w", err)
|
||||
return "", &RemoteNotFoundError{Remote: remotes[0], Err: err}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -305,6 +305,7 @@ type StatusInfo struct {
|
||||
Ahead int
|
||||
Behind int
|
||||
Remote string
|
||||
Dirty bool
|
||||
}
|
||||
|
||||
// GetStatus returns the repository status relative to remote
|
||||
@@ -315,6 +316,12 @@ func (g *Git) GetStatus() (*StatusInfo, error) {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
// Check for uncommitted changes
|
||||
dirty, err := g.HasChanges()
|
||||
if err != nil {
|
||||
return nil, &UncommittedChangesError{Err: err}
|
||||
}
|
||||
|
||||
// Get the remote tracking branch
|
||||
cmd := exec.Command("git", "rev-parse", "--abbrev-ref", "--symbolic-full-name", "@{u}")
|
||||
cmd.Dir = g.repoPath
|
||||
@@ -327,6 +334,7 @@ func (g *Git) GetStatus() (*StatusInfo, error) {
|
||||
Ahead: g.getAheadCount(remoteBranch),
|
||||
Behind: 0, // Can't be behind if no upstream
|
||||
Remote: remoteBranch,
|
||||
Dirty: dirty,
|
||||
}, nil
|
||||
}
|
||||
|
||||
@@ -336,6 +344,7 @@ func (g *Git) GetStatus() (*StatusInfo, error) {
|
||||
Ahead: g.getAheadCount(remoteBranch),
|
||||
Behind: g.getBehindCount(remoteBranch),
|
||||
Remote: remoteBranch,
|
||||
Dirty: dirty,
|
||||
}, nil
|
||||
}
|
||||
|
||||
@@ -401,7 +410,7 @@ func (g *Git) HasChanges() (bool, error) {
|
||||
|
||||
output, err := cmd.Output()
|
||||
if err != nil {
|
||||
return false, fmt.Errorf("git status failed: %w", err)
|
||||
return false, &GitCommandError{Command: "status", Output: string(output), Err: err}
|
||||
}
|
||||
|
||||
return len(strings.TrimSpace(string(output))) > 0, nil
|
||||
@@ -414,7 +423,7 @@ func (g *Git) AddAll() error {
|
||||
|
||||
output, err := cmd.CombinedOutput()
|
||||
if err != nil {
|
||||
return fmt.Errorf("git add failed: %w\nOutput: %s", err, string(output))
|
||||
return &GitCommandError{Command: "add", Output: string(output), Err: err}
|
||||
}
|
||||
|
||||
return nil
|
||||
@@ -425,15 +434,15 @@ func (g *Git) Push() error {
|
||||
// First ensure we have a remote configured
|
||||
_, err := g.GetRemoteInfo()
|
||||
if err != nil {
|
||||
return fmt.Errorf("cannot push: %w", err)
|
||||
return &PushError{Reason: err.Error(), Err: err}
|
||||
}
|
||||
|
||||
cmd := exec.Command("git", "push", "-u", "origin", "main")
|
||||
cmd := exec.Command("git", "push", "-u", "origin")
|
||||
cmd.Dir = g.repoPath
|
||||
|
||||
output, err := cmd.CombinedOutput()
|
||||
if err != nil {
|
||||
return fmt.Errorf("git push failed: %w\nOutput: %s", err, string(output))
|
||||
return &PushError{Output: string(output), Err: err}
|
||||
}
|
||||
|
||||
return nil
|
||||
@@ -444,15 +453,15 @@ func (g *Git) Pull() error {
|
||||
// First ensure we have a remote configured
|
||||
_, err := g.GetRemoteInfo()
|
||||
if err != nil {
|
||||
return fmt.Errorf("cannot pull: %w", err)
|
||||
return &PullError{Reason: err.Error(), Err: err}
|
||||
}
|
||||
|
||||
cmd := exec.Command("git", "pull", "origin", "main")
|
||||
cmd := exec.Command("git", "pull", "origin")
|
||||
cmd.Dir = g.repoPath
|
||||
|
||||
output, err := cmd.CombinedOutput()
|
||||
if err != nil {
|
||||
return fmt.Errorf("git pull failed: %w\nOutput: %s", err, string(output))
|
||||
return &PullError{Output: string(output), Err: err}
|
||||
}
|
||||
|
||||
return nil
|
||||
@@ -462,20 +471,20 @@ func (g *Git) Pull() error {
|
||||
func (g *Git) Clone(url string) error {
|
||||
// Remove the directory if it exists to ensure clean clone
|
||||
if err := os.RemoveAll(g.repoPath); err != nil {
|
||||
return fmt.Errorf("failed to remove existing directory: %w", err)
|
||||
return &DirectoryRemovalError{Path: g.repoPath, Err: err}
|
||||
}
|
||||
|
||||
// Create parent directory
|
||||
parentDir := filepath.Dir(g.repoPath)
|
||||
if err := os.MkdirAll(parentDir, 0755); err != nil {
|
||||
return fmt.Errorf("failed to create parent directory: %w", err)
|
||||
return &DirectoryCreationError{Path: parentDir, Err: err}
|
||||
}
|
||||
|
||||
// Clone the repository
|
||||
cmd := exec.Command("git", "clone", url, g.repoPath)
|
||||
output, err := cmd.CombinedOutput()
|
||||
if err != nil {
|
||||
return fmt.Errorf("git clone failed: %w\nOutput: %s", err, string(output))
|
||||
return &GitCommandError{Command: "clone", Output: string(output), Err: err}
|
||||
}
|
||||
|
||||
// Set up upstream tracking for main branch
|
||||
|
@@ -1,718 +0,0 @@
|
||||
package test
|
||||
|
||||
import (
|
||||
"os"
|
||||
"os/exec"
|
||||
"path/filepath"
|
||||
"strings"
|
||||
"testing"
|
||||
|
||||
"github.com/stretchr/testify/suite"
|
||||
"github.com/yarlson/lnk/internal/core"
|
||||
)
|
||||
|
||||
type LnkIntegrationTestSuite struct {
|
||||
suite.Suite
|
||||
tempDir string
|
||||
originalDir string
|
||||
lnk *core.Lnk
|
||||
}
|
||||
|
||||
func (suite *LnkIntegrationTestSuite) SetupTest() {
|
||||
// Create temporary directory for each test
|
||||
tempDir, err := os.MkdirTemp("", "lnk-test-*")
|
||||
suite.Require().NoError(err)
|
||||
suite.tempDir = tempDir
|
||||
|
||||
// Change to temp directory
|
||||
originalDir, err := os.Getwd()
|
||||
suite.Require().NoError(err)
|
||||
suite.originalDir = originalDir
|
||||
|
||||
err = os.Chdir(tempDir)
|
||||
suite.Require().NoError(err)
|
||||
|
||||
// Set XDG_CONFIG_HOME to temp directory
|
||||
suite.T().Setenv("XDG_CONFIG_HOME", tempDir)
|
||||
|
||||
// Initialize Lnk instance
|
||||
suite.lnk = core.NewLnk()
|
||||
}
|
||||
|
||||
func (suite *LnkIntegrationTestSuite) TearDownTest() {
|
||||
// Return to original directory
|
||||
err := os.Chdir(suite.originalDir)
|
||||
suite.Require().NoError(err)
|
||||
|
||||
// Clean up temp directory
|
||||
err = os.RemoveAll(suite.tempDir)
|
||||
suite.Require().NoError(err)
|
||||
}
|
||||
|
||||
func (suite *LnkIntegrationTestSuite) TestInit() {
|
||||
// Test that init creates the directory and Git repo
|
||||
err := suite.lnk.Init()
|
||||
suite.Require().NoError(err)
|
||||
|
||||
// Check that the lnk directory was created
|
||||
lnkDir := filepath.Join(suite.tempDir, "lnk")
|
||||
suite.DirExists(lnkDir)
|
||||
|
||||
// Check that Git repo was initialized
|
||||
gitDir := filepath.Join(lnkDir, ".git")
|
||||
suite.DirExists(gitDir)
|
||||
|
||||
// Verify it's a non-bare repo
|
||||
configPath := filepath.Join(gitDir, "config")
|
||||
suite.FileExists(configPath)
|
||||
|
||||
// Verify the default branch is set to 'main'
|
||||
cmd := exec.Command("git", "symbolic-ref", "HEAD")
|
||||
cmd.Dir = lnkDir
|
||||
output, err := cmd.Output()
|
||||
suite.Require().NoError(err)
|
||||
suite.Equal("refs/heads/main", strings.TrimSpace(string(output)))
|
||||
}
|
||||
|
||||
func (suite *LnkIntegrationTestSuite) TestAddFile() {
|
||||
// Initialize first
|
||||
err := suite.lnk.Init()
|
||||
suite.Require().NoError(err)
|
||||
|
||||
// Create a test file
|
||||
testFile := filepath.Join(suite.tempDir, ".bashrc")
|
||||
content := "export PATH=$PATH:/usr/local/bin"
|
||||
err = os.WriteFile(testFile, []byte(content), 0644)
|
||||
suite.Require().NoError(err)
|
||||
|
||||
// Add the file
|
||||
err = suite.lnk.Add(testFile)
|
||||
suite.Require().NoError(err)
|
||||
|
||||
// Check that the original file is now a symlink
|
||||
info, err := os.Lstat(testFile)
|
||||
suite.Require().NoError(err)
|
||||
suite.Equal(os.ModeSymlink, info.Mode()&os.ModeSymlink)
|
||||
|
||||
// Check that the file exists in the repo
|
||||
repoFile := filepath.Join(suite.tempDir, "lnk", ".bashrc")
|
||||
suite.FileExists(repoFile)
|
||||
|
||||
// Check that the content is preserved
|
||||
repoContent, err := os.ReadFile(repoFile)
|
||||
suite.Require().NoError(err)
|
||||
suite.Equal(content, string(repoContent))
|
||||
|
||||
// Check that symlink points to the correct location
|
||||
linkTarget, err := os.Readlink(testFile)
|
||||
suite.Require().NoError(err)
|
||||
expectedTarget, err := filepath.Rel(filepath.Dir(testFile), repoFile)
|
||||
suite.Require().NoError(err)
|
||||
suite.Equal(expectedTarget, linkTarget)
|
||||
|
||||
// Check that Git commit was made
|
||||
commits, err := suite.lnk.GetCommits()
|
||||
suite.Require().NoError(err)
|
||||
suite.Len(commits, 1)
|
||||
suite.Contains(commits[0], "lnk: added .bashrc")
|
||||
}
|
||||
|
||||
func (suite *LnkIntegrationTestSuite) TestRemoveFile() {
|
||||
// Initialize and add a file first
|
||||
err := suite.lnk.Init()
|
||||
suite.Require().NoError(err)
|
||||
|
||||
testFile := filepath.Join(suite.tempDir, ".vimrc")
|
||||
content := "set number"
|
||||
err = os.WriteFile(testFile, []byte(content), 0644)
|
||||
suite.Require().NoError(err)
|
||||
|
||||
err = suite.lnk.Add(testFile)
|
||||
suite.Require().NoError(err)
|
||||
|
||||
// Now remove the file
|
||||
err = suite.lnk.Remove(testFile)
|
||||
suite.Require().NoError(err)
|
||||
|
||||
// Check that the symlink is gone and regular file is restored
|
||||
info, err := os.Lstat(testFile)
|
||||
suite.Require().NoError(err)
|
||||
suite.Equal(os.FileMode(0), info.Mode()&os.ModeSymlink) // Not a symlink
|
||||
|
||||
// Check that content is preserved
|
||||
restoredContent, err := os.ReadFile(testFile)
|
||||
suite.Require().NoError(err)
|
||||
suite.Equal(content, string(restoredContent))
|
||||
|
||||
// Check that file is removed from repo
|
||||
repoFile := filepath.Join(suite.tempDir, "lnk", ".vimrc")
|
||||
suite.NoFileExists(repoFile)
|
||||
|
||||
// Check that Git commit was made
|
||||
commits, err := suite.lnk.GetCommits()
|
||||
suite.Require().NoError(err)
|
||||
suite.Len(commits, 2) // add + remove
|
||||
suite.Contains(commits[0], "lnk: removed .vimrc")
|
||||
suite.Contains(commits[1], "lnk: added .vimrc")
|
||||
}
|
||||
|
||||
func (suite *LnkIntegrationTestSuite) TestAddNonexistentFile() {
|
||||
err := suite.lnk.Init()
|
||||
suite.Require().NoError(err)
|
||||
|
||||
err = suite.lnk.Add("/nonexistent/file")
|
||||
suite.Error(err)
|
||||
suite.Contains(err.Error(), "File does not exist")
|
||||
}
|
||||
|
||||
func (suite *LnkIntegrationTestSuite) TestAddDirectory() {
|
||||
err := suite.lnk.Init()
|
||||
suite.Require().NoError(err)
|
||||
|
||||
// Create a directory with files
|
||||
testDir := filepath.Join(suite.tempDir, "testdir")
|
||||
err = os.MkdirAll(testDir, 0755)
|
||||
suite.Require().NoError(err)
|
||||
|
||||
// Add files to the directory
|
||||
testFile1 := filepath.Join(testDir, "file1.txt")
|
||||
err = os.WriteFile(testFile1, []byte("content1"), 0644)
|
||||
suite.Require().NoError(err)
|
||||
|
||||
testFile2 := filepath.Join(testDir, "file2.txt")
|
||||
err = os.WriteFile(testFile2, []byte("content2"), 0644)
|
||||
suite.Require().NoError(err)
|
||||
|
||||
// Add the directory - should now succeed
|
||||
err = suite.lnk.Add(testDir)
|
||||
suite.Require().NoError(err)
|
||||
|
||||
// Check that the directory is now a symlink
|
||||
info, err := os.Lstat(testDir)
|
||||
suite.Require().NoError(err)
|
||||
suite.Equal(os.ModeSymlink, info.Mode()&os.ModeSymlink)
|
||||
|
||||
// Check that the directory exists in the repo
|
||||
repoDir := filepath.Join(suite.tempDir, "lnk", "testdir")
|
||||
suite.DirExists(repoDir)
|
||||
|
||||
// Check that files are preserved
|
||||
repoFile1 := filepath.Join(repoDir, "file1.txt")
|
||||
repoFile2 := filepath.Join(repoDir, "file2.txt")
|
||||
suite.FileExists(repoFile1)
|
||||
suite.FileExists(repoFile2)
|
||||
|
||||
content1, err := os.ReadFile(repoFile1)
|
||||
suite.Require().NoError(err)
|
||||
suite.Equal("content1", string(content1))
|
||||
|
||||
content2, err := os.ReadFile(repoFile2)
|
||||
suite.Require().NoError(err)
|
||||
suite.Equal("content2", string(content2))
|
||||
|
||||
// Check that .lnk file was created and contains the directory
|
||||
lnkFile := filepath.Join(suite.tempDir, "lnk", ".lnk")
|
||||
suite.FileExists(lnkFile)
|
||||
|
||||
lnkContent, err := os.ReadFile(lnkFile)
|
||||
suite.Require().NoError(err)
|
||||
suite.Contains(string(lnkContent), "testdir")
|
||||
|
||||
// Check that Git commit was made
|
||||
commits, err := suite.lnk.GetCommits()
|
||||
suite.Require().NoError(err)
|
||||
suite.Len(commits, 1)
|
||||
suite.Contains(commits[0], "lnk: added testdir")
|
||||
}
|
||||
|
||||
func (suite *LnkIntegrationTestSuite) TestRemoveDirectory() {
|
||||
// Initialize and add a directory first
|
||||
err := suite.lnk.Init()
|
||||
suite.Require().NoError(err)
|
||||
|
||||
testDir := filepath.Join(suite.tempDir, "testdir")
|
||||
err = os.MkdirAll(testDir, 0755)
|
||||
suite.Require().NoError(err)
|
||||
|
||||
testFile := filepath.Join(testDir, "config.txt")
|
||||
content := "test config"
|
||||
err = os.WriteFile(testFile, []byte(content), 0644)
|
||||
suite.Require().NoError(err)
|
||||
|
||||
err = suite.lnk.Add(testDir)
|
||||
suite.Require().NoError(err)
|
||||
|
||||
// Now remove the directory
|
||||
err = suite.lnk.Remove(testDir)
|
||||
suite.Require().NoError(err)
|
||||
|
||||
// Check that the symlink is gone and regular directory is restored
|
||||
info, err := os.Lstat(testDir)
|
||||
suite.Require().NoError(err)
|
||||
suite.Equal(os.FileMode(0), info.Mode()&os.ModeSymlink) // Not a symlink
|
||||
suite.True(info.IsDir()) // Is a directory
|
||||
|
||||
// Check that content is preserved
|
||||
restoredContent, err := os.ReadFile(testFile)
|
||||
suite.Require().NoError(err)
|
||||
suite.Equal(content, string(restoredContent))
|
||||
|
||||
// Check that directory is removed from repo
|
||||
repoDir := filepath.Join(suite.tempDir, "lnk", "testdir")
|
||||
suite.NoDirExists(repoDir)
|
||||
|
||||
// Check that .lnk file no longer contains the directory
|
||||
lnkFile := filepath.Join(suite.tempDir, "lnk", ".lnk")
|
||||
if suite.FileExists(lnkFile) {
|
||||
lnkContent, err := os.ReadFile(lnkFile)
|
||||
suite.Require().NoError(err)
|
||||
suite.NotContains(string(lnkContent), "testdir")
|
||||
}
|
||||
|
||||
// Check that Git commit was made
|
||||
commits, err := suite.lnk.GetCommits()
|
||||
suite.Require().NoError(err)
|
||||
suite.Len(commits, 2) // add + remove
|
||||
suite.Contains(commits[0], "lnk: removed testdir")
|
||||
suite.Contains(commits[1], "lnk: added testdir")
|
||||
}
|
||||
|
||||
func (suite *LnkIntegrationTestSuite) TestLnkFileTracking() {
|
||||
err := suite.lnk.Init()
|
||||
suite.Require().NoError(err)
|
||||
|
||||
// Add a file
|
||||
testFile := filepath.Join(suite.tempDir, ".bashrc")
|
||||
err = os.WriteFile(testFile, []byte("export PATH=/usr/local/bin:$PATH"), 0644)
|
||||
suite.Require().NoError(err)
|
||||
|
||||
err = suite.lnk.Add(testFile)
|
||||
suite.Require().NoError(err)
|
||||
|
||||
// Add a directory
|
||||
testDir := filepath.Join(suite.tempDir, ".ssh")
|
||||
err = os.MkdirAll(testDir, 0700)
|
||||
suite.Require().NoError(err)
|
||||
|
||||
configFile := filepath.Join(testDir, "config")
|
||||
err = os.WriteFile(configFile, []byte("Host example.com"), 0600)
|
||||
suite.Require().NoError(err)
|
||||
|
||||
err = suite.lnk.Add(testDir)
|
||||
suite.Require().NoError(err)
|
||||
|
||||
// Check .lnk file contains both entries
|
||||
lnkFile := filepath.Join(suite.tempDir, "lnk", ".lnk")
|
||||
suite.FileExists(lnkFile)
|
||||
|
||||
lnkContent, err := os.ReadFile(lnkFile)
|
||||
suite.Require().NoError(err)
|
||||
|
||||
lines := strings.Split(strings.TrimSpace(string(lnkContent)), "\n")
|
||||
suite.Len(lines, 2)
|
||||
suite.Contains(lines, ".bashrc")
|
||||
suite.Contains(lines, ".ssh")
|
||||
|
||||
// Remove a file and check .lnk is updated
|
||||
err = suite.lnk.Remove(testFile)
|
||||
suite.Require().NoError(err)
|
||||
|
||||
lnkContent, err = os.ReadFile(lnkFile)
|
||||
suite.Require().NoError(err)
|
||||
|
||||
lines = strings.Split(strings.TrimSpace(string(lnkContent)), "\n")
|
||||
suite.Len(lines, 1)
|
||||
suite.Contains(lines, ".ssh")
|
||||
suite.NotContains(lines, ".bashrc")
|
||||
}
|
||||
|
||||
func (suite *LnkIntegrationTestSuite) TestPullWithDirectories() {
|
||||
// Initialize repo
|
||||
err := suite.lnk.Init()
|
||||
suite.Require().NoError(err)
|
||||
|
||||
// Add remote for pull to work
|
||||
err = suite.lnk.AddRemote("origin", "https://github.com/test/dotfiles.git")
|
||||
suite.Require().NoError(err)
|
||||
|
||||
// Create a directory and .lnk file in the repo directly to simulate a pull
|
||||
repoDir := filepath.Join(suite.tempDir, "lnk", ".config")
|
||||
err = os.MkdirAll(repoDir, 0755)
|
||||
suite.Require().NoError(err)
|
||||
|
||||
configFile := filepath.Join(repoDir, "app.conf")
|
||||
content := "setting=value"
|
||||
err = os.WriteFile(configFile, []byte(content), 0644)
|
||||
suite.Require().NoError(err)
|
||||
|
||||
// Create .lnk file
|
||||
lnkFile := filepath.Join(suite.tempDir, "lnk", ".lnk")
|
||||
err = os.WriteFile(lnkFile, []byte(".config\n"), 0644)
|
||||
suite.Require().NoError(err)
|
||||
|
||||
// Get home directory for the test
|
||||
homeDir, err := os.UserHomeDir()
|
||||
suite.Require().NoError(err)
|
||||
|
||||
targetDir := filepath.Join(homeDir, ".config")
|
||||
|
||||
// Clean up the test directory after the test
|
||||
defer func() {
|
||||
_ = os.RemoveAll(targetDir)
|
||||
}()
|
||||
|
||||
// Create a regular directory in home to simulate conflict scenario
|
||||
err = os.MkdirAll(targetDir, 0755)
|
||||
suite.Require().NoError(err)
|
||||
err = os.WriteFile(filepath.Join(targetDir, "different.conf"), []byte("different"), 0644)
|
||||
suite.Require().NoError(err)
|
||||
|
||||
// Pull should restore symlinks and handle conflicts
|
||||
restored, err := suite.lnk.Pull()
|
||||
// In tests, pull will fail because we don't have real remotes, but that's expected
|
||||
// We can still test the symlink restoration part
|
||||
if err != nil {
|
||||
suite.Contains(err.Error(), "git pull failed")
|
||||
// Test symlink restoration directly
|
||||
restored, err = suite.lnk.RestoreSymlinks()
|
||||
suite.Require().NoError(err)
|
||||
}
|
||||
|
||||
// Should have restored the symlink
|
||||
suite.GreaterOrEqual(len(restored), 1)
|
||||
if len(restored) > 0 {
|
||||
suite.Equal(".config", restored[0])
|
||||
}
|
||||
|
||||
// Check that directory is back to being a symlink
|
||||
info, err := os.Lstat(targetDir)
|
||||
suite.Require().NoError(err)
|
||||
suite.Equal(os.ModeSymlink, info.Mode()&os.ModeSymlink)
|
||||
|
||||
// Check content is preserved from repo
|
||||
repoContent, err := os.ReadFile(configFile)
|
||||
suite.Require().NoError(err)
|
||||
suite.Equal(content, string(repoContent))
|
||||
}
|
||||
|
||||
func (suite *LnkIntegrationTestSuite) TestRemoveNonSymlink() {
|
||||
err := suite.lnk.Init()
|
||||
suite.Require().NoError(err)
|
||||
|
||||
// Create a regular file (not managed by lnk)
|
||||
testFile := filepath.Join(suite.tempDir, ".regularfile")
|
||||
err = os.WriteFile(testFile, []byte("content"), 0644)
|
||||
suite.Require().NoError(err)
|
||||
|
||||
err = suite.lnk.Remove(testFile)
|
||||
suite.Error(err)
|
||||
suite.Contains(err.Error(), "File is not managed by lnk")
|
||||
}
|
||||
|
||||
func (suite *LnkIntegrationTestSuite) TestXDGConfigHomeFallback() {
|
||||
// Test fallback to ~/.config/lnk when XDG_CONFIG_HOME is not set
|
||||
suite.T().Setenv("XDG_CONFIG_HOME", "")
|
||||
|
||||
homeDir := filepath.Join(suite.tempDir, "home")
|
||||
err := os.MkdirAll(homeDir, 0755)
|
||||
suite.Require().NoError(err)
|
||||
suite.T().Setenv("HOME", homeDir)
|
||||
|
||||
lnk := core.NewLnk()
|
||||
err = lnk.Init()
|
||||
suite.Require().NoError(err)
|
||||
|
||||
// Check that the lnk directory was created under ~/.config/lnk
|
||||
expectedDir := filepath.Join(homeDir, ".config", "lnk")
|
||||
suite.DirExists(expectedDir)
|
||||
}
|
||||
|
||||
func (suite *LnkIntegrationTestSuite) TestInitWithRemote() {
|
||||
// Test that init with remote adds the origin remote
|
||||
err := suite.lnk.Init()
|
||||
suite.Require().NoError(err)
|
||||
|
||||
remoteURL := "https://github.com/user/dotfiles.git"
|
||||
err = suite.lnk.AddRemote("origin", remoteURL)
|
||||
suite.Require().NoError(err)
|
||||
|
||||
// Verify the remote was added by checking git config
|
||||
lnkDir := filepath.Join(suite.tempDir, "lnk")
|
||||
cmd := exec.Command("git", "remote", "get-url", "origin")
|
||||
cmd.Dir = lnkDir
|
||||
|
||||
output, err := cmd.Output()
|
||||
suite.Require().NoError(err)
|
||||
suite.Equal(remoteURL, strings.TrimSpace(string(output)))
|
||||
}
|
||||
|
||||
func (suite *LnkIntegrationTestSuite) TestInitIdempotent() {
|
||||
// Test that running init multiple times is safe
|
||||
err := suite.lnk.Init()
|
||||
suite.Require().NoError(err)
|
||||
|
||||
lnkDir := filepath.Join(suite.tempDir, "lnk")
|
||||
|
||||
// Add a file to the repo to ensure it's not lost
|
||||
testFile := filepath.Join(lnkDir, "test.txt")
|
||||
err = os.WriteFile(testFile, []byte("test content"), 0644)
|
||||
suite.Require().NoError(err)
|
||||
|
||||
// Run init again - should be idempotent
|
||||
err = suite.lnk.Init()
|
||||
suite.Require().NoError(err)
|
||||
|
||||
// File should still exist
|
||||
suite.FileExists(testFile)
|
||||
content, err := os.ReadFile(testFile)
|
||||
suite.Require().NoError(err)
|
||||
suite.Equal("test content", string(content))
|
||||
}
|
||||
|
||||
func (suite *LnkIntegrationTestSuite) TestInitWithExistingRemote() {
|
||||
// Test init with remote when remote already exists (same URL)
|
||||
remoteURL := "https://github.com/user/dotfiles.git"
|
||||
|
||||
// First init with remote
|
||||
err := suite.lnk.Init()
|
||||
suite.Require().NoError(err)
|
||||
err = suite.lnk.AddRemote("origin", remoteURL)
|
||||
suite.Require().NoError(err)
|
||||
|
||||
// Init again with same remote should be idempotent
|
||||
err = suite.lnk.Init()
|
||||
suite.Require().NoError(err)
|
||||
err = suite.lnk.AddRemote("origin", remoteURL)
|
||||
suite.Require().NoError(err)
|
||||
|
||||
// Verify remote is still correct
|
||||
lnkDir := filepath.Join(suite.tempDir, "lnk")
|
||||
cmd := exec.Command("git", "remote", "get-url", "origin")
|
||||
cmd.Dir = lnkDir
|
||||
output, err := cmd.Output()
|
||||
suite.Require().NoError(err)
|
||||
suite.Equal(remoteURL, strings.TrimSpace(string(output)))
|
||||
}
|
||||
|
||||
func (suite *LnkIntegrationTestSuite) TestInitWithDifferentRemote() {
|
||||
// Test init with different remote when remote already exists
|
||||
err := suite.lnk.Init()
|
||||
suite.Require().NoError(err)
|
||||
|
||||
// Add first remote
|
||||
err = suite.lnk.AddRemote("origin", "https://github.com/user/dotfiles.git")
|
||||
suite.Require().NoError(err)
|
||||
|
||||
// Try to add different remote - should error
|
||||
err = suite.lnk.AddRemote("origin", "https://github.com/user/other-repo.git")
|
||||
suite.Error(err)
|
||||
suite.Contains(err.Error(), "already exists with different URL")
|
||||
}
|
||||
|
||||
func (suite *LnkIntegrationTestSuite) TestInitWithNonLnkRepo() {
|
||||
// Test init when directory contains a non-lnk Git repository
|
||||
lnkDir := filepath.Join(suite.tempDir, "lnk")
|
||||
err := os.MkdirAll(lnkDir, 0755)
|
||||
suite.Require().NoError(err)
|
||||
|
||||
// Create a non-lnk git repo in the lnk directory
|
||||
cmd := exec.Command("git", "init")
|
||||
cmd.Dir = lnkDir
|
||||
err = cmd.Run()
|
||||
suite.Require().NoError(err)
|
||||
|
||||
// Add some content to make it look like a real repo
|
||||
testFile := filepath.Join(lnkDir, "important-file.txt")
|
||||
err = os.WriteFile(testFile, []byte("important data"), 0644)
|
||||
suite.Require().NoError(err)
|
||||
|
||||
// Configure git and commit
|
||||
cmd = exec.Command("git", "config", "user.name", "Test User")
|
||||
cmd.Dir = lnkDir
|
||||
err = cmd.Run()
|
||||
suite.Require().NoError(err)
|
||||
|
||||
cmd = exec.Command("git", "config", "user.email", "test@example.com")
|
||||
cmd.Dir = lnkDir
|
||||
err = cmd.Run()
|
||||
suite.Require().NoError(err)
|
||||
|
||||
cmd = exec.Command("git", "add", "important-file.txt")
|
||||
cmd.Dir = lnkDir
|
||||
err = cmd.Run()
|
||||
suite.Require().NoError(err)
|
||||
|
||||
cmd = exec.Command("git", "commit", "-m", "important commit")
|
||||
cmd.Dir = lnkDir
|
||||
err = cmd.Run()
|
||||
suite.Require().NoError(err)
|
||||
|
||||
// Now try to init lnk - should error to protect existing repo
|
||||
err = suite.lnk.Init()
|
||||
suite.Error(err)
|
||||
suite.Contains(err.Error(), "contains an existing Git repository")
|
||||
|
||||
// Verify the original file is still there
|
||||
suite.FileExists(testFile)
|
||||
}
|
||||
|
||||
// TestSyncStatus tests the status command functionality
|
||||
func (suite *LnkIntegrationTestSuite) TestSyncStatus() {
|
||||
// Initialize repo with remote
|
||||
err := suite.lnk.Init()
|
||||
suite.Require().NoError(err)
|
||||
|
||||
err = suite.lnk.AddRemote("origin", "https://github.com/test/dotfiles.git")
|
||||
suite.Require().NoError(err)
|
||||
|
||||
// Add a file to create some local changes
|
||||
testFile := filepath.Join(suite.tempDir, ".bashrc")
|
||||
content := "export PATH=$PATH:/usr/local/bin"
|
||||
err = os.WriteFile(testFile, []byte(content), 0644)
|
||||
suite.Require().NoError(err)
|
||||
|
||||
err = suite.lnk.Add(testFile)
|
||||
suite.Require().NoError(err)
|
||||
|
||||
// Get status - should show 1 commit ahead
|
||||
status, err := suite.lnk.Status()
|
||||
suite.Require().NoError(err)
|
||||
suite.Equal(1, status.Ahead)
|
||||
suite.Equal(0, status.Behind)
|
||||
suite.Equal("origin/main", status.Remote)
|
||||
}
|
||||
|
||||
// TestSyncPush tests the push command functionality
|
||||
func (suite *LnkIntegrationTestSuite) TestSyncPush() {
|
||||
// Initialize repo
|
||||
err := suite.lnk.Init()
|
||||
suite.Require().NoError(err)
|
||||
|
||||
// Add remote for push to work
|
||||
err = suite.lnk.AddRemote("origin", "https://github.com/test/dotfiles.git")
|
||||
suite.Require().NoError(err)
|
||||
|
||||
// Add a file
|
||||
testFile := filepath.Join(suite.tempDir, ".vimrc")
|
||||
content := "set number"
|
||||
err = os.WriteFile(testFile, []byte(content), 0644)
|
||||
suite.Require().NoError(err)
|
||||
|
||||
err = suite.lnk.Add(testFile)
|
||||
suite.Require().NoError(err)
|
||||
|
||||
// Add another file for a second commit
|
||||
testFile2 := filepath.Join(suite.tempDir, ".gitconfig")
|
||||
content2 := "[user]\n name = Test User"
|
||||
err = os.WriteFile(testFile2, []byte(content2), 0644)
|
||||
suite.Require().NoError(err)
|
||||
|
||||
err = suite.lnk.Add(testFile2)
|
||||
suite.Require().NoError(err)
|
||||
|
||||
// Modify one of the files to create uncommitted changes
|
||||
repoFile := filepath.Join(suite.tempDir, "lnk", ".vimrc")
|
||||
modifiedContent := "set number\nset relativenumber"
|
||||
err = os.WriteFile(repoFile, []byte(modifiedContent), 0644)
|
||||
suite.Require().NoError(err)
|
||||
|
||||
// Push should stage all changes and create a sync commit
|
||||
message := "Updated configuration files"
|
||||
err = suite.lnk.Push(message)
|
||||
// In tests, push will fail because we don't have real remotes, but that's expected
|
||||
// The important part is that it stages and commits changes
|
||||
if err != nil {
|
||||
suite.Contains(err.Error(), "git push failed")
|
||||
}
|
||||
|
||||
// Check that a sync commit was made (even if push failed)
|
||||
commits, err := suite.lnk.GetCommits()
|
||||
suite.Require().NoError(err)
|
||||
suite.GreaterOrEqual(len(commits), 3) // at least 2 add commits + 1 sync commit
|
||||
suite.Contains(commits[0], message) // Latest commit should contain our message
|
||||
}
|
||||
|
||||
// TestSyncPull tests the pull command functionality
|
||||
func (suite *LnkIntegrationTestSuite) TestSyncPull() {
|
||||
// Initialize repo
|
||||
err := suite.lnk.Init()
|
||||
suite.Require().NoError(err)
|
||||
|
||||
// Add remote for pull to work
|
||||
err = suite.lnk.AddRemote("origin", "https://github.com/test/dotfiles.git")
|
||||
suite.Require().NoError(err)
|
||||
|
||||
// Pull should attempt to pull from remote (will fail in tests but that's expected)
|
||||
_, err = suite.lnk.Pull()
|
||||
// In tests, pull will fail because we don't have real remotes, but that's expected
|
||||
suite.Error(err)
|
||||
suite.Contains(err.Error(), "git pull failed")
|
||||
|
||||
// Test RestoreSymlinks functionality separately
|
||||
// Create a file in the repo directly
|
||||
repoFile := filepath.Join(suite.tempDir, "lnk", ".bashrc")
|
||||
content := "export PATH=$PATH:/usr/local/bin"
|
||||
err = os.WriteFile(repoFile, []byte(content), 0644)
|
||||
suite.Require().NoError(err)
|
||||
|
||||
// Test that RestoreSymlinks can be called (even if it doesn't restore anything in this test setup)
|
||||
restored, err := suite.lnk.RestoreSymlinks()
|
||||
suite.Require().NoError(err)
|
||||
// In this test setup, it might not restore anything, and that's okay for Phase 1
|
||||
suite.GreaterOrEqual(len(restored), 0)
|
||||
}
|
||||
|
||||
// TestSyncStatusNoRemote tests status when no remote is configured
|
||||
func (suite *LnkIntegrationTestSuite) TestSyncStatusNoRemote() {
|
||||
// Initialize repo without remote
|
||||
err := suite.lnk.Init()
|
||||
suite.Require().NoError(err)
|
||||
|
||||
// Status should indicate no remote
|
||||
_, err = suite.lnk.Status()
|
||||
suite.Error(err)
|
||||
suite.Contains(err.Error(), "no remote configured")
|
||||
}
|
||||
|
||||
// TestSyncPushWithModifiedFiles tests push when files are modified
|
||||
func (suite *LnkIntegrationTestSuite) TestSyncPushWithModifiedFiles() {
|
||||
// Initialize repo and add a file
|
||||
err := suite.lnk.Init()
|
||||
suite.Require().NoError(err)
|
||||
|
||||
// Add remote for push to work
|
||||
err = suite.lnk.AddRemote("origin", "https://github.com/test/dotfiles.git")
|
||||
suite.Require().NoError(err)
|
||||
|
||||
testFile := filepath.Join(suite.tempDir, ".bashrc")
|
||||
content := "export PATH=$PATH:/usr/local/bin"
|
||||
err = os.WriteFile(testFile, []byte(content), 0644)
|
||||
suite.Require().NoError(err)
|
||||
|
||||
err = suite.lnk.Add(testFile)
|
||||
suite.Require().NoError(err)
|
||||
|
||||
// Modify the file in the repo (simulate editing managed file)
|
||||
repoFile := filepath.Join(suite.tempDir, "lnk", ".bashrc")
|
||||
modifiedContent := "export PATH=$PATH:/usr/local/bin\nexport EDITOR=vim"
|
||||
err = os.WriteFile(repoFile, []byte(modifiedContent), 0644)
|
||||
suite.Require().NoError(err)
|
||||
|
||||
// Push should detect and commit the changes
|
||||
message := "Updated bashrc with editor setting"
|
||||
err = suite.lnk.Push(message)
|
||||
// In tests, push will fail because we don't have real remotes, but that's expected
|
||||
if err != nil {
|
||||
suite.Contains(err.Error(), "git push failed")
|
||||
}
|
||||
|
||||
// Check that changes were committed (even if push failed)
|
||||
commits, err := suite.lnk.GetCommits()
|
||||
suite.Require().NoError(err)
|
||||
suite.GreaterOrEqual(len(commits), 2) // add commit + sync commit
|
||||
suite.Contains(commits[0], message)
|
||||
}
|
||||
|
||||
func TestLnkIntegrationSuite(t *testing.T) {
|
||||
suite.Run(t, new(LnkIntegrationTestSuite))
|
||||
}
|
Reference in New Issue
Block a user