/stylelint-config-htmlacademy

HTML Academy Stylelint config

Primary LanguageCSSMIT LicenseMIT

stylelint-config-htmlacademy

Test Status License: MIT NPM version Vulnerabilities count

Это стандартный конфигурационный файл для stylelint от HTML Academy.

Используйте его как есть или как основу для вашей собственной конфигурации.

Установка

Вместе с конфигом установите и сам stylelint.

npm i -D stylelint-config-htmlacademy stylelint

Использование

В корне проекта создайте файл .stylelintrc и в нём добавьте stylelint-config-htmlacademy в поле extends.

.stylelintrc

{
  "extends": "stylelint-config-htmlacademy"
}

Если вы установили stylelint-config-htmlacademy глобально с помощью флага -g, тогда вам нужно использовать абсолютный путь stylelint-config-htmlacademy в конфигурационном файле:

.stylelintrc

{
  "extends": "/absolute/path/to/stylelint-config-htmlacademy"
}

Расширение конфига

Вы можете переопределить существующие правила или добавить новые.

Для этого добавьте в конфиг поле rules с нужными вам переопределениями правил.

.stylelintrc

{
  "extends": "stylelint-config-htmlacademy",
  "rules": {
    "property-no-unknown": [
      true,
      {
        "ignoreProperties": [
          "composes"
        ]
      }
    ],
    "unit-whitelist": ["em", "rem", "s", "px"]
  }
}

В этом же поле rules можно переопределять и больше не поддерживаемые самим Stylelint стилистические правила из плагина stylelint-codeguide, добавив перед названием правила префикс codeguide/.

.stylelintrc

{
  "extends": "stylelint-config-htmlacademy",
  "rules": {
    "property-no-unknown": [
      true,
      {
        "ignoreProperties": [
          "composes"
        ]
      }
    ],
    "unit-whitelist": ["em", "rem", "s", "px"],

    "codeguide/indentation": "tab",
    "codeguide/number-leading-zero": null
  }
}

Использование в VSCode

  1. Установите стайллинт и конфиг
  2. Откройте VScode
  3. Установите плагин stylelint
  4. Пользуйтесь

Несоответствия правилам конфига подчёркиваются красной волнистой линией, по наведению на которую появляется попап с описанием ошибки.