documentation icon indicating copy to clipboard operation
documentation copied to clipboard

WEBSITE: Add linting of markdown

Open azinit opened this issue 4 years ago • 8 comments

Надзадача: #104

  • [ ] Пройтись форматированием
  • [ ] Добавить CI проверки
  • [ ] Указать необходимые экстеншены

В связи с тем, что скорее всего потом будет юзать экстеншены и возможно даже CI проверки image

Идея - от @karina-jovian

azinit avatar May 05 '21 12:05 azinit

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

Prettier под капотом использует remark. Думаю, можно его и напрямую подключать. Но с притиером, думаю, будет удобнее.

sarmong avatar Dec 21 '21 15:12 sarmong

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

Почему к плагину? тыц

Krakazybik avatar Dec 21 '21 15:12 Krakazybik

На мой взгляд, хорошая практика разделять линтер и форматтер в js коде. Линтер отвечает чисто за стиль и конвенции, а форматтер - за, эм, форматирование. Возможно, это же стоит делать и с маркдауном

sarmong avatar Dec 21 '21 15:12 sarmong

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

Привязываться и не обязательно, но можно указать для улучшения взаимодействия в докой 🤔

При этом такое должно линтиться по-хорошему, поэтому мб получится разрулить на уровне линта/преттира

Prettier под капотом использует remark. Думаю, можно его и напрямую подключать.

Да, надо бы глянуть) Просто тут еще сам md на валидность надо проверять (во многом по инициативе от @RinAkaia)

Поэтому возможно лучше посмотреть все же в сторону eslint, чтобы и в CI лучше было бы заложить сразу (чтобы не обязательно было экстеншен ставить)

azinit avatar Dec 22 '21 02:12 azinit

@RinAkaia что думаешь по этому всему?

azinit avatar Dec 22 '21 02:12 azinit

Поэтому возможно лучше посмотреть все же в сторону eslint, чтобы и в CI лучше было бы заложить сразу

В CI можно и prettier, и remark поставить

sarmong avatar Dec 22 '21 06:12 sarmong

В CI можно и prettier, и remark поставить

Да я понимаю, не стал это уточнять уж)

Тут же в целом еще речь про то - что в prettier вряд ли вшиты правила "валидации" md, помимо форматирования

А в этом пропозале имено это было важно

@RinAkaia надеюсь подскажет что-нить еще

azinit avatar Dec 22 '21 08:12 azinit

@RinAkaia что думаешь по этому всему?

Не уверена, что с форматтэром у нас не поломаются те места, где приходится использовать сторонний синтаксис для docusaurus

Мне кажется сейчас главное линтинг поднять, а остальное уже только в экспериментальном режиме

akaia-shadowfox avatar Dec 24 '21 02:12 akaia-shadowfox