lsd-rs/lsd

mention shell completions usage in `README.md`

Open

#853 opened on Jun 5, 2023

View on GitHub
 (3 comments) (0 reactions) (0 assignees)Rust (434 forks)batch import
good first issuehelp wantedkind/doc

Repository metrics

Stars
 (13,400 stars)
PR merge metrics
 (Avg merge 34d 3h) (2 merged PRs in 30d)

Description

https://github.com/lsd-rs/lsd/blob/2fe3fcdd3564836962eab8ba6b1444996fe24e1e/build.rs#L24-L36

despite lsd providing shell completions via clap_complete::generate_to, there is no documentation that either SHELL_COMPLETIONS_DIR or OUT_DIR environment variable needs to be set to generate one.

alternatively, LSD could provide a command-line option to generate completions at runtime.

Contributor guide

Research direction
Investigate how shell completions are generated in the build.rs file and determine whether to document the environment variables or add a CLI flag for runtime generation.
Tech stack
rust
Domain
cli
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75