lsd-rs/lsd

mention shell completions usage in `README.md`

Open

#853 建立於 2023年6月5日

在 GitHub 查看
 (3 留言) (0 反應) (0 負責人)Rust (13,400 star) (434 fork)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
議題類型
documentation
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
2
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
under 1 hour
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
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.
mention shell completions usage in `README.md` · lsd-rs/lsd#853 | Good First Issue