You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
165 lines
5.2 KiB
165 lines
5.2 KiB
2 years ago
|
# PostCSS HTML Syntax
|
||
|
|
|
||
|
|
[](https://www.npmjs.com/package/postcss-html)
|
||
|
|
[](https://www.npmjs.com/package/postcss-html)
|
||
|
|
[](http://www.npmtrends.com/postcss-html)
|
||
|
|
[](http://www.npmtrends.com/postcss-html)
|
||
|
|
[](http://www.npmtrends.com/postcss-html)
|
||
|
|
[](https://github.com/ota-meshi/postcss-html/actions?query=workflow%3ACI)
|
||
|
|
|
||
|
|
<img align="right" width="95" height="95"
|
||
|
|
title="Philosopher’s stone, logo of PostCSS"
|
||
|
|
src="http://postcss.github.io/postcss/logo.svg">
|
||
|
|
|
||
|
|
[PostCSS](https://github.com/postcss/postcss) syntax for parsing HTML (and HTML-like)
|
||
|
|
|
||
|
|
- [Vue Single-File Components](https://vuejs.org/guide/scaling-up/sfc.html)
|
||
|
|
- [Svelte Components](https://svelte.dev/docs#component-format)
|
||
|
|
- [Astro Components](https://docs.astro.build/core-concepts/astro-components/)
|
||
|
|
- [PHP](http://php.net)
|
||
|
|
- [Quick App](https://doc.quickapp.cn/framework/source-file.html)
|
||
|
|
- [XSLT](https://www.w3.org/TR/xslt-30/)
|
||
|
|
|
||
|
|
## Getting Started
|
||
|
|
|
||
|
|
First thing's first, install the module:
|
||
|
|
|
||
|
|
```bash
|
||
|
|
npm install postcss-html --save-dev
|
||
|
|
```
|
||
|
|
|
||
|
|
If you want support SCSS/SASS/LESS/SugarSS syntax, you need to install the corresponding module.
|
||
|
|
|
||
|
|
- SCSS: [postcss-scss](https://github.com/postcss/postcss-scss)
|
||
|
|
- SASS: [postcss-sass](https://github.com/aleshaoleg/postcss-sass)
|
||
|
|
- LESS: [postcss-less](https://github.com/shellscape/postcss-less)
|
||
|
|
- SugarSS: [sugarss](https://github.com/postcss/sugarss)
|
||
|
|
- Stylus: [postcss-styl](https://github.com/ota-meshi/postcss-styl)
|
||
|
|
|
||
|
|
## Use Cases
|
||
|
|
|
||
|
|
```js
|
||
|
|
const postcss = require('postcss');
|
||
|
|
const syntax = require('postcss-html')({
|
||
|
|
// syntax for parse scss (non-required options)
|
||
|
|
scss: require('postcss-scss'),
|
||
|
|
// syntax for parse less (non-required options)
|
||
|
|
less: require('postcss-less'),
|
||
|
|
// syntax for parse css blocks (non-required options)
|
||
|
|
css: require('postcss-safe-parser'),
|
||
|
|
});
|
||
|
|
postcss(plugins).process(source, { syntax: syntax }).then(function (result) {
|
||
|
|
// An alias for the result.css property. Use it with syntaxes that generate non-CSS output.
|
||
|
|
result.content
|
||
|
|
});
|
||
|
|
```
|
||
|
|
|
||
|
|
If you want support SCSS/SASS/LESS/SugarSS syntax, you need to install these module:
|
||
|
|
|
||
|
|
- SCSS: [postcss-scss](https://github.com/postcss/postcss-scss)
|
||
|
|
- SASS: [postcss-sass](https://github.com/aleshaoleg/postcss-sass)
|
||
|
|
- LESS: [postcss-less](https://github.com/shellscape/postcss-less)
|
||
|
|
- SugarSS: [sugarss](https://github.com/postcss/sugarss)
|
||
|
|
- Stylus: [postcss-styl](https://github.com/ota-meshi/postcss-styl)
|
||
|
|
|
||
|
|
## Advanced Use Cases
|
||
|
|
|
||
|
|
### Options
|
||
|
|
|
||
|
|
```js
|
||
|
|
const options = {
|
||
|
|
rules: [
|
||
|
|
{
|
||
|
|
// custom language
|
||
|
|
test: /^postcss$/i,
|
||
|
|
lang: 'scss'
|
||
|
|
},
|
||
|
|
{
|
||
|
|
// custom language
|
||
|
|
test: /^customcss$/i,
|
||
|
|
lang: 'custom'
|
||
|
|
},
|
||
|
|
],
|
||
|
|
|
||
|
|
// custom parser for CSS (using `postcss-safe-parser`)
|
||
|
|
css: 'postcss-safe-parser',
|
||
|
|
// custom parser for SASS (PostCSS-compatible syntax.)
|
||
|
|
sass: require('postcss-sass'),
|
||
|
|
// custom parser for SCSS (by module name)
|
||
|
|
scss: 'postcss-scss',
|
||
|
|
// custom parser for LESS (by module path)
|
||
|
|
less: require.resolve('./node_modules/postcss-less'),
|
||
|
|
// custom parser for SugarSS
|
||
|
|
sugarss: require('sugarss'),
|
||
|
|
// custom parser for custom language
|
||
|
|
custom: require('postcss-custom-syntax'),
|
||
|
|
}
|
||
|
|
const syntax = require('postcss-html')(options);
|
||
|
|
```
|
||
|
|
|
||
|
|
## Turning PostCSS off from within your HTML
|
||
|
|
|
||
|
|
PostCSS can be temporarily turned off by using special comments in your HTML. For example:
|
||
|
|
|
||
|
|
```html
|
||
|
|
<html>
|
||
|
|
<body>
|
||
|
|
<!-- postcss-ignore -->
|
||
|
|
<a style="color: red;" description="style is not parsed."></a>
|
||
|
|
|
||
|
|
<a style="color: red;" description="style is parsed."></a>
|
||
|
|
```
|
||
|
|
|
||
|
|
```html
|
||
|
|
<html>
|
||
|
|
<body>
|
||
|
|
<!-- postcss-disable -->
|
||
|
|
<a style="color: red;" description="style is not parsed."></a>
|
||
|
|
<a style="color: red;" description="style is not parsed."></a>
|
||
|
|
<!-- postcss-enable -->
|
||
|
|
|
||
|
|
<a style="color: red;" description="style is parsed."></a>
|
||
|
|
```
|
||
|
|
|
||
|
|
## Linting with Stylelint
|
||
|
|
|
||
|
|
The main use case of this plugin is to apply linting with [Stylelint] to `<style>` tags and `<div style="*">` property in HTML (and HTML-like).
|
||
|
|
|
||
|
|
You can use it by configuring your `stylelint` config as follows:
|
||
|
|
|
||
|
|
```json
|
||
|
|
{
|
||
|
|
"overrides": [
|
||
|
|
{
|
||
|
|
"files": ["*.html", "**/*.html"],
|
||
|
|
"customSyntax": "postcss-html"
|
||
|
|
}
|
||
|
|
]
|
||
|
|
}
|
||
|
|
```
|
||
|
|
|
||
|
|
You can use it more easily if you use an already configured sharable config.
|
||
|
|
|
||
|
|
```diff
|
||
|
|
{
|
||
|
|
+ "extends": [
|
||
|
|
+ "stylelint-config-html",
|
||
|
|
// If you are using Vue.
|
||
|
|
+ "stylelint-config-recommended-vue"
|
||
|
|
+ ],
|
||
|
|
- "overrides": [
|
||
|
|
- {
|
||
|
|
- "files": ["*.html", "**/*.html"],
|
||
|
|
- "customSyntax": "postcss-html"
|
||
|
|
- }
|
||
|
|
- ]
|
||
|
|
}
|
||
|
|
```
|
||
|
|
|
||
|
|
- [stylelint-config-html]
|
||
|
|
- [stylelint-config-recommended-vue]
|
||
|
|
|
||
|
|
[Stylelint]: https://stylelint.io/
|
||
|
|
[stylelint-config-html]: https://github.com/ota-meshi/stylelint-config-html
|
||
|
|
[stylelint-config-recommended-vue]: https://github.com/ota-meshi/stylelint-config-recommended-vue
|