tealdeer

Tedeer

Kiste	CI (Linux/macOS/Windows)

Eine sehr schnelle Implementierung von TLDR in Rost: vereinfachte, Beispielbasierte und gemeindenahe Menschenseiten.

Wenn Sie "TLDR" auf Englisch aussprechen, klingt es etwas wie "Tedeer". Daher der Projektname :)

Falls Sie es eilig haben und nur schnell Tedeer probieren möchten, finden Sie statische Binärdateien auf der Seite GitHub Releases!

Dokumente (Installation, Nutzung, Konfiguration)

Die Benutzerdokumentation ist unter https://teAldeer-rs.github.io/teAldeer/ verfügbar!

Die Dokumente werden mit MDBook generiert. Sie können über die Markdown -Dateien im docs/src/ Verzeichnis bearbeitet werden.

Ziele

Hohe Projektziele:

• Seiten herunterladen und cache
• Erfordern Sie keine Netzwerkverbindung für etwas anderes als die Aktualisierung des Cache
• Befehlszeilenschnittstelle ähnlich oder äquivalent mit dem NodeJS -Client
• Die TLDR -Client -Spezifikation einhalten
• Erweiterte Hervorhebung und Konfiguration
• Sei schnell

Ein Werkzeug wie tldr sollte so schnell wie möglich reibungslos wie möglich sein und die Ausgabe so schnell wie möglich anzeigen.

Wir glauben, dass tealdeer diese Ziele erreicht. Wir haben einen (mehr oder weniger) reproduzierbaren Benchmark zusammengestellt, der eine Handvoll Clients aus der Quelle zusammenstellt und die Ausführungszeiten auf einem Kaltscheibe -Cache misst. Das Benchmarking wird in einem Docker -Container unter Verwendung von SharkDP hyperfine (Dockerfile) ausgeführt.

Client (50 Läufe, 17.10.2021)	Programmiersprache	Mittlere in MS	Abweichung in MS	Kommentare
outfieldr	Zick	9.1	0,5	Keine Benutzerkonfiguration
tealdeer	Rost	13.2	0,5
fast-tldr	Haskell	17.0	0,6	Kein Beispiel hervorgehoben
tldr-hs	Haskell	25.1	0,5	Kein Beispiel hervorgehoben
tldr-bash	Verprügeln	30.0	0,8
tldr-c	C	38,4	1.0
tldr-python-client	Python	87.0	2.4
tldr-node-client	JavaScript / NodeJS	407.1	12.9

Wie Sie sehen können, ist tealdeer einer der schnellsten der getesteten Kunden. Wir bemühen uns jedoch nach nützlichen Funktionen und Codequalität gegenüber der RAW -Leistung, auch wenn dies bedeutet, dass wir in diesem freundlichen Wettbewerb nicht die Nase vorn haben. Trotzdem optimieren wir den Code immer noch, beispielsweise wenn die outfieldr -Entwickler vorschlugen, zu einer nativen TLS -Implementierung anstelle der nativen Bibliotheken umzusteigen.

Entwicklung

Erstellen eines Debug -Builds mit aktivierter Protokollierung:

 $ cargo build --features logging

Release Build ohne Protokollierung:

 $ cargo build --release

So setzen Sie die RUST_LOG env -Variable ein, um die Protokollausgabe zu aktivieren:

 $ export RUST_LOG=tldr=debug

Tests ausführen:

 $ cargo test

Lints ausführen:

 $ rustup component add clippy
$ cargo clean && cargo clippy

MSRV (minimal unterstützte Rust -Version)

Beim Veröffentlichen einer Teardeer -Veröffentlichung sollte die Rostversion, die zum Aufbau erforderlich ist, mindestens einen Monat lang stabil sein.

Lizenz

Lizenziert unter einem von

• Apache-Lizenz, Version 2.0 (Lizenz-apache oder http://www.apache.org/licenses/license-2.0)
• MIT-Lizenz (Lizenz- oder http://opensource.org/licenses/Mit) zu Ihrer Option.

Beitrag

Sofern Sie nicht ausdrücklich anders angeben, ist ein Beitrag, der absichtlich zur Aufnahme in die Arbeit von Ihnen eingereicht wird, wie in der Lizenz Apache-2.0 definiert, ohne zusätzliche Bedingungen doppelt lizenziert wie oben.

Vielen Dank an @severen für den Namen "TeaDeer"!