tealdeer

Tealdeer

قفص	CI (Linux/MacOS/Windows)

تنفيذ سريع للغاية لـ TLDR في الصدأ: صفحات الرجل المبسطة ، القائمة على القائمة على المجتمع.

إذا قمت نطق "TLDR" باللغة الإنجليزية ، فإنه يبدو مثل "Tealdeer" إلى حد ما. ومن هنا اسم المشروع :)

في حال كنت في عجلة من أمرك وترغب فقط في تجربة Tealdeer بسرعة ، يمكنك العثور على ثنائيات ثابتة على صفحة إصدارات Github!

مستندات (التثبيت ، الاستخدام ، التكوين)

وثائق المستخدم متوفرة على https://tealdeer-re.github.io/tealdeer/!

يتم إنشاء المستندات باستخدام MDBOOK. يمكن تحريرها من خلال ملفات Markdown في docs/src/ Directory.

الأهداف

أهداف المشروع عالية المستوى:

• قم بتنزيل صفحات ذاكرة التخزين المؤقت
• لا تتطلب اتصال شبكة لأي شيء إلى جانب تحديث ذاكرة التخزين المؤقت
• واجهة سطر الأوامر مماثلة أو مكافئة لعميل NodeJS
• الامتثال لمواصفات عميل TLDR
• تسليط الضوء والتكوين المتقدم
• كن سريعًا

يجب أن تكون أداة مثل tldr بدون احتكاك قدر الإمكان لاستخدام وإظهار الإخراج في أسرع وقت ممكن.

نعتقد أن tealdeer يصل إلى هذه الأهداف. قمنا بتجميع معيار مستنسخ (أكثر أو أقل) يجمع حفنة من العملاء من المصدر ويقيس أوقات التنفيذ على ذاكرة التخزين المؤقت للقرص البارد. يتم تشغيل المعايير في حاوية Docker باستخدام Fyrichdp's hyperfine (Dockerfile).

العميل (50 أشواط ، 17.10.2021)	لغة البرمجة	يعني في مرض التصلب العصبي المتعدد	الانحراف في مرض التصلب العصبي المتعدد	تعليقات
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	ج	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

لتمكين إخراج السجل ، اضبط متغير RUST_LOG Env:

 $ export RUST_LOG=tldr=debug

لتشغيل الاختبارات:

 $ cargo test

لتشغيل العتبات:

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

MSRV (إصدار الصدأ المدعوم الحد الأدنى)

عند نشر إصدار Tealdeer ، يجب أن يكون إصدار Rust المطلوب لبناءه مستقرًا لمدة شهر على الأقل.

رخصة

مرخصة تحت أي من

• ترخيص Apache ، الإصدار 2.0 (ترخيص-apache أو http://www.apache.org/licenses/license-2.0)
• ترخيص MIT (الترخيص-mit أو http://opensource.org/licenses/mit) في خيارك.

مساهمة

ما لم تقل صراحةً خلاف ذلك ، فإن أي مساهمة تم تقديمها عن عمد لإدراجها في العمل بواسطتك ، كما هو محدد في ترخيص Apache-2.0 ، تكون مرخصة مزدوجة على النحو الوارد أعلاه ، دون أي شروط أو شروط إضافية.

بفضل severen لتوصل إلى اسم "Tealdeer"!