PostCSS is a tool for transforming styles with JS plugins. These plugins can lint your CSS, support variables and mixins, transpile future CSS syntax, inline images, and more.
PostCSS is used by industry leaders including Wikipedia, Twitter, Alibaba, and JetBrains. The Autoprefixer PostCSS plugin is one of the most popular CSS processors.
PostCSS takes a CSS file and provides an API to analyze and modify its rules (by transforming them into an Abstract Syntax Tree). This API can then be used by plugins to do a lot of useful things, e.g., to find errors automatically, or to insert vendor prefixes.
Support / Discussion: Gitter
Twitter account: @postcss
VK.com page: postcss
中文翻译: docs/README-cn.md
For PostCSS commercial support (consulting, improving the front-end culture of your company, PostCSS plugins), contact Evil Martians at [email protected].
Sponsorship
PostCSS needs your support. We are accepting donations at Open Collective.
Plugins
Currently, PostCSS has more than 200 plugins. You can find all of the plugins in the plugins list or in the searchable catalog. Below is a list of our favorite plugins — the best demonstrations of what can be built on top of PostCSS.
If you have any new ideas, PostCSS plugin development is really easy.
Solve Global CSS Problem
postcss-use
allows you to explicitly set PostCSS plugins within CSS and execute them only for the current file.postcss-modules
andreact-css-modules
automatically isolate selectors within components.postcss-autoreset
is an alternative to using a global reset that is better for isolatable components.postcss-initial
addsall: initial
support, which resets all inherited styles.cq-prolyfill
adds container query support, allowing styles that respond to the width of the parent.
Use Future CSS, Today
autoprefixer
adds vendor prefixes, using data from Can I Use.postcss-preset-env
allows you to use future CSS features today.
Better CSS Readability
postcss-nested
unwraps nested rules the way Sass does.postcss-sorting
sorts the content of rules and at-rules.postcss-utilities
includes the most commonly used shortcuts and helpers.short
adds and extends numerous shorthand properties.
Images and Fonts
postcss-assets
inserts image dimensions and inlines files.postcss-sprites
generates image sprites.font-magician
generates all the@font-face
rules needed in CSS.postcss-inline-svg
allows you to inline SVG and customize its styles.postcss-write-svg
allows you to write simple SVG directly in your CSS.webp-in-css
to use WebP image format in CSS background.avif-in-css
to use AVIF image format in CSS background.
Linters
stylelint
is a modular stylesheet linter.stylefmt
is a tool that automatically formats CSS accordingstylelint
rules.doiuse
lints CSS for browser support, using data from Can I Use.colorguard
helps you maintain a consistent color palette.
Other
postcss-rtl
combines both-directional (left-to-right and right-to-left) styles in one CSS file.cssnano
is a modular CSS minifier.lost
is a feature-richcalc()
grid system.rtlcss
mirrors styles for right-to-left locales.
Syntaxes
PostCSS can transform styles in any syntax, not just CSS. If there is not yet support for your favorite syntax, you can write a parser and/or stringifier to extend PostCSS.
sugarss
is a indent-based syntax like Sass or Stylus.postcss-syntax
switch syntax automatically by file extensions.postcss-html
parsing styles in<style>
tags of HTML-like files.postcss-markdown
parsing styles in code blocks of Markdown files.postcss-jsx
parsing CSS in template / object literals of source files.postcss-styled
parsing CSS in template literals of source files.postcss-scss
allows you to work with SCSS (but does not compile SCSS to CSS).postcss-sass
allows you to work with Sass (but does not compile Sass to CSS).postcss-less
allows you to work with Less (but does not compile LESS to CSS).postcss-less-engine
allows you to work with Less (and DOES compile LESS to CSS using true Less.js evaluation).postcss-js
allows you to write styles in JS or transform React Inline Styles, Radium or JSS.postcss-safe-parser
finds and fixes CSS syntax errors.midas
converts a CSS string to highlighted HTML.
Articles
- Some things you may think about PostCSS… and you might be wrong
- What PostCSS Really Is; What It Really Does
- PostCSS Guides
More articles and videos you can find on awesome-postcss list.
Books
- Mastering PostCSS for Web Design by Alex Libby, Packt. (June 2016)
Usage
You can start using PostCSS in just two steps:
- Find and add PostCSS extensions for your build tool.
- Select plugins and add them to your PostCSS process.
CSS-in-JS
The best way to use PostCSS with CSS-in-JS is astroturf
. Add its loader to your webpack.config.js
:
module.exports = {
module: {
rules: [
{
test: /\.css$/,
use: ['style-loader', 'postcss-loader'],
},
{
test: /\.jsx?$/,
use: ['babel-loader', 'astroturf/loader'],
}
]
}
}
Then create postcss.config.js
:
module.exports = {
plugins: [
require('autoprefixer'),
require('postcss-nested')
]
}
Parcel
Parcel has built-in PostCSS support. It already uses Autoprefixer and cssnano. If you want to change plugins, create postcss.config.js
in project’s root:
module.exports = {
plugins: [
require('autoprefixer'),
require('postcss-nested')
]
}
Parcel will even automatically install these plugins for you.
Please, be aware of the several issues in Version 1. Notice, Version 2 may resolve the issues via issue #2157.
Webpack
Use postcss-loader
in webpack.config.js
:
module.exports = {
module: {
rules: [
{
test: /\.css$/,
exclude: /node_modules/,
use: [
{
loader: 'style-loader',
},
{
loader: 'css-loader',
options: {
importLoaders: 1,
}
},
{
loader: 'postcss-loader'
}
]
}
]
}
}
Then create postcss.config.js
:
module.exports = {
plugins: [
require('autoprefixer'),
require('postcss-nested')
]
}
Gulp
Use gulp-postcss
and gulp-sourcemaps
.
gulp.task('css', () => {
const postcss = require('gulp-postcss')
const sourcemaps = require('gulp-sourcemaps')
return gulp.src('src/**/*.css')
.pipe( sourcemaps.init() )
.pipe( postcss([ require('autoprefixer'), require('postcss-nested') ]) )
.pipe( sourcemaps.write('.') )
.pipe( gulp.dest('build/') )
})
npm Scripts
To use PostCSS from your command-line interface or with npm scripts there is postcss-cli
.
postcss --use autoprefixer -o main.css css/*.css
Browser
If you want to compile CSS string in browser (for instance, in live edit tools like CodePen), just use Browserify or webpack. They will pack PostCSS and plugins files into a single file.
To apply PostCSS plugins to React Inline Styles, JSS, Radium and other CSS-in-JS, you can use postcss-js
and transforms style objects.
const postcss = require('postcss-js')
const prefixer = postcss.sync([ require('autoprefixer') ])
prefixer({ display: 'flex' }) //=> { display: ['-webkit-box', '-webkit-flex', '-ms-flexbox', 'flex'] }
Deno
PostCSS also supports Deno:
import postcss from 'https://deno.land/x/postcss/mod.js'
import autoprefixer from 'https://jspm.dev/autoprefixer'
const result = await postcss([autoprefixer]).process(css)
Runners
- Grunt:
@lodder/grunt-postcss
- HTML:
posthtml-postcss
- Stylus:
poststylus
- Rollup:
rollup-plugin-postcss
- Brunch:
postcss-brunch
- Broccoli:
broccoli-postcss
- Meteor:
postcss
- ENB:
enb-postcss
- Taskr:
taskr-postcss
- Start:
start-postcss
- Connect/Express:
postcss-middleware
- Svelte Preprocessor:
svelte-preprocess
JS API
For other environments, you can use the JS API:
const autoprefixer = require('autoprefixer')
const postcss = require('postcss')
const postcssNested = require('postcss-nested')
const fs = require('fs')
fs.readFile('src/app.css', (err, css) => {
postcss([autoprefixer, postcssNested])
.process(css, { from: 'src/app.css', to: 'dest/app.css' })
.then(result => {
fs.writeFile('dest/app.css', result.css, () => true)
if ( result.map ) {
fs.writeFile('dest/app.css.map', result.map.toString(), () => true)
}
})
})
Read the PostCSS API documentation for more details about the JS API.
All PostCSS runners should pass PostCSS Runner Guidelines.
Options
Most PostCSS runners accept two parameters:
- An array of plugins.
- An object of options.
Common options:
syntax
: an object providing a syntax parser and a stringifier.parser
: a special syntax parser (for example, SCSS).stringifier
: a special syntax output generator (for example, Midas).map
: source map options.from
: the input file name (most runners set it automatically).to
: the output file name (most runners set it automatically).
Treat Warnings as Errors
In some situations it might be helpful to fail the build on any warning from PostCSS or one of its plugins. This guarantees that no warnings go unnoticed, and helps to avoid bugs. While there is no option to enable treating warnings as errors, it can easily be done by adding postcss-fail-on-warn
plugin in the end of PostCSS plugins:
module.exports = {
plugins: [
require('autoprefixer'),
require('postcss-fail-on-warn')
]
}
Editors & IDE Integration
VS Code
mhmadhamster.postcss-language
adds PostCSS and SugarSS support.
Atom
language-postcss
adds PostCSS and SugarSS highlight.source-preview-postcss
previews your output CSS in a separate, live pane.
Sublime Text
Syntax-highlighting-for-PostCSS
adds PostCSS highlight.
Vim
postcss.vim
adds PostCSS highlight.
WebStorm
To get support for PostCSS in WebStorm and other JetBrains IDEs you need to install this plugin.
Security Contact
To report a security vulnerability, please use the Tidelift security contact. Tidelift will coordinate the fix and disclosure.
For Enterprise
Available as part of the Tidelift Subscription.
The maintainers of postcss
and thousands of other packages are working with Tidelift to deliver commercial support and maintenance for the open source dependencies you use to build your applications. Save time, reduce risk, and improve code health, while paying the maintainers of the exact dependencies you use. Learn more.
Common configs
I just read the thread about the upcoming Babel 6.0 https://github.com/babel/babel/issues/2168
tl;dr: Instead of being something similar to cssnext, Babel will become an engine, like PostCSS.
I think this is a really nice road. PostCSS is already on it, so it's awesome. I was trying hard to make cssnext THE solution, but I guess I failed, people like modularity (and don't care that much about standard). cssnext has too many problem to handle with potential specs changes (that's why Babel is moving from a solution with many transformers to none).
The idea of preset for Babel seems really the way to go ("preset-es2015" :heart:). The thing is, cssnext can't do that, because csswg is working on different modules. So I guess it's time to think about deprecating cssnext. The thing I love in both cssnext and babel is that they have a cli builtin and an easy management for conf (.babelrc, I am currently working on .cssnextrc - but I am not sure I should finish my work). What I am offering here (and really think it will be just awesome for PostCSS) is to bring you back my work to easily add a CLI builtin + a .postcssrc. Direct benefits are:
This will not require a lot of code in postcss because work is already done as separate module (or will be in a couple of days):
module.exports = {/_config*/}
like webpack, very nice to configure plugins) https://github.com/MoOx/rc-loaderDiscussion is open !
SugarSS syntax
Many users asked about some compact syntax like Sass or Styles. In PostCSS 5.0 we can make it, it is good time to find the best compact syntax.
My requirements:
;
.Mixin plugins
What mixin plugins we should add for PostCSS?
Sass like syntax (will be very important for ex-Sass users):
Stylus (better CSS syntax support, but you didn’t know where you have mixin and where you have some new property):
/cc @yisibl @MoOx @morishitter
CLI API?
I'm not finding much in the way of a CLI API, but I'd like to. Goal: to use PostCSS straight from NPM. http://blog.keithcirkel.co.uk/how-to-use-npm-as-a-build-tool/
DeprecationWarning: Use of deprecated folder mapping "./" in the "exports" field module resolution of the package at G:\SNWS\sn-micro-front-web-project-template\node_modules\postcss\package.json.
This is not a error!!!
operating system: Windows 10, node: 15.1.0, npm: 6.14.8, webpack: 5.4.0, postcss: 8.1.4
This is only a warning issued by "nodejs". It is recommended to make corrections according to the warning, because some writing methods are not recommended.
Custom parsers
// one line comment
.;
(and maybe with one line comment).Maybe we should allow PostCSS to change parsers:
All parser should return same AST, but them can parse any syntax.
/cc @lydell @MoOx @rvanes
Request for Autoloading Plugins as a Core Functionality
Hi, is there some interest in making it possible for postcss to auto-load plugins based on a config obj either inline, from a separate js | json file or a section in pkg.json (e.g pkg.postcss)?
The plugin names are written without the
postcss-
prefix and hyphen delimited names should be written in camelCase. The postition in the plugins array is determined by the plugins[i].key e.g => [plugin1(), plugin2(), pluginName3()]. In other words it matters in which order you declare your options ;).Inline (not that useful, but for demonstration)
plugins.js
plugins.json
package.json
The way it which it's handled at the moment is not affected in anyways. It's just an attempt to make it possible to pass an obj or string directly to the loader API and then plugin requires and array scaffolding is handled in core.
Plugin Guidelines discussion
Here is a current draft of PostCSS Plugin Guidelines. I just finish first version of draft and totally open for any feedback. What we should add, remove, change?
This document is only for mandatory rules. We will have separated document for Best Practices (like “try to use W3C draft instead of own syntax”).
I think my draft contains too any grammar mistakes. Let’s fix them after we will fix document content.
This rules will be mandatory for all plugin developers. Speak now or forever hold your peace.
/cc @MoOx @ben-eb @yisibl @morishitter @davidtheclark @antyakushev @btholt @magsout @corysimmons @jo-asakura @simonsmith @pascalduez @iamvdo @geddski
Improve source maps API
I have some ideas for the source maps API that will:
I propose:
options.map
:false
. (Like now.)false
→ don’t generate source map. (Like now.)true
→ equivalent to{}
.map: sassMap
. But allow it until it is removed.map.annotation
:'preserve'
.'preserve'
→ Use same annotation type as input. (LikemapAnnotation: true
now.)'none'
→ No annotation. (LikemapAnnotation: false
now.)'inline'
→ Inline the source map into the annotation. (LikeinlineMap: true
now.)'path'
→ Usemap.path
as annotation. (New feature, though kind of possible now, too, at least partly…)map.path
:options.to + '.map'
. (This is actually the current behavior, more or less: We always assume that the source map will either be saved next to the CSS, or inlined into the CSS.)options.to
.opitons.to
ifmap.annotation
is'inline'
, or ifmap.annotation
is'preserve'
and the previous annotation had the previous source map inlined.map.setSourceContents
:false
.false
→ Don’ set thesourceContents
property of the source map. (Like now.)true
→ Set thesourceContents
property to the input CSS. (New feature, as requested by #31.)map.sourceRoot
:sourceRoot
property of the source map. (Like now.)sourceRoot
property of the source map tomap.sourceRoot
. (New feature. It is very easy to add (new mozilla.SourceMapGenerator({sourceRoot: options.map.sourceRoot})
), but YAGNI?)map.previous
:map: sassMap
, for example. However, does anyone use this? YAGNI?null
(or possiblytrue
).null
→ Simply no previous source map.false
→ Disable previous source map detection, but still generate a source map. If so:true
→ Autodetect previous source map (Like now.) YAGNI?previous.map
:options.previous
to its default value (null
or possiblytrue
; see above).map: sassMap
now.previous.path
:'.'
.options.map.path
.previous.map = {map: previous.map}
. (Likemap: sassMap
now.)map.previous
be a previous source map (nothing more) and don’t care if it is not perfect.options.mapAnnotation
. Until it is removed:false
→options.map.annotation = 'none'
(unlessoptions.map.annotation
was already set).true
→options.map.annotation = 'preserve'
(unlessoptions.map.annotation
was already set).options.inlineMap
. Until it is removed:false
→ Nothing to do.true
→options.map.annotation = 'inline'
(unlessoptions.map.annotation
was already set).options.from + '.map'
. I don’t think that case exists in reality. The user could possibly passfrom: from, map: {previous: {map: fs.readFileSync(from + '.map'), path: from + '.map'}}
instead.What do you think? I could make a PR.
Event based API
Right now PostCSS behavior depends on plugin order.
For example, if you put postcss-siple-vars before postcss-mixin, it will broke mixins.
@1j01 told about same problem with functions.
And potentially we may have a loop problem. We need to find solution.
Import Plugin
Right now we have a some mess in
@import
plugins:postcss-import
doesn’t provide out-of-box solution for most of developers and still looking a maintaier.postcss-easy-import
has more features, but base on top of frozenpostcss-import
postcss-partial-import
is good, but has not all of user request’s features.Right now I am a fan of
postcss-smart-import
, because it has active development and has a lot of features.Anyway, right now we have a UX problem, because new PostCSS users doesn’t know what to add and have many problems with
@import
. As result they become disappointment of entire PostCSS ecosystem (“plugins hell”, “bad support”) and leave it.I think that we should choice one plugin and deprecate others one. We could move some missed features to winner plugin. Maybe we should also rename winner plugin to
postcss-import
.@MoOx @TrySound @jonathantneal @swernerx what do you think?
How to use `postcss.parse` with plugins
Hi,
I've had a hard time finding this:
Or how to use
.parse
with plugins.Maybe you should document it. I opened this issue to help whoever is looking for it.
Closing now because not an issue.
Make types of various `raws` properties consistent
Different types of nodes specify different (mostly optional) properties on
raws
. If there's truly nothing that can be guaranteed about raws, it probably makes more sense to just have all node types useany
, but if not, it probably makes sense to have a common interface defining each property that the default CSS parser uses.Consider adding an AnyContainer type to allow narrowing
Similar to the
AnyNode
type, there should be anAnyContainer
type that allows you to narrow it to a specific type of container.The definition would probably look something like:
Node.before() inserts after if the new node is already a sibling
Test case:
It looks like the index calculation gets stale once the new node is removed from its original location.
Document how to declare a PostCSS plugin in an ES6/TypeScript module
It's currently unclear how to properly declare a PostCSS module using ES6 module syntax (which TypeScript also uses idiomatically). The suggested
module.exports
isn't idiomatic in these systems.