lsd-rs/lsd

mention shell completions usage in `README.md`

Open

#853 opened on 2023年6月5日

GitHub で見る
 (3 comments) (0 reactions) (0 assignees)Rust (13,400 stars) (434 forks)batch import
good first issuehelp wantedkind/doc

説明

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.

コントリビューターガイド

技術スタック
rust
領域
clidocumentation
Issue 種別
documentation
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
2
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
under 1 hour
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
fresh
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
clear
前提条件
basic Rust knowledge
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
90
調査方針
Examine the build script at build.rs lines 24-36 to understand how shell completions are generated using clap complete. Then update README.md to document the need to set SHELL COMPLETIONS DIR or OUT DIR environment variables before building. Alternatively, consider implementing a runtime command for generating completions. Review the existing discussion in the issue comments for additional context.