lsd-rs/lsd

mention shell completions usage in `README.md`

开放

#853 创建于 2023年6月5日

在 GitHub 查看
 (3 条评论) (0 个反应) (0 位负责人)Rust (434 个派生)batch import
good first issuehelp wantedkind/doc

仓库指标

星标
 (13,400 个星标)
PR 合并指标
 (平均合并 34天 3小时) (30 天内合并 2 个 PR)

描述

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.

贡献者指南

研究方向
调查build.rs文件中如何生成shell补全，并决定是记录所需环境变量还是添加运行时生成的CLI标志。
技术栈
rust
领域
cli
议题类型
文档
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
2
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-3 小时
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
活跃
清晰度议题是否清楚说明期望改动、验收标准和下一步。
清晰
前置要求
Git
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
75