https://github.com/niksy/node-sass-global-import-once

Import Sass files once globally.
https://github.com/niksy/node-sass-global-import-once

Last synced: 25 days ago
JSON representation

Import Sass files once globally.

• Host: GitHub
• URL: https://github.com/niksy/node-sass-global-import-once
• Owner: niksy
• License: mit
• Created: 2016-03-14T23:38:21.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2016-11-13T11:06:10.000Z (about 8 years ago)
• Last Synced: 2024-11-24T19:08:02.843Z (about 1 month ago)
• Language: JavaScript
• Size: 6.84 KB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# node-sass-global-import-once

[![Build Status][ci-img]][ci]

Import Sass files once globally.

Useful when you would want to exclude certain components in output files and leave them only in one location (e.g. one component is imported globally and any other attempt to load it would produce empty string).

Goes along nicely with [node-sass-import-once][node-sass-import-once]. If you use it with that importer, set it after this importer.

## Installation

```sh

npm install node-sass-global-import-once --save

```

## Usage

**`input/index.scss`**

```scss

@import "foo";

@import "bar";

@import "baz";

body {

	color:red;

}

```

**`input/page.scss`**

```scss

@import "foo";

@import "bar";

@import "baz";

body {

	color:red;

}

```

```js

var sass = require('node-sass');

var gio = require('node-sass-global-import-once');

['./input/index.scss', './input/page.scss'].forEach(function ( file ) {

	sass.render({

		file: file,

		importer: [

			gio([

				{

					file: '**/index.scss',

					imports: [

						'foo',

						'baz'

					]

				}

			]),

		]

	}, function( err, result ) {

		//=> …

	});

});

```

Given two entry Sass files, they would be treated as:

**`input/index.scss`**

```css

@import "foo";

@import "bar";

@import "baz";

body {

	color:red;

}

```

**`input/page.scss`**

```css

@import "bar";

body {

	color:red;

}

```

`page.scss` doesn’t include `foo` and `bar` imports since they should be imported globally only once inside `index.scss`.

## API

### gio(definitions)

node-sass `file` option should be defined for this package to work properly.

Package expects one argument, array of definitions (object) for global imports.

Each object definitions contains following properties:

#### file

Type: `String`

Name of the file or [minimatch][minimatch] expression which is considered as global entry point.

#### imports

Type: `Array`

List of imports as strings which are considered to be global imports. Package only reads exact names defined inside files, so relative filenames which map to certain absolute package names are treated as different packages.

## License

MIT © [Ivan Nikolić](http://ivannikolic.com)

[ci]: https://travis-ci.org/niksy/node-sass-global-import-once

[ci-img]: https://img.shields.io/travis/niksy/node-sass-global-import-once/master.svg

[minimatch]: https://github.com/isaacs/minimatch

[node-sass-import-once]: https://github.com/at-import/node-sass-import-once