Настройки для инструментов авторов профкурсов HTML Academy

Репозиторий решает в первую очередь задачи авторов HTML Academy и распространяется «как есть», без каких-либо гарантий или условий.

Собираем здесь конфиги для спеллеров и линтеров. Любое изменение вносится через пулреквест с как минимум одним апрувом от каждого направления курсов.

Установка

Перед установкой

Перед установкой пакета необходимо настроить npm, указав альтернативный источник пакетов — GitHub Packages.

Получение Personal Access Token ^{Справка ↗}

Для поиска и установки пакетов при создании токена необходимо выбрать область действия токена:

• read:packages

Если необходима возможность обновлять пакеты в дальнейшем, следует дополнительно выбрать область действия токена:

• write:packages

Аутентификация с использованием Personal Access Token ^{Справка ↗}

C помощью конфигурационных файлов:

• Создать файл .npmrc в домашней директории пользователя и добавить в него строку:

  //npm.pkg.github.com/:_authToken=TOKEN

• Создать файл .npmrc в директории репозитория и добавить в него строку:

  registry=https://npm.pkg.github.com/htmlacademy

С помощью инструментов командной строки npm:

• Воспользоваться командой npm login с флагом scope, который добавит к результатам поиска пакеты указанного разработчика из GitHub Packages:

  $ npm login --scope=@htmlacademy --registry=https://npm.pkg.github.com
  
  > Username: USERNAME
  > Password: TOKEN
  > Email: PUBLIC-EMAIL-ADDRESS

  Когда терминал запросит USERNAME, TOKEN и PUBLIC-EMAIL-ADDRESS — введите ваши значения.

npm install -DE @htmlacademy/configs

Возможности

EditorConfig

Настройки стиля кодирования для редактора. Для использования скопируйте файл .editorconfig в корень вашего проекта. Большая часть IDE подхватит файл автоматически, однако некоторые редакторы требуют установку плагина.

yaspeller

Ищет опечатки в материалах. Для настройки необходимо в своём репозитории указать путь к файлу конфигурации.

{
    "scripts": {
        "spellcheck": "yaspeller --config ./node_modules/@htmlacademy/configs/yaspeller.json ."
    }
}

При необходимости можно расширить базовый словарь в своём репе:

{
    "scripts": {
        "spellcheck": "yaspeller --config ./node_modules/@htmlacademy/configs/yaspeller.json --dictionary js-3-dictionary.json ."
    }
}

js-3-dictionary.json — дополняющий словарь из той же директории, где и package.json.

markdownlint-cli

CLI для линтера Markdown-файлов. Правит файлы в соответствии с конфигом .markdownlint.yml. Все правила линтера описаны в документации markdownlint. При необходимости можно настраивать правила или отключать ненужные.

Найдёт ошибки и выведет их в консоль:

{
    "scripts": {
        "markdownlint": "markdownlint --config ./node_modules/@htmlacademy/configs/.markdownlint.yml ."
    }
}

Автоматически исправит найденные ошибки:

{
    "scripts": {
        "markdownlint:fix": "markdownlint --fix --config ./node_modules/@htmlacademy/configs/.markdownlint.yml ."
    }
}