Install

1npm i -D postcss-load-plugins

Usage

npm i -S|-D postcss-plugin

Install plugins and save them to your package.json dependencies/devDependencies.

package.json

Create postcss section in your projects package.json.

App
  |– client
  |– public
  |
  |- package.json

1{
2  "postcss": {
3    "plugins": {
4      "postcss-plugin": {}
5    }
6  }
7}

.postcssrc

Create a .postcssrc file.

App
  |– client
  |– public
  |
  |- (.postcssrc|.postcssrc.json|.postcssrc.yaml)
  |- package.json

JSON

1{
2  "plugins": {
3    "postcss-plugin": {}
4  }
5}

YAML

1plugins:
2  postcss-plugin: {}

postcss.config.js or .postcssrc.js

You may need some JavaScript logic to generate your config. For this case you can use a file named postcss.config.js or .postcssrc.js.

App
  |– client
  |– public
  |
  |- (postcss.config.js|.postcssrc.js)
  |- package.json

Plugins can be loaded in either using an {Object} or an {Array}.

{Object}

1module.exports = (ctx) => ({
2  plugins: {
3    'postcss-plugin': ctx.plugin
4  }
5})

{Array}

1module.exports = (ctx) => ({
2  plugins: [
3    require('postcss-plugin')(ctx.plugin)
4  ]
5})

Options

Plugin options can take the following values.

{}: Plugin loads with defaults

1'postcss-plugin': {} || null

:warning: {} must be an empty object

{Object}: Plugin loads with options

1'postcss-plugin': { option: '', option: '' }

false: Plugin will not be loaded

1'postcss-plugin': false

Order

Plugin order is determined by declaration in the plugins section.

1{
2  plugins: {
3    'postcss-plugin': {}, // plugins[0]
4    'postcss-plugin': {}, // plugins[1]
5    'postcss-plugin': {}  // plugins[2]
6  }
7}

Context

When using a function (postcss.config.js), it is possible to pass context to postcss-load-plugins, which will be evaluated before loading your plugins. By default ctx.env (process.env.NODE_ENV) and ctx.cwd (process.cwd()) are available.

Examples

postcss.config.js

1module.exports = (ctx) => ({
2  plugins: {
3    postcss-import: {},
4    postcss-modules: ctx.modules ? {} : false,
5    cssnano: ctx.env === 'production' ? {} : false
6  }
7})

1const { readFileSync } = require('fs')
2
3const postcss = require('postcss')
4const pluginsrc = require('postcss-load-plugins')
5
6const css = readFileSync('index.css', 'utf8')
7
8const ctx = { modules: true }
9
10pluginsrc(ctx).then((plugins) => {
11  postcss(plugins)
12    .process(css)
13    .then((result) => console.log(result.css))
14})

Maintainers

Michael Ciniawsky

Mateusz Derks

Contributors

Diogo Franco