Красиво оформляем текст. Три строчки и красиво везде

Привет, Мир! 🖐

Решил поделиться как я оформляю свои посты. Мало написать хороший текст. Нужно ещё следить за орфографической и стилистической грамотностью, чтобы была высокая читаемость.

Сначала я проверял свои текста после написания самостоятельно, но это было затратно по времени и не всегда удавалось увидеть ошибку с первого раза. Встал вопрос, как это можно автоматизировать. Онлайн сервиса, который решал бы все мои задачи сразу я не нашёл, а копировать текст из одного в другой мне не хотелось.

Я решил поискать CLI пакеты для моих задач и нашёл то что нужно: typograf-cli, eyo, yaspeller.

Нужно один раз поставить все пакеты глобально, а потом использовать как вам удобно.

npm i typograf-cli eyo yaspeller -g

«Типограф» исправляет текст с точки зрения типографики. Заменяет неверные символы, кавычки, тире и дефисы на правильные. Можно быстро и легко улучшить качество текста за счёт грамотного оформления.

typograf -l ru Черновик.md > Чистовик.md

О том, надо ли писать букву «ё», спорят примерно со дня её введения. Считается, что использовать её необязательно, но это моё личное предпочтение.

eyo -i Чистовик.md

Safe replacements: 1. ещё → ещё (5:80) 2. нашёл → нашёл (7:254) 3. нашёл → нашёл (9:46) 4. счёт → счёт (18:171) 5. ещё → ещё (54:1) 6. прошёл → прошёл (55:1) 7. лёша → лёша (56:1) --- Not safe replacements: 1. все → всё (7:228) 2. все → всё (11:26) 3. лет → лёт (58:1) 4. все → всё (59:1) ---

«Яндекс.Спеллер» проверяет орфографию в тексте. Поддерживает русский и английский язык. Автоматического исправления я не нашёл, придётся каждую ошибку править руками, но меня пока устраивает.

yaspeller Чистовик.md

----- Typos: 2 1. лендингах (59:163, suggest: лэндингах) 2. саша (76:1, en: c***, ru: *аша, suggest: Саша) Capitalization: 1 1. лёша (suggest: Лёша) -----

После этих шагов текст будет готов к публикации в любую социальную сеть или сайт. Для меня было открытием, что телеграмм понимает различные символы, которые улучшают читабельность текста. Например, неразрывные пробелы, которые спасают от висячих предлогов — nbsp в HTML. Часто можно встретить, когда копируешь текст из фигмы. Сделать красивые текста — одна из обязанностей дизайнера.

Можно пойти дальше и использовать инструменты не только для постов, но и для вёрстки сайтов. Статичный текст тяжело найти на более-менее сложном сайте, а вот на лэндингах вполне. Дизайнер будет доволен. Пока нашел только плагин для Gulp.

Осталось найти CLI для проверки пунктуации. Если знаете такой — делитесь в комментариях.

Лайфхак для тех, кто хочет делать вклад в open source, но не знает с чего начать. Возьмите эти инструменты и прогоните документацию вашего любимого проекта через них. Я в своё время так контрибьютил в MDN (раз, два, три, четыре), Slidev (раз) и учебник Ильи Кантора (тут многовато).

После принятия пул реквеста у вас в профиле будет плашка с этой организацией на целый год. Приятно же постоянно видеть, что ты контрибьютил в React? А как удивится человек, который будет смотреть ваше резюме? 😉