postcss-load-plugins

Load Plugins

Autoload Plugins for PostCSS

Install

npm 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

{
  "postcss": {
    "plugins": {
      "postcss-plugin": {}
    }
  }
}

.postcssrc

Create a .postcssrc file.

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

{
  "plugins": {
    "postcss-plugin": {}
  }
}

postcss.config.js

Create a postcss.config.js file.

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

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

{Object}

module.exports = (ctx) => {
  return {
    plugins: {
      'postcss-plugin': ctx.plugin
    }
  }
}

{Array}

module.exports = (ctx) => {
  return {
    plugins: [
      require('postcss-plugin')(ctx.plugin)
    ]
  }
}

Options

Plugin options can take the following values.

{}: Plugin loads with defaults

'postcss-plugin': {} || null

:warning: {} must be an empty object

{Object}: Plugin loads with options

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

false: Plugin will not be loaded

'postcss-plugin': false

Order

Plugin order is determined by declaration in the plugins section.

{
  plugins: {
    'postcss-plugin': {}, // plugins[0]
    'postcss-plugin': {}, // plugins[1]
    'postcss-plugin': {}  // plugins[2]
  }
}

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

module.exports = (ctx) => {
  return {
    plugins: {
      postcss-import: {},
      postcss-modules: ctx.modules ? {} : false,
      cssnano: ctx.env === 'production' ? {} : false
    }
  }
}

const { readFileSync } = require('fs')

const postcss = require('postcss')
const pluginsrc = require('postcss-load-plugins')

const css = readFileSync('index.css', 'utf8')

const ctx = { modules: true }

pluginsrc(ctx).then((plugins) => {
  postcss(plugins)
    .process(css)
    .then(({ css }) => console.log(css))
})

Maintainers

Michael Ciniawsky

Mateusz Derks

Contributors

Diogo Franco

Changelog

2.1.0 (2016-12-05)

Bug Fixes

• index: set NODE_ENV if undefined (920f806)
• index: support node v0.12 (e31fab3)
• lib/plugins: support node v0.12 (c440e6b)
• loadPlugins: add object-assign polyfill (acd3f84)
• plugins: check for plugin.default (024e8c7)

Features

• function support, jsdoc, cleanups (f637d60)