Как игнорировать файлы для ремарки?

remark-lint — это линтер Markdown, написанный на JS. Если предлагает хороший набор правил. Этот инструмент также используется Codacy для проверки загруженных репозиториев на наличие предупреждений и ошибок.

Мой репозиторий содержит лицензию Apache в формате Markdown, но, к сожалению, авторы лицензии не проконсультировались и не проверили редактор на наличие типографских ошибок, таких как отсутствие точки после заголовка (потому что это не предложение!). Во всяком случае, comment-lint теперь жалуется, но если я изменю документ, это больше не лицензия Apache. (См. обсуждения с инструментами определения лицензий, например, используемыми GitHub. Они отказываются от идентичности файла Markdown.)

У меня вопрос: как настроить comment-lint для игнорирования файлов или лучше для игнорирования правил для каждого файла/каталога.

Я читал о:

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


person Paebbels    schedule 05.09.2020    source источник


Ответы (1)


Поскольку remark-lint — это плагин для заметок, он использует те же файлы конфигурации:

comment-lint — это подключаемый модуль remark, который при использовании в интерфейсе командной строки поддерживает настройку через его файлы конфигурации

Один из файлов конфигурации ремарки — .remarkignore. Я думаю, что файл .remarkignore, содержащий что-то вроде

path/to/license.md

or

path/to/license/directory/

будет делать свое дело.

Формат файлов игнорирования такой же, как у .gitignore.

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


Предостережение: обратите внимание на бит CLI в первой цитате выше. Если вы используете remark-lint через JavaScript API, это может не сработать.

person Chris    schedule 05.09.2020
comment
Из моих тестов: .remarkignore не читается ремаркой. - person Paebbels; 08.09.2020