Streamline tildes pt 2 #475
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
why: Fix inconsistency where workspace_root used ~/ but path showed full
/home/username/ paths, exposing usernames and reducing portability
what:
- Apply contract_user_home() to path field in list.py (flat and tree views)
- Apply contract_user_home() to path field in status.py (status dict)
- Apply contract_user_home() to path field in sync.py (PlanEntry and events)
- All JSON/NDJSON output now consistently uses ~/... notation
- Human output already used tilde notation (unchanged)
Before:
{"path": "/home/username/code/flask", "workspace_root": "~/code/"}
After:
{"path": "~/code/flask", "workspace_root": "~/code/"}
Benefits:
- Consistency: Both path and workspace_root now use tilde
- Privacy: No username exposure in JSON dumps
- Portability: Configs/output work across different machines
- Matches shell conventions and user expectations
refs: Breaking change - automation may need to expand ~ to absolute paths
why: Ensure JSON/NDJSON output correctly contracts home directory paths what: - Add PathContractionFixture NamedTuple in test_list.py - Add 3 parametrized test cases for list (JSON, NDJSON, JSON+tree) - Add StatusPathContractionFixture NamedTuple in test_status.py - Add 3 parametrized test cases for status (JSON, NDJSON, detailed) - Assert paths start with ~/ and don't contain absolute home paths - Follow project pattern: NamedTuple fixtures with test_id field Coverage: - test_list_repos_path_contraction: 3 scenarios - test_status_repos_path_contraction: 3 scenarios - Total: 6 new parametrized test cases All 208 tests passing
why: Users consuming JSON/NDJSON output need to know about the change what: - Add Breaking Changes section to v1.41.x unreleased notes - Document that all commands (list, status, sync) now use ~/ - Show before/after JSON examples - Explain rationale: consistency, privacy, portability - Note impact: automation may need to expand ~ if required Breaking change: path field changed from /home/user/... to ~/...
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #475 +/- ##
=======================================
Coverage 79.10% 79.10%
=======================================
Files 14 14
Lines 1527 1527
Branches 321 321
=======================================
Hits 1208 1208
Misses 201 201
Partials 118 118 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.