renamer Development Guidelines

Auto-generated from all feature plans. Last updated: 2025-10-29

Active Technologies

Local filesystem (no persistent database) (002-add-replace-command)
Go 1.24 + spf13/cobra, spf13/pflag (001-list-command-filters)
Local filesystem only (ledger persisted as .renamer) (003-add-remove-command)
Go 1.24 + spf13/cobra, spf13/pflag, internal traversal/ledger packages (004-extension-rename)
Local filesystem + .renamer ledger files (004-extension-rename)
Go 1.24 + spf13/cobra, spf13/pflag, internal traversal/history/output packages (005-add-insert-command)

cmd/
internal/
scripts/
tests/

renamer list — preview rename scope with shared flags before executing changes.
renamer replace — consolidate multiple literal patterns into a single replacement (supports --dry-run + --yes).
renamer remove — delete ordered substrings from filenames with empty-name protections, duplicate warnings, and undoable ledger entries.
renamer undo — revert the most recent rename/replace batch using ledger entries.
Persistent scope flags: --path, -r/--recursive, -d/--include-dirs, --hidden, --extensions, --yes, --dry-run.

go test ./...
Contract tests: tests/contract/replace_command_test.go, tests/contract/remove_command_preview_test.go, tests/contract/remove_command_ledger_test.go
Integration tests: tests/integration/replace_flow_test.go, tests/integration/remove_flow_test.go, tests/integration/remove_undo_test.go, tests/integration/remove_validation_test.go
Smoke: scripts/smoke-test-replace.sh, scripts/smoke-test-remove.sh

005-add-insert-command: Added Go 1.24 + spf13/cobra, spf13/pflag, internal traversal/history/output packages
004-extension-rename: Added Go 1.24 + spf13/cobra, spf13/pflag, internal traversal/ledger packages
003-add-remove-command: Added sequential renamer remove subcommand, automation-friendly ledger metadata, and CLI warnings for duplicates/empty results