tealdeer

tealteer

Caja	CI (Linux/MacOS/Windows)

Una implementación muy rápida de TLDR en Rust: Man Man Pages, simplificadas, basadas en ejemplo y dirigidas por la comunidad.

Si se pronuncia "TLDR" en inglés, suena algo así como "TeadeLeer". De ahí el nombre del proyecto :)

En caso de que tengas prisa y solo quieras probar rápidamente TeaLelteer, ¡puedes encontrar binarios estáticos en la página de lanzamientos de GitHub!

Documentos (instalación, uso, configuración)

¡La documentación del usuario está disponible en https://tealteer-rs.github.io/tealadleer/!

Los documentos se generan usando Mdbook. Se pueden editar a través de los archivos de Markdown en el directorio docs/src/ .

Objetivos

Objetivos del proyecto de alto nivel:

• Descargar y caché páginas de caché
• No requiere una conexión de red para nada además de actualizar el caché
• Interfaz de línea de comando similar o equivalente al cliente NodeJS
• Cumplir con la especificación del cliente TLDR
• Destacación y configuración avanzadas
• Ser rápido

Una herramienta como tldr debe ser lo más posible para usar y mostrar la salida lo más rápido posible.

Creemos que tealdeer alcanza estos objetivos. Reunimos un punto de referencia (más o menos) reproducible que compila un puñado de clientes de la fuente y mide los tiempos de ejecución en un caché de disco en frío. La evaluación comparativa se ejecuta en un contenedor Docker utilizando hyperfine de SharkDP (DockerFile).

Cliente (50 corridas, 17.10.2021)	Lenguaje de programación	Media en la EM	Desviación en la EM	Comentario
outfieldr	Zigza	9.1	0.5	Sin configuración de usuario
tealdeer	Óxido	13.2	0.5
fast-tldr	Haskell	17.0	0.6	No hay ejemplo destacado
tldr-hs	Haskell	25.1	0.5	No hay ejemplo destacado
tldr-bash	Intento	30.0	0.8
tldr-c	do	38.4	1.0
tldr-python-client	Pitón	87.0	2.4
tldr-node-client	JavaScript / NodeJS	407.1	12.9

Como puede ver, tealdeer es uno de los clientes más rápidos. Sin embargo, nos esforzamos por las características útiles y la calidad del código sobre el rendimiento bruto, incluso si eso significa que no salimos a la cima de esta competencia amistosa. Dicho esto, todavía estamos optimizando el código, por ejemplo, cuando los desarrolladores outfieldr sugirieron cambiar a una implementación de TLS nativa en lugar de las bibliotecas nativas.

Desarrollo

Creación de una compilación de depuración con registro habilitado:

 $ cargo build --features logging

Versión de lanzamiento sin registro:

 $ cargo build --release

Para habilitar la salida de registro, establezca la variable RUST_LOG Env:

 $ export RUST_LOG=tldr=debug

Para ejecutar pruebas:

 $ cargo test

Para ejecutar pelusas:

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

MSRV (versión de óxido mínimamente compatible)

Al publicar un lanzamiento de TeaLelteer, la versión de óxido requerida para construirla debe estar estable durante al menos un mes.

Licencia

Con licencia bajo cualquiera de

• Licencia Apache, Versión 2.0 (Licencia-Apache o http://www.apache.org/licenses/license-2.0)
• Licencia MIT (licencia-mit o http://opensource.org/licenses/mit) a su opción.

Contribución

A menos que declare explícitamente lo contrario, cualquier contribución presentada intencionalmente para su inclusión en el trabajo por usted, como se define en la licencia Apache-2.0, se debe tener doble licencia como se indicó anteriormente, sin ningún término o condiciones adicionales.

¡Gracias a @Severen por presentar el nombre "TeadeLeer"!