Objective
Rename small utility files in pkg/cli to accurately reflect their specific purpose, improving code discoverability and maintainability.
Context
This addresses Priority 1: High Impact, Low Risk refactoring identified in #3604. Three utility files have generic names that don't match their actual content:
Files to Rename
1. shared_utils.go (3 functions - all PR auto-merge related)
Current name: Generic "shared_utils"
Actual purpose: PR auto-merge functionality
Recommended action:
- Option A: Rename to
pr_merge_utils.go or pr_automerge.go
- Option B: Move functions into
pr_command.go since they're PR-specific
2. frontmatter_utils.go (3 functions - frontmatter field updates)
Current name: Generic "frontmatter_utils"
Actual purpose: Frontmatter field editing
Recommended action:
- Option A: Rename to
frontmatter_editor.go or frontmatter_update.go
- Option B: Inline into files that use it (if limited usage)
3. repeat_utils.go (2 functions - retry logic)
Current name: Generic "repeat_utils"
Actual purpose: Retry/backoff functionality
Recommended action:
- Option A: Rename to
retry.go
- Option B: Move to a general utilities package if used widely
Approach
- Analyze usage: Determine how many files import each utility
- Choose strategy: Rename vs. consolidate vs. move based on usage
- Make changes: Rename files or move functions as appropriate
- Update imports: Fix all import statements across the codebase
- Verify: Ensure all tests pass and no broken imports
Files to Modify
pkg/cli/shared_utils.go → rename or consolidate
pkg/cli/frontmatter_utils.go → rename or consolidate
pkg/cli/repeat_utils.go → rename or consolidate
- All files importing these utilities (update import paths)
Acceptance Criteria
Estimated Effort
1-2 hours
Related
Part of refactoring work identified in #3604
Related to #3604
AI generated by Plan Command for #3604
Objective
Rename small utility files in
pkg/clito accurately reflect their specific purpose, improving code discoverability and maintainability.Context
This addresses Priority 1: High Impact, Low Risk refactoring identified in #3604. Three utility files have generic names that don't match their actual content:
Files to Rename
1.
shared_utils.go(3 functions - all PR auto-merge related)Current name: Generic "shared_utils"
Actual purpose: PR auto-merge functionality
Recommended action:
pr_merge_utils.goorpr_automerge.gopr_command.gosince they're PR-specific2.
frontmatter_utils.go(3 functions - frontmatter field updates)Current name: Generic "frontmatter_utils"
Actual purpose: Frontmatter field editing
Recommended action:
frontmatter_editor.goorfrontmatter_update.go3.
repeat_utils.go(2 functions - retry logic)Current name: Generic "repeat_utils"
Actual purpose: Retry/backoff functionality
Recommended action:
retry.goApproach
Files to Modify
pkg/cli/shared_utils.go→ rename or consolidatepkg/cli/frontmatter_utils.go→ rename or consolidatepkg/cli/repeat_utils.go→ rename or consolidateAcceptance Criteria
make test-unit)make fmt)Estimated Effort
1-2 hours
Related
Part of refactoring work identified in #3604
Related to #3604