0.1.5 • Published 4 years ago

postcss-sparrow-props-filter v0.1.5

Weekly downloads
7
License
MIT
Repository
github
Last release
4 years ago

PostCSS Sparrow Props Filter

Known Vulnerabilities Codacy Badge Maintainability Test Coverage

A PostCSS Sparrow plugin that helps you search CSS declarations by properties.

This plugin is designed to be used with PostCSS Sparrow, which helps you filter CSS declarations by selectors. By using these two plugins together, you can easily get the declarations you need.

Made in Hong Kong :free: :free:

This plugin is made with love by a Hong Konger.

Installation

This plugin require you to use PostCSS Sparrow for matching with selectors you want.

Download both postcss-sparrow and this plugin through NPM.

npm i postcss-sparrow postcss-sparrow-props-filter

Then import this plugin as the callback for PostCSS Sparrow.

//postcss.config.js
module.exports = {
  plugins: [
    //Other plugins...

    require('postcss-sparrow')({
      transformations: [
        {
          selectors: ['*'],
          inclusion: true,
          callbacks: [
            require('postcss-sparrow-props-filter')(
              {
                props: ['font-size'],
                inclusion: true,
                callbacks: [
                  //Do transformation here with your own callback functions
                  (decl) => {
                    decl.remove()
                  }
                ]
              }
            )
          ]
        }
      ]
    })
  ]
}

API Reference

options.props : Array

An array of properties that you want to match with. Use * as wildcard and select all properties.

For example, display will match display: block.

options.inclusion : Boolean

True for including and False for excluding selectors listed in options.props.

options.callbacks : Array

An array of callbacks that you use to transform the selected declarations. The selected declaration will be passed in as an argument.