lsd-rs/lsd

mention shell completions usage in `README.md`

Offen

#853 geöffnet am 05.06.2023

Auf GitHub ansehen
 (3 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Rust (434 Forks)batch import
good first issuehelp wantedkind/doc

Repository-Metriken

Stars
 (13.400 Sterne)
PR-Merge-Metriken
 (Durchschn. Merge 34T 3h) (2 gemergte PRs in 30 T)

Beschreibung

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-Richtung
Untersuchen Sie, wie Shell Vervollständigungen in der build.rs Datei generiert werden, und entscheiden Sie, ob Sie die Umgebungsvariablen dokumentieren oder ein CLI Flag für die Laufzeitgenerierung hinzufügen möchten.
Tech Stack
rust
Domain
cli
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Git
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
75