peach a19a732be8 commit message 2 jaren geleden
..
LICENSE a19a732be8 commit message 2 jaren geleden
README.md a19a732be8 commit message 2 jaren geleden
html.js a19a732be8 commit message 2 jaren geleden
index.js a19a732be8 commit message 2 jaren geleden
package.json a19a732be8 commit message 2 jaren geleden
php.js a19a732be8 commit message 2 jaren geleden
svelte.js a19a732be8 commit message 2 jaren geleden
vue.js a19a732be8 commit message 2 jaren geleden
xml.js a19a732be8 commit message 2 jaren geleden

README.md

stylelint-config-html

NPM license NPM version NPM downloads NPM downloads Build Status

The shareable HTML (and HTML-like) config for Stylelint.

This config bundles the postcss-html custom syntax and configures it.
If you use this config in your Stylelint config, HTML, XML, Vue, Svelte and PHP files will be parsable. The Stylelint rules you have configured will be able to check these files.

Requirements

  • Stylelint v14.0.0 and above
    This config cannot be used with Stylelint v13 and below. Also, if you are using Stylelint v13, you do not need to use this config.

Stylelint v14 and above has been changed to not bundle non-CSS parsing such as HTML. The goal of this config is to make Stylelint v14 work with HTML (and HTML-like) files, like Stylelint v13.

To see this config, please read the config itself.

:couple: Related Packages

stylelint-config-recommended-vue

The recommended shareable Vue config.
If you want to check Vue files, consider using this as well. It is useful because it contains the config for Vue.

postcss-html

PostCSS syntax for parsing HTML (and HTML-like).
If you have problems with parses using this config, please open the new issue in that repository.

:cd: Installation

npm install --save-dev postcss-html stylelint-config-html

:book: Usage

Set your stylelint config to:

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

Note: This config enables HTML (and HTML-like) syntax parsing.

If you want to enable parsing for only specific language, use each language config as follows:

{
  "extends": [
    "stylelint-config-html/html",
    "stylelint-config-html/xml",
    "stylelint-config-html/vue",
    "stylelint-config-html/svelte",
    "stylelint-config-html/php"
  ]
}

:lock: License

See the LICENSE file for license rights and limitations (MIT).