sospartan/esbuild-sass-plugin

esbuild plugin for sass

A plugin for esbuild to handle sass & scss files.

Features

• support for constructable stylesheet to be used in custom elements or dynamic style to be added to the html page
• comes with dart sass but can be easily switched to node-sass
• caching
• postCSS & css modules

Install

npm i esbuild-sass-plugin

Usage

Just add it to your esbuild plugins:

import {sassPlugin} from "esbuild-sass-plugin";

await esbuild.build({
    ...
    plugins: [sassPlugin()]
});

this will use loader: "css" and your transpiled sass will be included in index.css.

If you specify type: "style" then the stylesheet will be dynamically added to the page.

If you want to use the resulting css text as a string import you can use type: "css-text"

await esbuild.build({
    ...
    plugins: [sassPlugin({
        type: "css-text",
        ... // other options for sass.renderSync(...)
    })]
});

...and in your module do something like

...
import cssText from "./styles.scss";
...
customElements.define("hello-world", class HelloWorld extends HTMLElement {

    constructor() {
        super();
        this.attachShadow({mode: 'open'});
        this.sheet = new CSSStyleSheet();
        this.sheet.replaceSync(cssText);
        this.shadowRoot.adoptedStyleSheets = [this.sheet];
    }
}

Or you can import a lit-element css result using type: "lit-css"

...
import styles from "./styles.scss";
...
@customElement("hello-world")
export default class HelloWorld extends LitElement {

    static styles = styles

    render() {
        ...
    }
}

Look in the test folder for more usage examples.

Options

The options passed to the plugin are a superset of the sass Options.

Option	Type	Default
cache	boolean or Map	true
type	string or array	"css"
implementation	string	"sass"
transform	function	undefined
exclude	regex	undefined
importMapper	function	undefined

If you want to have different loaders for different parts of your code you can pass type an array.

Each item is going to be:

• the type (one of: css, css-text, lit-css or style)
• a valid picomatch glob, an array of one such glob or an array of two.

e.g.

await esbuild.build({
    ...
    plugins: [sassPlugin({
        type: [                                     // this is somehow like a case 'switch'...
            ["css", "bootstrap/**"],                // ...all bootstrap scss files (args.path) 
            ["style", ["src/nomod/**"]],            // ...all files imported from files in 'src/nomod' (args.importer) 
            ["style", ["**/index.ts","**/*.scss"]], // all scss files imported from files name index.ts (both params)
            ["lit-css"]                             // this matches all, similar to a case 'default'
        ],
    })]
})

NOTE: last type applies to all the files that don't match any matchers.

Exclude Option

Used to exclude paths from the plugin

e.g.

await esbuild.build({
    ...
    plugins: [sassPlugin({
        exclude: /^http:\/\//,  // ignores urls
    })]
})

ImportMapper Option

Function to customize re-map import path, both import in ts code and @import in scss coverd.
You can use this option to re-map import paths like tsconfig's paths option.

e.g.

//tsconfig
{
  "compilerOptions": {
    "baseUrl": ".", 
    "paths": {
      "@img/*": ["./assets/images/*"] //map image files
    }
  }
}

Now you can resolve these paths with importMapper

await esbuild.build({
    ...
    plugins: [sassPlugin({
        importMapper: (path)=>
          path.replace(/^@img\//,"./assets/images/")
    })]
})

Transform Option

async (css:string, resolveDir:string?) => string

It's a function which will be invoked before passing the css to esbuild or wrapping it in a module.
It can be used to do postcss processing and/or to create modules like in the following examples.

PostCSS

The simplest use case is to invoke PostCSS like this:

const postcss = require("postcss");
const autoprefixer = require("autoprefixer");
const postcssPresetEnv = require("postcss-preset-env");

esbuild.build({
    ...
    plugins: [sassPlugin({
        async transform(source, resolveDir) {
            const {css} = await postcss([autoprefixer, postcssPresetEnv({stage:0})]).process(source);
            return css;
        }
    })]
});

CSS Modules

A helper function is available to do all the work of calling postcss to create a css module. The usage is something like:

const {sassPlugin, postcssModules} = require("esbuild-sass-plugin");

esbuild.build({
    ...
    plugins: [sassPlugin({
        transform: postcssModules({
            // ...put here the options for postcss-modules: https://github.com/madyankin/postcss-modules
        })
    })]
});

postcss and postcss-modules have to be added to your package.json.

Look into fixture/css-modules for the complete example.

NOTE: Since v1.5.0 transform can return either a string or an esbuild LoadResult object.
This gives the flexibility to implement that helper function.

Use node-sass instead of sass

Remember to add the dependency

npm i esbuild-sass-plugin node-sass

and to specify the implementation in the options:

await esbuild.build({
    ...
    plugins: [sassPlugin({
        implementation: "node-sass",
        ... // other options for sass.renderSync(...)
    })]
});

CACHING

It greatly improves the performance in incremental builds or watch mode.

It has to be enabled with cache: true in the options.

You can pass your own map instead of true if you want to recycle it across different builds.

const pluginCache = new Map();

await esbuild.build({
    ...
    plugins: [sassPlugin({cache: pluginCache})],
    ...
})

Benchmarks

Given 24 x 24 = 576 lit-element files & 576 imported css styles

cache: true

initial build: 2.033s
incremental build: 1.199s     (one ts modified)
incremental build: 512.429ms  (same ts modified again)
incremental build: 448.871ms  (one scss modified)
incremental build: 448.92ms   (same scss modified)

cache: false

initial build: 1.961s
incremental build: 1.986s     (touch 1 ts)
incremental build: 1.336s     (touch 1 ts)
incremental build: 1.069s     (touch 1 scss)
incremental build: 1.061s     (touch 1 scss)

node-sass

initial build: 1.030s
incremental build: 468.677ms  (one ts modified) 
incremental build: 347.55ms   (same ts modified again)
incremental build: 401.264ms  (one scss modified)
incremental build: 364.649ms  (same scss modified)