tealdeer

Tealdeer

Crate	CI (Linux/MacOS/Windows)

Uma implementação muito rápida do TLDR na ferrugem: páginas simplificadas, baseadas em exemplo e com a comunidade.

Se você pronuncia "TLDR" em inglês, parece um pouco como "Tealdeer". Daí o nome do projeto :)

Caso você esteja com pressa e só queira experimentar rapidamente TealDeer, você pode encontrar binários estáticos na página de lançamentos do Github!

Documentos (instalação, uso, configuração)

A documentação do usuário está disponível em https://tealdeer-rs.github.io/tealdeer/!

Os documentos são gerados usando o MDbook. Eles podem ser editados através dos arquivos de marcação no diretório docs/src/ .

Metas

Metas de projeto de alto nível:

• Páginas de download e cache
• Não exija uma conexão de rede para nada além de atualizar o cache
• Interface da linha de comando semelhante ou equivalente ao cliente NodeJS
• Cumprir a especificação do cliente TLDR
• Destaque e configuração avançados
• Seja rápido

Uma ferramenta como tldr deve ser o mais sem atrito possível de usar e mostrar a saída o mais rápido possível.

Achamos que tealdeer atinge esses objetivos. Reunimos uma referência (mais ou menos) reprodutível que compila um punhado de clientes da fonte e mede os tempos de execução em um cache de disco frio. O benchmarking é executado em um recipiente do docker usando hyperfine do SharkDP (Dockerfile).

Cliente (50 corridas, 17.10.2021)	Linguagem de programação	Média em MS	Desvio em MS	Comentários
outfieldr	Zig	9.1	0,5	Sem configuração do usuário
tealdeer	Ferrugem	13.2	0,5
fast-tldr	Haskell	17.0	0,6	nenhum exemplo destacando
tldr-hs	Haskell	25.1	0,5	nenhum exemplo destacando
tldr-bash	Bash	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

Como você pode ver, tealdeer é um dos mais rápidos dos clientes testados. No entanto, buscamos recursos úteis e qualidade de código sobre o desempenho bruto, mesmo que isso signifique que não saímos no topo nesta competição amigável. Dito isto, ainda estamos otimizando o código, por exemplo, quando os desenvolvedores outfieldr sugeriram mudar para uma implementação nativa do TLS, em vez das bibliotecas nativas.

Desenvolvimento

Criando uma construção de depuração com o registro ativado:

 $ cargo build --features logging

Libere a construção sem registro:

 $ cargo build --release

Para ativar a saída do log, defina a variável RUST_LOG Env:

 $ export RUST_LOG=tldr=debug

Para executar testes:

 $ cargo test

Para executar fiapos:

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

MSRV (versão de ferrugem minimamente suportada)

Ao publicar um lançamento em TealDeer, a versão Rust necessária para construí -la deve ser estável por pelo menos um mês.

Licença

Licenciado sob qualquer um de

• Licença Apache, versão 2.0 (licença-apache ou http://www.apache.org/license/license-2.0)
• MIT License (licença-mit ou http://opensource.org/license/mit) por sua opção.

Contribuição

A menos que você declare explicitamente o contrário, qualquer contribuição enviada intencionalmente para inclusão no trabalho por você, conforme definido na licença Apache-2.0, será licenciado como acima, sem termos ou condições adicionais.

Obrigado a @Severen por ter inventado o nome "Tealdeer"!