tealdeer

чайлдир

Ящик	CI (Linux/macOS/Windows)

Очень быстрая реализация TLDR в Rust: упрощенные, примеры и управляемые сообществом страницы.

Если вы произносите «TLDR» на английском языке, это звучит как «чайлдер». Отсюда и название проекта :)

Если вы спешите и просто хотите быстро попробовать Tealdeer, вы можете найти статические двоичные файлы на странице Github Relesesessessessesses!

Документы (установка, использование, конфигурация)

Пользовательская документация доступна по адресу https://tealdeer-rs.github.io/tealdeer/!

Документы генерируются с использованием MDBook. Они могут быть отредактированы через файлы разметки в docs/src/ Directory.

Цели

Цели проекта высокого уровня:

• Скачать и кеш
• Не требуется сетевое соединение ни для чего, помимо обновления кэша
• Интерфейс командной строки, аналогичный или эквивалентный клиенту Nodejs
• Соответствует спецификации клиента TLDR
• Расширенное выделение и конфигурация
• Быть быстрым

Такой инструмент, как tldr должен быть максимально без трения, чтобы использовать и показать выходной сигнал как можно быстрее.

Мы думаем, что tealdeer достигает этих целей. Мы собрали (более или менее) воспроизводимый эталон, который составляет несколько клиентов из источника и измеряет время выполнения в кэше холодного диска. Бенчмаркинг запускается в контейнере Docker с использованием hyperfine SharkDP (DockerFile).

Клиент (50 прогонов, 17.10.2021)	Язык программирования	Среднее в MS	Отклонение в MS	Комментарии
outfieldr	Zig	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 (License-apache или http://www.apache.org/licenses/license-2.0)
• Лицензия MIT (лицензия MIT или http://opensource.org/licenses/mit) по варианту.

Вклад

Если вы явно не заявляете иное, какой-либо вклад, преднамеренно предназначенный для включения в работу вами, как определено в лицензии Apache-2.0, должен быть двойной лицензией, как указано выше, без каких-либо дополнительных условий или условий.

Спасибо @severen за то, что придумали имя "Tealdeer"!