Claude/update readme content dn jab #8
Merged
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
Replace vague documentation with concrete information: - Add "Deliverable" section defining what Modshells does - Add "Current Status" summary showing working vs stub features - Split "Development Status" into "Working Now" vs "Not Yet Implemented" - Update "Usage" section to distinguish current functionality (v0.0) from planned functionality (v0.1+) - Improve directory structure descriptions
Implement all previously stubbed features: Shell detection (shell_manager.adb): - Check /usr/bin, /bin, /usr/local/bin, /opt/homebrew/bin for binaries - Map each Shell_Type to its binary name (bash, zsh, nu, etc.) - Return accurate Installed/Not_Installed status Config file backup (Create_Backup): - Create timestamped backups before modification - Format: <file>.modshells-backup-YYYYMMDD-HHMMSS - Uses Ada.Calendar for timestamp generation Shell-specific sourcing syntax (Get_Sourcing_Block): - POSIX shells (Bash, Zsh, Ksh, Dash, Oils): for loop with . sourcing - Fish: for loop with source command - Nushell: glob-based sourcing with path join - Tcsh: foreach with source - Ion: for loop with source - PowerShell: Get-ChildItem piped to dot-sourcing Source injection (Modularise_Config): - Check if already modularized via MODSHELLS_START signature - Create config directory if needed (Fish, Nushell, etc.) - Backup existing config file - Append sourcing block Main procedure: - Display detected shells with status - Call Modularise_All_Shells for all installed shells - Version bump to v0.1
Examples (examples/): - core/00-path.sh: PATH modifications for common tools - core/10-history.sh: History configuration - core/20-options.sh: Shell options, editor, locale - tools/git.sh: Git aliases (gs, ga, gc, gp, etc.) - tools/fzf.sh: Fuzzy finder with fd integration - tools/starship.sh: Starship prompt init - misc/aliases.sh: Navigation, ls variants, safety nets - misc/functions.sh: mkcd, extract, ff, fd, backup - os/linux.sh: Package manager aliases, systemd - os/macos.sh: Homebrew, macOS utilities - ui/colours.sh: Terminal and man page colours - ui/prompt.sh: Custom prompt with git branch Tests (tests/): - smoke_test.sh: Shell-based smoke test verifying: - Source files exist - Examples structure correct - SPDX headers present - Binary runs and creates directories - Idempotency works - test_shell_manager.adb: Ada unit tests for Shell_Manager - tests.gpr: GPRBuild project for tests README updates: - Added Examples section with file descriptions - Added Testing section with smoke and unit test instructions
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.