https://github.com/brightspace/frau-sass-importer

https://github.com/brightspace/frau-sass-importer

Last synced: 5 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/brightspace/frau-sass-importer
• Owner: Brightspace
• License: apache-2.0
• Created: 2015-11-13T18:43:38.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2024-01-24T21:42:50.000Z (10 months ago)
• Last Synced: 2024-10-23T04:25:13.178Z (23 days ago)
• Language: JavaScript
• Size: 36.1 KB
• Stars: 1
• Watchers: 27
• Forks: 4
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# frau-sass-importer

Custom importer for node-sass to help resolve relative paths to node modules and bower components.

This importer will attempt to resolve sass references using an npm module style algorithm. If the path can't be resolved and the reference starts with **node_modules** or **bower_components**, it will walk up the ancestor tree looking for the file. All other references will be ignored and left to be handled by some other custom importer or the regular sass path resolution process.

## Installation

## Node Version Requirement

Note: Node v18 required, i.e. this will not work with earlier versions of Node (and might not work with later versions also). Using Node Version Manager (NVM) recommended.

Install via NPM:

```shell

npm install frau-sass-importer

```

## Usage

1) In your .scss file @import statements, reference another .scss file from a dependent node module or bower component. Examples:

```scss

@import 'my-module/src/main.scss';

@import 'my-module/src/main';

@import 'node_modules/my-module/src/widget/widget.scss';

@import 'bower_components/my-component/main.scss';

```

2) Add the custom importer to your node-sass build step.

```json

package.json

{

	"scripts": {

		"build:css": "node-sass --importer ./node_modules/frau-sass-importer/ ./src/app.scss > ./dist/app.css"

	}

}

```

## Tests

This project uses [mocha](https://mochajs.org/), [chai](http://chaijs.com/), and [sinon](http://sinonjs.org/) for unit testing. To run the tests:

```shell

npm test

```

## Contributing

Contributions are welcome, please submit a pull request!

### Code Style

This repository is configured with [EditorConfig](http://editorconfig.org) rules and contributions should make use of them.

## Versioning and Releasing

This repo is configured to use `semantic-release`. Commits prefixed with `fix:` and `feat:` will trigger patch and minor releases when merged to `main`.

To learn how to create major releases and release from maintenance branches, refer to the [semantic-release GitHub Action](https://github.com/BrightspaceUI/actions/tree/main/semantic-release) documentation.

[npm-url]: https://www.npmjs.org/package/frau-appconfig-builder

[npm-image]: https://img.shields.io/npm/v/frau-appconfig-builder.svg