Partial Import

Partial Import is a PostCSS plugin that inlines standard and Sass-like @import statements.

1/* before file.css */
2
3@import "foo/bar";
4
5/* before foo/_bar.css */
6
7html {
8    background-color: #fafafa;
9}
10
11/* after */
12
13html {
14    background-color: #fafafa;
15}
16

Usage

Follow these steps to use Partial Import.

Add Partial Import to your build tool:

1npm install postcss-partial-import --save-dev

Node

1require('postcss-partial-import')({ /* options */ }).process(YOUR_CSS);

PostCSS

Add PostCSS to your build tool:

1npm install postcss --save-dev

Load Partial Import as a PostCSS plugin:

1postcss([
2    require('postcss-partial-import')({ /* options */ })
3]);

Gulp

Add Gulp PostCSS to your build tool:

1npm install gulp-postcss --save-dev

Enable Partial Import within your Gulpfile:

1var postcss = require('gulp-postcss');
2
3gulp.task('css', function () {
4    return gulp.src('./css/src/*.css').pipe(
5        postcss([
6            require('postcss-partial-import')({ /* options */ })
7        ])
8    ).pipe(
9        gulp.dest('./css')
10    );
11});

Grunt

Add Grunt PostCSS to your build tool:

1npm install grunt-postcss --save-dev

Enable Partial Import within your Gruntfile:

1grunt.loadNpmTasks('grunt-postcss');
2
3grunt.initConfig({
4    postcss: {
5        options: {
6            processors: [
7                require('postcss-partial-import')({ /* options */ })
8            ]
9        },
10        dist: {
11            src: 'css/*.css'
12        }
13    }
14});

Options

encoding

Type: String
Default: utf8

The character encoding of files being imported.

extension

Type: String
Default: css

The file extension appended to partials being imported.

prefix

Type: String
Default: _

The file extension sometimes prepended to partials being imported.

generate

Type: Boolean
Default: false

The option if partials should be generated if they do not already exist.

cachedir

Type: String
Default: null

The directory to store cached includes in. Can reduce compilation time when there are a lot of @includes. Setting this property enables the cache.

addDependencyTo

Type: function
Default: null

To pass CSS @import files to a compiler (such as webpack), which would otherwise not know which CSS files to watch for browser reloading.

Example

1// webpack.config.js
2postcss: function(webpack) {
3    return [
4        precss({ addDependencyTo: webpack })
5    ];
6},