Skip to content
This repository has been archived by the owner on May 31, 2019. It is now read-only.

Найти и прикрутить линтер для Маркдауна #61

Open
1 of 2 tasks
pepelsbey opened this issue Jan 17, 2019 · 8 comments · May be fixed by #94
Open
1 of 2 tasks

Найти и прикрутить линтер для Маркдауна #61

pepelsbey opened this issue Jan 17, 2019 · 8 comments · May be fixed by #94
Labels
В работе Задача в работу, можете предложить помощь Помогите Исполнитель задачи ищет помощи

Comments

@pepelsbey
Copy link
Member

pepelsbey commented Jan 17, 2019

  • Найти линтер и правила к нему
  • Прикрутить проверку на пре-что-нибудь и к тестам

Например, хотелось бы, чтобы списки шли всегда только так:

- Item
- Item
- Item

А не

* Item

* Item

* Item

И чтобы для курсива всегда был _italic_, а не *italic*. Ну и ещё какие-то мелочи, наверное.

@b0gok
Copy link

b0gok commented Jan 17, 2019

Предлагаю использовать remark-lint.
Список доступных правил.
Есть готовый пресет по умолчанию.

@pepelsbey
Copy link
Member Author

pepelsbey commented Jan 17, 2019

Вариант :) Если интересно заняться, то давайте заведём это в отдельной ветке пулреквеста и там уже поймём какой список правил нужен. Можно начать с пресета и посмотреть на ошибки. Фикс там есть?

@pepelsbey pepelsbey added the В работе Задача в работу, можете предложить помощь label Jan 17, 2019
@b0gok
Copy link

b0gok commented Jan 17, 2019

Ок, попробую вечером разобраться как это работает. Насколько я понимаю, автофикс есть.

@ishpagin
Copy link
Contributor

ishpagin commented Jan 19, 2019

Нужно разрешить inline HTML для переноса строки с помощью <br>

@FFxSquall
Copy link
Contributor

@b0gok Нужна какая-нибудь помощь? Или просто пока руки не дошли?

@FFxSquall
Copy link
Contributor

@pepelsbey Кстати в remark-lint есть пресет который построен на базе Markdown Style Guide, там вроде вполне разумные правила, разе что для italic используются *. Но его поднастроить под себя можно если большенство правил подходит.

@b0gok
Copy link

b0gok commented Jan 25, 2019

@FFxSquall всё хорошо кроме того, что при фиксе у меня не учитываются настройки из конфига по непонятной мне пока причине. Особо это бесит в плане настройки rule, который по умолчанию *, а не -. Но, я думаю, в воскресение я с этим разберусь.

На текущий момент конфиг у меня выглядит таким образом (расписал правила из пресетов в отдельные, чтобы было понятнее как что отрабатывает)

.remarkrc.js

module.exports = {
    settings: {
        fences: false,
        bullet: '-',
        listItemIndent: '1',
        incrementListMarker: true,
        rule: '-',
        ruleRepetition: 3,
        ruleSpaces: false,
        strong: '*',
        emphasis: '_'
    },
    plugins: {
        'remark-lint-blockquote-indentation': ['error', 2],
        'remark-lint-code-block-style': ['error', 'indented'],
        'remark-lint-emphasis-marker': ['error', '_'],
        'remark-lint-final-newline': ['error'],
        'remark-lint-hard-break-spaces': ['error'],
        'remark-lint-link-title-style': ['error', '"'],
        'remark-lint-list-item-bullet-indent': ['error'],
        'remark-lint-list-item-content-indent': ['error'],
        'remark-lint-list-item-indent': ['error', 'space'],
        'remark-lint-no-auto-link-without-protocol': ['error'],
        'remark-lint-no-blockquote-without-marker': ['error'],
        'remark-lint-no-duplicate-definitions': ['error'],
        'remark-lint-no-heading-content-indent': ['error'],
        'remark-lint-no-inline-padding': ['error'],
        'remark-lint-no-shortcut-reference-image': ['error'],
        'remark-lint-no-shortcut-reference-link': ['error'],
        'remark-lint-no-undefined-references': ['error'],
        'remark-lint-no-unused-definitions': ['error'],
        'remark-lint-ordered-list-marker-style': ['error', '.'],
        'remark-lint-ordered-list-marker-value': ['error', 'ordered'],
        'remark-lint-rule-style': ['error', '---'],
        'remark-lint-strong-marker': ['error', '*'],
        'remark-lint-unordered-list-marker-style': ['error', '-']
    }
};

@pepelsbey
Copy link
Member Author

pepelsbey commented Jan 25, 2019

Вот почему надо такое сразу в пулреквест, а в нём уже работать совместно.

Кидайте, разберёмся :)

@b0gok b0gok linked a pull request Jan 26, 2019 that will close this issue
1 task
@pepelsbey pepelsbey added the Помогите Исполнитель задачи ищет помощи label Feb 21, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
В работе Задача в работу, можете предложить помощь Помогите Исполнитель задачи ищет помощи
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants