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.