Partial Import

Partial Import lets you use sugary @import statements in CSS, including glob-like and Sass-like behavior. It even lets you generates imports as a scaffolding tool.

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

Options

root

Type: String
Default: from or process.cwd()

The root where paths are resolved. This should be the directory containing node_modules.

path

Type: String | Array
Default: []

A path or paths used to locate files.

plugins

Type: Array
Default: undefined

An array of plugins to be applied to imported file.

onImport

Type: Function
Default: null

The function called after the import process, receiving an array of imported files.

resolve

Type: Function
Default: null

A custom resolver, receiving the id, basedir, and importOptions of an import.

load

Type: Function
Default: null

A custom loader, receiving the filename, importOptions, and content or promised content.

skipDuplicates

Type: Boolean
Default: true

Whether similar files (based on the same content) will be skipped.

prefix

Type: String
Default: ""

Leading characters conditionally prepended to imports which are not found without them. For Sass-like, use "_".

glob

Type: Boolean | Object
Default: true

Whether glob-like behavior should be supported by imports. An object passed here will be forwarded to glob in order to change pattern matching behavior.

touch

Type: Boolean
Default: false

Whether imports should be created as files if they do not already exist.

extension

Type: String
Default: .css

A file extension conditionally appended to touched imports which do not specify an extension.

Usage

Add Partial Import to your build tool:

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

Node

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

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]).process(YOUR_CSS, /* options */);

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('./src/*.css').pipe(
5		postcss([
6			require('postcss-partial-import')({ /* options */ })
7		])
8	).pipe(
9		gulp.dest('.')
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			use: [
7				require('postcss-partial-import')({ /* options */ })
8			]
9		},
10		dist: {
11			src: '*.css'
12		}
13	}
14});