npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

neutrino-middleware-sass-loader

v2.2.0

Published

Neutrino Sass loader middleware

Downloads

4

Readme

Neutrino Sass loader middleware

npm npm

neutrino-middleware-sass-loader is a Neutrino middleware for compiling styles with Dart Sass. This middleware only transforms Sass to CSS. It is recommended to have @neutrinojs/style-loader (or its substitution) in the configuration to be able to compile Sass styles to JavaScript modules. Both SCSS and SASS syntaxes are supported.

Requirements

  • Node.js v10.13+
  • Neutrino v9

Installation

neutrino-middleware-sass-loader can be installed from NPM. You should install it to "dependencies" (--save) or "devDependncies" (--save-dev) depending on your goal.

npm install --save-dev neutrino-middleware-sass-loader

Usage

neutrino-middleware-sass-loader can be consumed from the Neutrino API, middleware, or presets.

In preset

Require this package and plug it into Neutrino. The following shows how you can pass an options object to the middleware, showing the defaults:

let sassLoader = require('neutrino-middleware-sass-loader')

neutrino.use(sassLoader({
   include: ['src', 'tests'],
   exclude: [],
   sass   : {}
}))
  • include: optional array of paths to include in the compilation. Maps to Webpack's rule.include.
  • exclude: optional array of paths to exclude from the compilation. Maps to Webpack's rule.include.
  • sass: optional Sass options config that is passed to the loader.

It is recommended to call this middleware after the neutrino.config.module.rule('style') initialization to avoid unexpected overriding. More information about usage of Neutrino middlewares can be found in the documentation.

In neutrinorc

The middleware also may be used together with another presets in Neutrino rc-file, e.g.:

.neutrinorc.js

let web        = require('@neutrino/web')
let sassLoader = require('neutrino-middleware-sass-loader')

module.exports = {
   use: [
      web(),
      sassLoader()
   ]
}

Imports paths

The loader can resolve paths in one of two modes: Sass or Webpack.

Webpack's resolver is used by default. To use its advantages to look up the modules you need to prepend ~ to the path:

@import "~bootstrap/sass/bootstrap";

Otherwise the path will be determined as a relative URL, @import "file" is the same as @import "./file"

If you specify the includePaths option, the Webpack's resolver will not be used. Modules, that can't be resolved in the local folder, will be searched in the given includePaths. This is Sass' default behavior. includePaths should be an array with absolute paths:

let sassLoader = require('neutrino-middleware-sass-loader')

neutrino.use(sassLoader({
   sass: {
      includePaths: [
         path.resolve(__dirname, 'node_modules')
      ]
   }
}))

Importing variables from JS

SASS files can import variables from JS modules. Example:

vars.js

module.exports = {
   'default-color': 'yellow',
   'border'       : '2px solid red'
}

main.sass

require('./vars.js');

@import "./other.sass";

.box:extend(.darkgreen) {
  color: @default-color;
  border: @border;
  width: 200px;
  height: 200px;
}

It is recommended to require all JS modules before any @import rules.

Rules

This is a list of rules that are used by neutrino-middleware-sass-loader:

  • sass: Compiles Sass styles to CSS styles. Contains loaders named: resolve-url, sass and sass-var.
  • style: Only necessary file extension added. CSS loader should be provided to correctly compile styles to JavaScript.