A Browserify transform for bundling, rebasing, inlining, and minifying CSS files. It's useful for CSS modularization where styles are scoped to their related bundles.
If you're new to browserify, check out the browserify handbook and the resources on browserify.org.
npm install --save-dev browserify-css
app.css:
@import url("modules/foo/index.css");
@import url("modules/bar/index.css");
body {
background-color: #fff;
}app.js:
var css = require('./app.css');
console.log(css);You can compile your app by passing -t browserify-css to browserify:
$ browserify -t browserify-css app.js > bundle.js
Each require('./path/to/file.css') call will concatenate CSS files with @import statements, rebasing urls, inlining @import, and minifying CSS. It will add a style tag with an optional data-href attribute to the head section of the document during runtime:
<html>
<head>
<style type="text/css" data-href="app.css">...</style>
</head>
</html>
You can set configuration to your package.json file:
{
"browserify-css": {
"autoInject": true,
"minify": true,
"rootDir": "."
}
}or use an external configuration file like below:
{
"browserify-css": "./config/browserify-css.js"
}config/browserify-css.js:
module.exports = {
"autoInject": true,
"minify": true,
"rootDir": "."
};Furthermore, browserify-css transform can obtain options from the command-line with subarg syntax:
$ browserify -t [ browserify-css --autoInject=true ] app.js
or from the api:
b.transform('browserify-css', { autoInject: true })
Type: Boolean
Default: true
If true, each require('path/to/file.css') call will add a style tag to the head section of the document.
Type: Object
Default:
{
"verbose": true
}If verbose is set to true, the path to CSS will be specified in the data-href attribute inside the style tag
Type: String
Default: ./
An absolute path to resolve relative paths against the project's base directory.
Type: Boolean
Default: false
Type: Object
Default: {}
Check out a list of CSS minify options at CleanCSS.
You can choose one of the following methods to include CSS files located inside the node_modules folder:
- The easiest way to do this is using the
@importrule. For example:
app.js:
require('./app.css');app.css:
/* Use CSS from your node_modules folder */
@import "node_modules/foo/foo.css";
/* Or your own relative files */
@import "styles/common.css";- Use the global transform option (i.e.
--global-transformor-g) on the command line to transform all files in a node_modules directory:
$ browserify -g browserify-css app.js > bundle.js or use the API directly:
var browserify = require('browserify');
var b = browserify('./app.js');
b.transform('browserify-css', {global: true});
b.bundle().pipe(process.stdout);See browserify transform options for details.
- Put browserify transform option into a submodule's package.json file inside the
node_modulesdirectory on a per-module basis like so:
node_modules/foo/package.json:
{
"browserify": {
"transform": ["browserify-css"]
}
}Then, run browserify transform on the command line:
$ browserify -t browserify-css app.js > bundle.js Copyright (c) 2014-2015 Cheton Wu
Licensed under the MIT License.