Package Exports

css-selector-extract

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (css-selector-extract) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

css-selector-extract

With selector extracting, it is possible to extract certain CSS selectors (RegEx can be used to match selectors) from CSS code. This is especially useful if you want to extract only a few CSS classes from a huge library or framework.

Demos

var cssSelectorExtract = require('css-selector-extract');

var options = {
  // CSS source code as string.
  css: '.btn { } .btn-alert { } .btn-success { }',
  // Array of selectors which should get extracted.
  filters: ['.btn']
};

// Asynchronous:
cssSelectorExtract.process(options).then((extractedCss) => {
  console.log(extractedCss); // Outputs: `.btn { }`.
});

// Synchronous:
var extractedCss = cssSelectorExtract.processSync(options);
console.log(extractedCss); // Outputs: `.btn { }`.

Rename extracted selectors

var cssSelectorExtract = require('css-selector-extract');

var options = {
  // CSS source code as string.
  css: '.btn { } .btn-alert { } .btn-success { }',
  // Array of selector filter objects with selectors
  // which should get extracted and replaced.
  filters: [{ selector: '.btn', replacement: '.button' }]
};

// Asynchronous:
cssSelectorExtract.process(options).then((extractedCss) => {
  console.log(extractedCss); // Outputs: `.button { }`.
});

RegEx

Filter selectors

var cssSelectorExtract = require('css-selector-extract');

var options = {
  css: '.btn { } .btn-alert { }',
  filters: [/^\..+-alert/]
};

cssSelectorExtract.process(options).then((extractedCss) => {
  console.log(extractedCss); // Outputs: `.btn-alert { }`.
});

Replace selectors

var cssSelectorExtract = require('css-selector-extract');

var options = {
  css: '.btn { } .btn-alert { }',
  filters: [{ selector: /^\.btn(.*)/, replacement: '.button$1' }]
};

cssSelectorExtract.process(options).then((extractedCss) => {
  console.log(extractedCss); // Outputs: `.button { } .button-alert { }`.
});

Usage with syntaxes other than pure CSS

Install the corresponding postcss syntax plugin (e.g. postcss-scss or postcss-less).

var cssSelectorExtract = require('css-selector-extract');
var postcssScss = require('postcss-scss');

var options = {
  css: '.nested { .selector { } }',
  filters: ['.nested'],
  postcssSyntax: postcssScss
};

// Add the postcss syntax plugin as third parameter.
cssSelectorExtract.process(options).then((extractedCss) => {
  console.log(extractedCss);
});

ES2015 named exports

import { process, processSync } from 'css-selector-extract';

var options = {
  // CSS source code as string.
  css: '.btn { } .btn-alert { } .btn-success { }',
  // Array of selectors which should get extracted.
  filters: ['.btn']
};

// Asynchronous:
process(options).then((extractedCss) => {
  console.log(extractedCss); // Outputs: `.btn { }`.
});

// Synchronous:
const extractedCss = processSync(options);
console.log(extractedCss); // Outputs: `.btn { }`.

Upgrade from 2.x.x to 3.x.x

With version 3.0.0 css-selector-extract takes an object as it's only parameter.

var cssSelectorExtract = require('css-selector-extract');
var postcssScss = require('postcss-scss');

// New way:
var options = {
  css: '.btn { } .btn-alert { } .btn-success { }',
  filters: ['.btn'],
  postcssSyntax: postcssScss
};
cssSelectorExtract.process(options);
cssSelectorExtract.processSync(options);

// Old way:
var css = '.btn { } .btn-alert { } .btn-success { }';
var selectorFilters = ['.btn'];
cssSelectorExtract.process(css, selectorFilters, postcssScss);
cssSelectorExtract.processSync(css, selectorFilters, postcssScss);

Development

See CONTRIBUTING.md

Testing

npm test

About

Author

Markus Oberlehner
Website: https://markus.oberlehner.net
Twitter: https://twitter.com/MaOberlehner
PayPal.me: https://paypal.me/maoberlehner

License

MIT