Skip to content

feat(cli): shell completions - #83

Merged
yanxue06 merged 3 commits into
mainfrom
feat/shell-completions
Aug 12, 2026
Merged

feat(cli): shell completions#83
yanxue06 merged 3 commits into
mainfrom
feat/shell-completions

Conversation

@yanxue06

Copy link
Copy Markdown
Owner
git-semantic completions zsh > ~/.zfunc/_git-semantic
git-semantic completions bash > /etc/bash_completion.d/git-semantic
git-semantic completions fish > ~/.config/fish/completions/git-semantic.fish

bash, zsh, fish, elvish, and powershell. Generated from the same clap definition the parser is built from, so the flags a shell offers cannot drift from the flags that exist.

Named for the binary rather than the git alias — git semantic … completes through git's own subcommand machinery, which finds git-semantic on PATH.

Also here: a closed pipe no longer panics

Generating a completion script is the obvious thing to pipe, and piping it revealed that the binary panics on EPIPE:

$ git-semantic completions zsh | head -3
thread 'main' panicked at clap_complete-4.6.9/src/aot/shells/shell.rs:86:14:
failed to write completion file: Os { code: 32, kind: BrokenPipe }

Rust ignores SIGPIPE at startup, so a closed pipe turns into an EPIPE that println! panics on. search --json | head did the same thing — the two outputs most likely to be piped were the two that broke. Restoring the default disposition on unix makes the process die the way every other tool in the pipeline does.

Tests

Three new cases: every shell emits a script containing a marker unique to its own format, the script covers every subcommand, and an unknown shell is rejected with the list of known ones.

The pipe fix has no test. Whether the child hits EPIPE at all depends on losing a race against the reader's exit, and the completion script is 8 KB — well under a pipe buffer — so a test would pass without exercising anything. Verified by hand instead.


Second of four stacked PRs, on top of #82.

yanxue06 and others added 3 commits August 12, 2026 00:55
`RepositoryParser` discovers the repository the way git does, walking up
from wherever it was invoked. `IndexStorage` did not — it looked for
`./.git` and gave up. So every command worked from the repository root
and reported "not a git repository" one directory down, which is where
most people actually are:

    $ cd src && git-semantic search "race condition"
    error: not a git repository: .git directory not found

Discovery also resolves the `gitdir:` pointer in a linked worktree's or
submodule's `.git` file. Submodules write that pointer relative to the
submodule directory (`gitdir: ../.git/modules/<name>`); reading the file
by hand resolved it against the process's working directory instead and
put the index outside the repository.

`InvalidGitFile` now marks a `.git` entry that exists but does not
resolve, so a broken worktree keeps its own hint instead of being told it
is not in a repository.

The storage tests built a bare `.git` directory that no git tool would
accept. They now initialize real repositories, which is what the file
headers claimed all along.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
`git-semantic completions <shell>` writes a completion script for bash,
zsh, fish, elvish, or powershell to stdout. Generated from the same clap
definition the parser is built from, so the flags a shell offers cannot
drift from the flags that exist.

Named for the binary rather than the git alias: `git semantic …`
completes through git's own subcommand machinery, which finds
`git-semantic` on PATH.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Rust ignores SIGPIPE at startup, so writing to a closed pipe returns
EPIPE and `println!` panics on it. `git-semantic completions zsh | head`
printed a Rust panic and a backtrace note instead of the first few lines,
and `search --json | head` did the same — the two outputs most likely to
be piped were the two that broke.

Restoring the default disposition on unix makes the process die the way
every other tool in the pipeline does.

Not covered by a test: whether the child hits EPIPE at all depends on
losing a race against the reader's exit, and the completion script is
8 KB, well under a pipe buffer. A test would pass without exercising
anything. Verified by hand instead.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
@yanxue06 yanxue06 added enhancement New feature or request release labels Aug 12, 2026
@yanxue06
yanxue06 merged commit ff2bb3b into main Aug 12, 2026
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request release

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant