tealdeer

turreur

Caisse	CI (Linux / MacOS / Windows)

Une implémentation très rapide de TLDR dans Rust: Pages d'hommes simplifiées, basées sur des exemples et axées sur la communauté.

Si vous prononcez "TLDR" en anglais, cela ressemble un peu à "Tealdeer". D'où le nom du projet :)

Au cas où vous seriez pressé et que vous vouliez juste essayer rapidement Tealdeer, vous pouvez trouver des binaires statiques sur la page GitHub Releases!

Docs (installation, utilisation, configuration)

La documentation utilisateur est disponible sur https://tealdeer-rs.github.io/tealdeer/!

Les documents sont générés à l'aide de MDBook. Ils peuvent être modifiés via les fichiers Markdown dans docs/src/ Directory.

Objectifs

Objectifs du projet de haut niveau:

• Pages de téléchargement et de cache
• Ne nécessite pas de connexion réseau pour rien en plus de mettre à jour le cache
• Interface de ligne de commande similaire ou équivalent au client NodeJS
• Respectez la spécification du client TLDR
• Mise en évidence et configuration avancées
• Être rapide

Un outil comme tldr doit être aussi sans frottement que possible à utiliser et afficher la sortie aussi rapidement que possible.

Nous pensons que tealdeer atteint ces objectifs. Nous avons mis en place une référence reproductible (plus ou moins) qui compile une poignée de clients de la source et mesure les temps d'exécution sur un cache de disque froid. L'analyse comparative est exécutée dans un conteneur Docker à l'aide hyperfine de SharkDP (Dockerfile).

Client (50 courses, 17.10.2021)	Langage de programmation	Moyenne dans MS	Déviation en ms	Commentaires
outfieldr	Zigou	9.1	0,5	Aucune configuration utilisateur
tealdeer	Rouiller	13.2	0,5
fast-tldr	Haskell	17.0	0.6	Aucun exemple de mise en évidence
tldr-hs	Haskell	25.1	0,5	Aucun exemple de mise en évidence
tldr-bash	Frapper	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

Comme vous pouvez le voir, tealdeer est l'un des plus rapides des clients testés. Cependant, nous recherchons des fonctionnalités utiles et de la qualité du code par rapport aux performances brutes, même si cela signifie que nous ne sortons pas en tête dans cette compétition amicale. Cela dit, nous optimisons toujours le code, par exemple lorsque les développeurs outfieldr ont suggéré de passer à une implémentation TLS native au lieu des bibliothèques natives.

Développement

Création d'une version de débogage avec journalisation activée:

 $ cargo build --features logging

Version de libération sans journalisation:

 $ cargo build --release

Pour activer la sortie du journal, définissez la variable Env RUST_LOG :

 $ export RUST_LOG=tldr=debug

Pour exécuter des tests:

 $ cargo test

Pour courir des peluches:

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

MSRV (version de rouille à sous-prise en charge)

Lors de la publication d'une version Tealdeer, la version Rust requise pour la construire devrait être stable pendant au moins un mois.

Licence

Sous licence sous l'un ou l'autre des

• Licence Apache, version 2.0 (Licence-apache ou http://www.apache.org/licenses/license-2.0)
• Licence MIT (Licence-MIT ou http://openseource.org/licenses/mit) à votre option.

Contribution

À moins que vous ne soyez explicitement indiqué autrement, toute contribution intentionnellement soumise pour inclusion dans les travaux par vous, telle que définie dans la licence Apache-2.0, doit être autorisée à double licence comme ci-dessus, sans aucune condition supplémentaire.

Merci à @severen d'avoir vu le nom "Tealdeer"!