tealdeer
Version 1.7.1
| クレート | CI（Linux/Macos/Windows） |
|---|---|
 |
さびにおけるTLDRの非常に速い実装：簡素化された、例ベース、コミュニティ主導のマンページ。
英語で「tldr」と発音すると、「ティールルダー」のように聞こえます。したがって、プロジェクト名:)
急いでティールディアをすばやく試してみたい場合は、GitHubリリースページに静的バイナリを見つけることができます！
ユーザードキュメントは、https：//tealldeer-rs.github.io/tealdeer/で入手できます！
ドキュメントはMDBookを使用して生成されます。 docs/src/ディレクトリのMarkdownファイルを介して編集できます。
高レベルのプロジェクト目標：
tldrのようなツールは、可能な限り速く出力を使用して表示するために、できるだけ摩擦のないものでなければなりません。
tealdeerこれらの目標を達成していると思います。ソースから少数のクライアントをコンパイルし、コールドディスクキャッシュで実行時間を測定する（多かれ少なかれ）再現可能なベンチマークをまとめました。ベンチマークは、SharkDPのhyperfine （DockerFile）を使用してDockerコンテナで実行されます。
| クライアント（50回の実行、17.10.2021） | プログラミング言語 | MSの平均 | MSの偏差 | コメント |
|---|---|---|---|---|
outfieldr | ジグ | 9.1 | 0.5 | ユーザー構成はありません |
tealdeer | さび | 13.2 | 0.5 | |
fast-tldr | ハスケル | 17.0 | 0.6 | ハイライトの例はありません |
tldr-hs | ハスケル | 25.1 | 0.5 | ハイライトの例はありません |
tldr-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 |
ご覧のとおり、 tealdeer 、テストされたクライアントの中で最も速いクライアントの1つです。ただし、このフレンドリーな競争でトップに出ないということであっても、私たちは生のパフォーマンスよりも有用な機能とコードの品質を求めています。とはいえ、たとえば、 outfieldr開発者がネイティブライブラリの代わりにネイティブTLS実装に切り替えることを提案した場合、コードを最適化しています。
ロギングを有効にしたデバッグビルドの作成：
$ cargo build --features logging
ログなしでビルドをリリースします：
$ cargo build --release
ログ出力を有効にするには、 RUST_LOG env変数を設定します。
$ export RUST_LOG=tldr=debug
テストを実行するには：
$ cargo test
糸くずを実行する：
$ rustup component add clippy
$ cargo clean && cargo clippy
Tealdeerリリースを公開する場合、それを構築するのに必要な錆バージョンは、少なくとも1か月間安定しているはずです。
いずれかの下でライセンスされています
明示的に特に述べない限り、Apache-2.0ライセンスで定義されているように、お客様による作業への包含のために意図的に提出された貢献は、追加の条件なしで、上記のように二重ライセンスを取得するものとします。
@severenに「Tealdeer」という名前を考えてくれてありがとう！
