Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

postcss-partial-import

jonathantneal96.1kCC0-1.0deprecated4.1.0

Package no longer supported. Contact Support at https://www.npmjs.com/support for more info.

Inline sugary @import statements in CSS

postcss, css, postcss-plugin, sugar, sass, scss, imports, styles, files, partials, modules, bower, node, npm

readme

Partial Import PostCSS Logo

NPM Version Build Status Licensing Changelog Gitter Chat

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.

/* before: style.css */

@import "foo/bar";

/* before: foo/bar.css */

.example-1 {
    background-color: #fafafa;
}

/* after: style.css */

.example-1 {
    background-color: #fafafa;
}

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:

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

Node

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

PostCSS

Add PostCSS to your build tool:

npm install postcss --save-dev

Load Partial Import as a PostCSS plugin:

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

Gulp

Add Gulp PostCSS to your build tool:

npm install gulp-postcss --save-dev

Enable Partial Import within your Gulpfile:

var postcss = require('gulp-postcss');

gulp.task('css', function () {
    return gulp.src('./src/*.css').pipe(
        postcss([
            require('postcss-partial-import')({ /* options */ })
        ])
    ).pipe(
        gulp.dest('.')
    );
});

Grunt

Add Grunt PostCSS to your build tool:

npm install grunt-postcss --save-dev

Enable Partial Import within your Gruntfile:

grunt.loadNpmTasks('grunt-postcss');

grunt.initConfig({
    postcss: {
        options: {
            use: [
                require('postcss-partial-import')({ /* options */ })
            ]
        },
        dist: {
            src: '*.css'
        }
    }
});

changelog

Changes to PostCSS Nesting

4.1.0 (May 13, 2017)

  • Added: Use PostCSS Import v10=
  • Updated: Properly note Node v4 support in package.json

4.0.0 (May 11, 2017)

  • Added: PostCSS v6 compatibility
  • Added: Node v4 compatibility
  • Added: .editorconfig
  • Removed: echoing

3.1.1 (February 14, 2017)

  • Updated: Fixed prefix handling when compiling on Windows

3.1.0 (December 20, 2016)

  • Added: Tests for glob, extension
  • Changed: Default prefix is now empty ("")
  • Removed: JSCS validation

3.0.1 (December 14, 2016)

  • Added: lib directory to the package

3.0.0 (December 14, 2016)

  • Added: Plugin refactoring as an alternative version of postcss-import
  • Updated: Boilerplate conventions (Node v6.9.1 LTS)

2.1.0 (October 18, 2016)

  • Added: Use css being imported with addDepedencyTo
  • Added: resolve option to override resolving paths
  • Updated: Improve ability to resolve npm modules

2.0.0 (July 1, 2016)

  • Added: Imports look in node_modules, bower_components, etc
  • Added: dirs lets imports look in user specified directories
  • Added: plugins lets PostCSS plugins run over individual partials
  • Removed: Caching (for now)
  • Updated: Complete rewrite of the plugin
  • Updated: extension now includes the dot (e.g. .css)

1.3.0 (September 14, 2015)

  • Added: Support for generating imported files
  • Updated: Switched to fs-promise from fs and mkdirp
  • Updated: Switched to assign from _extend

1.2.0 (September 9, 2015)

  • Added: Support for media queries
  • Added: Support for caching sources

1.1.1 (September 8, 2015)

  • Fixed: Plugins no longer run on imports

1.1.0 (September 8, 2015)

  • Updated: Refactored code
  • Removed: root option

1.0.1 (September 8, 2015)

  • Fixed: Package dependencies
  • Fixed: Documented syntax

1.0.0 (September 7, 2015)

  • Added: Initial release