tealdeer

Tealdeer

Peti	CI (Linux/MacOS/Windows)

Implementasi TLDR yang sangat cepat di Rust: Halaman Pria Sederhana, Berbasis Contoh, dan Didorong Masyarakat.

Jika Anda mengucapkan "tldr" dalam bahasa Inggris, kedengarannya agak seperti "tealdeer". Karenanya nama proyek :)

Jika Anda sedang terburu -buru dan hanya ingin dengan cepat mencoba Tealdeer, Anda dapat menemukan binari statis di halaman Rilis GitHub!

Dokumen (menginstal, penggunaan, konfigurasi)

Dokumentasi pengguna tersedia di https://tealdeer-rs.github.io/tealdeer/!

Dokumen dihasilkan menggunakan MDBook. Mereka dapat diedit melalui file penurunan harga di docs/src/ Direktori.

Sasaran

Tujuan Proyek Tingkat Tinggi:

• Unduh dan cache halaman
• Tidak memerlukan koneksi jaringan untuk apa pun selain memperbarui cache
• Antarmuka baris perintah serupa atau setara dengan klien nodeJS
• Mematuhi spesifikasi klien TLDR
• Sorotan dan konfigurasi lanjutan
• Jadilah cepat

Alat seperti tldr harus tanpa gesekan mungkin untuk digunakan dan menunjukkan output secepat mungkin.

Kami berpikir bahwa tealdeer mencapai tujuan ini. Kami mengumpulkan (lebih atau kurang) tolok ukur yang dapat direproduksi yang menyusun beberapa klien dari sumber dan mengukur waktu eksekusi pada cache disk dingin. Benchmarking dijalankan dalam wadah Docker menggunakan hyperfine SharkDP (DockerFile).

Klien (50 berjalan, 17.10.2021)	Bahasa pemrograman	Berarti dalam MS	Penyimpangan dalam MS	Komentar
outfieldr	Zig	9.1	0,5	tidak ada konfigurasi pengguna
tealdeer	Karat	13.2	0,5
fast-tldr	Haskell	17.0	0.6	Tidak ada contoh yang menyoroti
tldr-hs	Haskell	25.1	0,5	Tidak ada contoh yang menyoroti
tldr-bash	Pesta	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

Seperti yang Anda lihat, tealdeer adalah salah satu yang tercepat dari klien yang diuji. Namun, kami berusaha untuk fitur yang berguna dan kualitas kode atas kinerja mentah, bahkan jika itu berarti kami tidak keluar di atas dalam kompetisi persahabatan ini. Yang mengatakan, kami masih mengoptimalkan kode, misalnya ketika pengembang outfieldr menyarankan untuk beralih ke implementasi TLS asli alih -alih perpustakaan asli.

Perkembangan

Membuat Debug Build dengan Logging Diaktifkan:

 $ cargo build --features logging

Bangun rilis tanpa logging:

 $ cargo build --release

Untuk mengaktifkan output log, atur variabel RUST_LOG Env:

 $ export RUST_LOG=tldr=debug

Untuk menjalankan tes:

 $ cargo test

Untuk menjalankan serat:

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

MSRV (versi karat yang didukung minimal)

Saat menerbitkan rilis tealdeer, versi karat yang diperlukan untuk membangunnya harus stabil setidaknya selama sebulan.

Lisensi

Berlisensi di bawah salah satu dari

• Lisensi Apache, Versi 2.0 (lisensi-apache atau http://www.apache.org/licenses/license-2.0)
• Lisensi MIT (lisensi-mit atau http://opensource.org/licenses/mit) di opsi Anda.

Kontribusi

Kecuali jika Anda secara eksplisit menyatakan sebaliknya, kontribusi apa pun secara sengaja diserahkan untuk dimasukkan dalam pekerjaan oleh Anda, sebagaimana didefinisikan dalam lisensi APACHE-2.0, harus dilisensikan ganda seperti di atas, tanpa syarat atau ketentuan tambahan.

Terima kasih kepada @Severen untuk datang dengan nama "Tealdeer"!