Посвящён проверке формата написания китайских файлов Markdown.

Проект использует подход Monorepo для управления, а в качестве инструмента управления несколькими проектами применяется Yarn.

Модули:

• ast-plugin: механизм плагина Ast;
• lint-md: основной модуль lint-md на Node;
• lint-md-cli: CLI-инструмент lint-md, удобный для использования и интеграции с CI.

Руководство по разработке:

1. Клонируйте репозиторий:

   git clone git@github.com:hustcc/lint-md.git
   cd lint-md
2. Установите:

   # Обязательно используйте Yarn для управления monorepo.
   yarn install
3. Протестируйте:

   cd ./packages/lint-md
   
   yarn run test
4. Соберите:

   yarn run build

Прочее:

• В проекте нет инструментов, связанных с ESLint, поэтому убедитесь, что код соответствует ветке;
• Прежде чем предлагать изменения в правилах (rule), создайте issue для обсуждения, чтобы избежать ненужной работы;
• Убедитесь, что покрытие модульных тестов составляет не менее 99%.