Detalhes do pacote

broccoli-postcss

jeffjewiss221.7kMIT6.1.0

Postcss compiler for Broccoli

broccoli-plugin, css, postcss, postcss-runner

readme (leia-me)

broccoli-postcss

Build Status npm version Coverage Status monthly downloads total downloads

The broccoli-postcss plugin runs your css through postcss plugins of your choosing.

Installation

npm install --save-dev broccoli-postcss

Usage

const compileCSS = require('broccoli-postcss')
const outputTree = compileCSS(tree, options)

Compatibility

Due to changes in the plugin API of Postcss V8 some plugins will need to be updated after upgrading Postcss. This should be as simple as updating this package from V5 to V6, however compatibility is not guaranteed.

  • V6 broccoli-postcss -> Postcss V8
  • V5 broccoli-postcss -> Postcss V7

API

broccoliPostcss(tree, [options])

options

plugins

Type: array

A list of plugin objects to be used by Postcss (a minimum of 1 plugin is required).

There are two supported methods for defining plugins:

  1. Object form

     plugins: [
       {
         module: require('some-plugin'),
         options: { /* options for `some-plugin` */ }
       }
     ]
    
  2. Function form

     plugins: [
       require('some-plugin')({ /* options for `some-plugin` */ })
     ]
    

Note: additional options (defined below) that are merged with the individual plugin options are only supported for plugins defined in "object form".

browsers

Type: array

A list of browsers to support. Follows the browserslist format. Will be passed to each plugin and can be overridden using the plugin’s options.

map

Type: object Default: { inline: false, annotation: false }

An object of options to describe how Postcss should handle source maps.

include

Type: array Default: []

Array of GlobStrings|RegExps|Functions to describe a whitelist of files to get processed by Postcss.

exclude

Type: array Default: []

Array of GlobStrings|RegExps|Functions to describe a blacklist of files to be ignored by Postcss.

Example

/* Brocfile.js */
var compileCSS = require('broccoli-postcss')
var cssnext = require('postcss-cssnext')

var options =  {
  plugins: [
    {
      module: cssnext,
      options: {
          browsers: ['last 2 version']
      }
    },
  ],
  map: false,
  include: ['styles/*.css'],
  exclude: ['vendor/bootstrap/**/*']
}

var outputTree = compileCSS('app/styles', options)
module.exports = outputTree

changelog (log de mudanças)

master

6.1.0

  • upgrade dependencies
  • fix get extensions()

6.0.1

  • npm package security fixes

6.0.0

  • upgrade broccoli-persistent-filter and use native classes (@BarryThePenguin, @nlfurniss)
  • BREAKING: upgrade Postcss to V8

5.1.0

  • drop support for Node 8
  • dependency updates
  • security release for minimist

5.0.0

  • drop support for Node 6
  • dependency updates

4.0.2

  • security release for extend and lodash

4.0.1

  • remove appveyor yml
  • fix yarn engine text

4.0.0

  • drop support for Node 4
  • remove yarn
  • relax dependencies
  • upgrade to Postcss 7

3.5.3

  • support Node 10

3.5.2

  • support Node 9
  • drop testing for Node 7

3.5.1

  • update dependencies

3.5.0

  • allow plugins to be configured as functions

3.4.2

  • support Node 8

3.4.1

  • update Postcss to v6

3.4.0

  • switch plugins for testing
  • better testing
  • internal plugin refactoring

3.3.0

  • allow filtering of vendor files
  • use Yarn

3.2.0

  • update Broccoli to v1

3.1.0

  • drop support for Node v0.10.0

3.0.0

  • Converts plugin to run as a filter.
  • Adds linting with Standard.
  • Adds test coverage with nyc & coveralls.

2.1.1

  • Upgrades Broccoli Caching Writer to version 2.

2.1.0

  • Writes a source map file when map property is present

2.0.0

  • Updates Postcss to version 5.

1.3.0

  • Added argument to pass options to source maps.

1.2.1

  • Better check for CssSyntaxError.

1.2.0

  • Uses the PostCSS async api.
  • Better error messages.
  • Display warnings from plugins.
  • Sanity check test.

1.1.0

  • Fixes compiler arguments to better align with Broccoli plugin standards (first argument is an array of trees).

1.0.0

  • Initial working implementation