GithubHelp home page GithubHelp logo

postcss-separator's Introduction

PostCSS Separator

Split up your Data-URI (or anything else) into a separate CSS file.

Written with PostCSS.

Installation

$ npm install postcss-separator

Usage

Read source.css, process its content, and output processed CSS to styles.css and data.css.

var fs = require('fs');
var separator = require('../index');

var original = fs.readFileSync('./fixtures/source.css', 'utf8');

var icons = separator.separate(original, {
	dataFile: true
});
var cleanUp = separator.separate(original, {
	dataFile: false
});

fs.writeFileSync('./expected/data.css', icons.css);
fs.writeFileSync('./expected/styles.css', cleanUp.css);

If source.css has:

a.top:hover, a.top:focus {
	background-image: url("data:image");
}

a.top {
	background-image: url("data:image");
}

caption, th, td {
	text-align: left;
	font-weight: normal;
	vertical-align: middle;
}

q, blockquote {
	quotes: none;
}

q:before, q:after, blockquote:before, blockquote:after {
	content: "";
}

a img {
	border: none;
}

You will get the following output in data.css:

a.top:hover, a.top:focus {
	background-image: url("data:image");
}
a.top {
	background-image: url("data:image");
}

Options

keepOrigin (only available in Grunt)

Type: boolean

Default value: false

true: keep the origin file untouched.

false: the origin CSS file will be cleaned up.

dataFile

Type: boolean

Default value: true

true: the generated CSS content of your file matches your pattern.

false: the matching pattern will be removed from your CSS file.

pattern.matchValue

Type: RegExp

Default value: /data:/

A string value that is used to set the value like your are searching for in your CSS.

Example: linear-gradient

pattern.matchProp

Type: RegExp

Default value: false

A string value that is used to set the property your are searching for in your CSS.

Example: background-image

pattern.matchRule

Type: RegExp

Default value: false

A string value that is used to set the rule your are searching for in your CSS.

Example: /lt-ie9/

pattern.matchMedia

Type: RegExp

Default value: false

A value that is used to set the media query your are searching for in your CSS.

Example: resolution: 2dppx

pattern.matchParent

Type: Boolean

Default value: true

A boolean value that is used to include/exclude the rules parent node (eg. in @media blocks).

pattern.matchAtRuleType

Type: RegExp

Default value: false

A value which is used for searching @-types in your CSS.

Examples:

  • /print/
  • /font-face/

Api

separate(css, [options])

Remove or separate into another file any data in your css.

options (optional) same as the second argument of PostCSS' process() method.

postcss()

Returns PostCSS processor.

You can use this property for combining with other PostCSS processors.

var autoprefixer = require('autoprefixer');
var separator = require('postcss-separator');
var postcss = require('postcss');

var css = fs.readFileSync('test.css', 'utf8');
postcss().use(
  autoprefixer.postcss
).use(
  separator.postcss
).process(css, options);

Grunt Plugin

There is also a grunt module available: see grunt-postcss-separator

License

Copyright (c) 2015 Sebastian Fitzner. Licensed under the MIT license.

ToDos

  • Add tests
  • Add further plugin compatibility for PostCSS

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.