1. rollup-plugin-sass
Rollup Sass files.
rollup-plugin-sass
Package: rollup-plugin-sass
Created by: elycruz
Last modified: Tue, 16 Apr 2024 22:28:08 GMT
Version: 1.12.22
License: MIT
Downloads: 61,707
Repository: https://github.com/elycruz/rollup-plugin-sass

Install

npm install rollup-plugin-sass
yarn add rollup-plugin-sass

rollup-plugin-sass Build and Test issues npm mit Coverage Status

Installation

 npm install rollup-plugin-sass -D

Usage

 // rollup.config.js
import sass from 'rollup-plugin-sass';

export default {
  input: 'index.js',
  output: {
    file: 'bundle.js',
    format: 'cjs',
  },
  plugins: [
    sass()
  ]
}

rollup.config.ts

Add allowSyntheticDefaultImports, or esModuleInterop (enables allowSyntheticDefaultImports), to tsconfig.json:

 {
  "compilerOptions": {
    "esModuleInterOp": true
  }
}

Reference: (https://www.typescriptlang.org/tsconfig#esModuleInterop)

Write rollup.config.ts:

 // rollup.config.ts
import sass from 'rollup-plugin-sass';

// ...

Profit.

Options

output

  • Type: Boolean|String|Function (default: false)
 sass({
  // Default behaviour disable output
  output: false,

  // Write all styles to the bundle destination where .js is replaced by .css
  output: true,

  // Filename to write all styles
  output: 'bundle.css',

  // Callback that will be called ongenerate with two arguments:
  // - styles: the concatenated styles in order of imported
  // - styleNodes: an array of style objects:
  //  [
  //    { id: './style1.scss', content: 'body { color: red };' },
  //    { id: './style2.scss', content: 'body { color: green };' }
  //  ]
  output(styles, styleNodes) {
    writeFileSync('bundle.css', styles);
  }
})

insert

  • Type: Boolean (default: false)

If you specify true, the plugin will insert compiled CSS into <head/> tag.

 sass({
  insert: true
})

processor

  • Type: Function

If you specify a function as processor which will be called with compiled css before generate phase.

 import autoprefixer from 'autoprefixer';
import postcss from 'postcss';

sass({
  // Processor will be called with two arguments:
  // - style: the compiled css
  // - id: import id
  processor: css => postcss([autoprefixer])
    .process(css)
    .then(result => result.css)
})

The processor also support object result. Reverse css filed for stylesheet, the rest properties can be customized.

 sass({
  processor(code) {
    return {
       css: '.body {}',
       foo: 'foo',
       bar: 'bar',
    };
  },
})

Otherwise, you could do:

 import style, { foo, bar } from 'stylesheet';

runtime

  • Type: Object (default: sass)

If you specify an object, it will be used instead of sass. You can use this to pass a different sass compiler (for example the node-sass npm package).

options

  • Type: Object

Options for sass or your own runtime sass compiler.

If you specify data, the plugin will treat as prepend sass string.
Since you can inject variables during sass compilation with node.

 sass({
  options: {
    data: '$color: #000;'
  }
})

License

MIT elycruz,
BinRui.Guan

RELATED POST

Enhancing Vue.js Development: Harnessing the Potential of Vue-Loader

Enhancing Vue.js Development: Harnessing the Potential of Vue-Loader

Simplify Data Validation in Vue.js: A Step-by-Step Guide to Using Regex

Simplify Data Validation in Vue.js: A Step-by-Step Guide to Using Regex

Troubleshooting Made Easy: Common Issues and Solutions with vue-loader Without vue-cli

Troubleshooting Made Easy: Common Issues and Solutions with vue-loader Without vue-cli

Optimizing Webpack 4 with Vue CLI 3: Disabling the Cache-Loader

Optimizing Webpack 4 with Vue CLI 3: Disabling the Cache-Loader

Step-by-Step Guide: How to Add a Function to Your Vuex Plugin

Step-by-Step Guide: How to Add a Function to Your Vuex Plugin