tealdeer

Tealdeer

ลัง	CI (Linux/MacOS/Windows)

การใช้งาน TLDR อย่างรวดเร็วในการเกิดสนิม: ง่ายขึ้นตัวอย่างที่ใช้และชุมชนที่ขับเคลื่อนด้วยชุมชน

หากคุณออกเสียง "tldr" เป็นภาษาอังกฤษมันฟังดูค่อนข้าง "Tealdeer" ดังนั้นชื่อโครงการ :)

ในกรณีที่คุณรีบร้อนและต้องการลอง Tealdeer อย่างรวดเร็วคุณสามารถค้นหาไบนารีคงที่ในหน้า GitHub Reasees!

เอกสาร (การติดตั้งการใช้งานการกำหนดค่า)

เอกสารของผู้ใช้มีอยู่ที่ https://tealdeer-rs.github.io/tealdeer/!

เอกสารถูกสร้างขึ้นโดยใช้ MDBook พวกเขาสามารถแก้ไขได้ผ่านไฟล์ Markdown ใน docs/src/ DIRECTORY

เป้าหมาย

เป้าหมายโครงการระดับสูง:

• ดาวน์โหลดและหน้าแคช
• ไม่ต้องการการเชื่อมต่อเครือข่ายสำหรับสิ่งใดนอกจากการอัปเดตแคช
• อินเทอร์เฟซบรรทัดคำสั่งที่คล้ายกันหรือเทียบเท่ากับไคลเอนต์ nodejs
• ปฏิบัติตามข้อกำหนดของไคลเอนต์ TLDR
• การไฮไลต์และการกำหนดค่าขั้นสูง
• เร็ว

เครื่องมือเช่น tldr ควรใช้แรงเสียดทานมากที่สุดเท่าที่จะเป็นไปได้ในการใช้และแสดงผลลัพธ์ที่เร็วที่สุด

เราคิดว่า tealdeer บรรลุเป้าหมายเหล่านี้ เรารวบรวมเกณฑ์มาตรฐานที่ทำซ้ำได้ (มากหรือน้อย) ที่รวบรวมลูกค้าจำนวนหนึ่งจากแหล่งที่มาและวัดเวลาการดำเนินการบนแคชดิสก์เย็น การเปรียบเทียบนั้นทำงานในคอนเทนเนอร์ Docker โดยใช้ hyperfine ของ SharkDP (DockerFile)

ไคลเอนต์ (50 รัน, 17.10.2021)	ภาษาการเขียนโปรแกรม	ค่าเฉลี่ยใน MS	การเบี่ยงเบนใน MS	ความเห็น
outfieldr	ซิก	9.1	0.5	ไม่มีการกำหนดค่าผู้ใช้
tealdeer	สนิม	13.2	0.5
fast-tldr	Haskell	17.0	0.6	ไม่มีตัวอย่างที่เน้น
tldr-hs	Haskell	25.1	0.5	ไม่มีตัวอย่างที่เน้น
tldr-bash	ทุบตี	30.0	0.8
tldr-c	C	38.4	1.0
tldr-python-client	งูหลาม	87.0	2.4
tldr-node-client	JavaScript / nodejs	407.1	12.9

อย่างที่คุณเห็น tealdeer เป็นหนึ่งในลูกค้าที่ผ่านการทดสอบที่เร็วที่สุด อย่างไรก็ตามเราพยายามหาคุณสมบัติที่มีประโยชน์และคุณภาพของรหัสผ่านประสิทธิภาพดิบแม้ว่านั่นหมายความว่าเราไม่ได้ออกมาด้านบนในการแข่งขันที่เป็นมิตรนี้ ที่กล่าวว่าเรายังคงเพิ่มประสิทธิภาพรหัสเช่นเมื่อนักพัฒนา outfieldr แนะนำให้เปลี่ยนไปใช้การใช้งาน TLS ดั้งเดิมแทนไลบรารีดั้งเดิม

การพัฒนา

การสร้างบิลด์ดีบั๊กที่เปิดใช้งานการบันทึก:

 $ cargo build --features logging

สร้างบิลด์โดยไม่ต้องเข้าสู่ระบบ:

 $ cargo build --release

หากต้องการเปิดใช้งานเอาต์พุตบันทึกให้ตั้งค่าตัวแปร env RUST_LOG :

 $ export RUST_LOG=tldr=debug

เพื่อเรียกใช้การทดสอบ:

 $ cargo test

เพื่อเรียกใช้ผ้าสำลี:

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

MSRV (เวอร์ชันสนิมที่รองรับน้อยที่สุด)

เมื่อเผยแพร่การเปิดตัว Tealdeer เวอร์ชันสนิมที่จำเป็นในการสร้างมันควรจะเสถียรเป็นเวลาอย่างน้อยหนึ่งเดือน

ใบอนุญาต

ได้รับใบอนุญาตภายใต้

• ใบอนุญาต Apache, เวอร์ชัน 2.0 (License-apache หรือ http://www.apache.org/licenses/license-2.0)
• ใบอนุญาต MIT (ใบอนุญาต-MIT หรือ http://opensource.org/licenses/mit) ที่ตัวเลือกของคุณ

ผลงาน

เว้นแต่คุณจะระบุอย่างชัดเจนเป็นอย่างอื่นการมีส่วนร่วมใด ๆ ที่ส่งโดยเจตนาเพื่อรวมไว้ในงานโดยคุณตามที่กำหนดไว้ในใบอนุญาต Apache-2.0 จะได้รับใบอนุญาตคู่ดังกล่าวข้างต้นโดยไม่มีข้อกำหนดหรือเงื่อนไขเพิ่มเติมใด ๆ

ขอบคุณ @Severen ที่มาพร้อมกับชื่อ "Tealdeer"!