• Stars
    star
    134
  • Rank 270,967 (Top 6 %)
  • Language
    TypeScript
  • License
    MIT License
  • Created about 8 years ago
  • Updated 5 months ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

Rollup and compile multiple .scss, .sass and .css imports

Rollup multiple .scss, .sass and .css imports

Software License Issues JavaScript Style Guide NPM Latest Version

Installation

npm install --save-dev rollup-plugin-scss sass

If any of them is installed, it will be used automatically, if both installed sass will be used.

Usage

// rollup.config.js
import scss from 'rollup-plugin-scss'

export default {
  input: 'input.js',
  output: {
    file: 'output.js',
    format: 'esm',
    // Removes the hash from the asset filename
    assetFileNames: '[name][extname]'
  },
  plugins: [
    scss() // will output compiled styles to output.css
  ]
}

// OR

export default {
  input: 'input.js',
  output: { file: 'output.js', format: 'esm' },
  plugins: [
    scss({ fileName: 'bundle.css' }) // will output compiled styles to "bundle.css"
  ]
}

// OR

export default {
  input: 'input.js',
  output: { file: 'output.js', format: 'esm' },
  plugins: [
    scss() // will output compiled styles to "assets/output-123hash.css"
  ]
}
// entry.js
import './reset.scss'

Options

Options are passed to the sass compiler (node-sass by default). Refer to the Sass docs for more details on these options.
One notable option is indentedSyntax which you'll need if you're parsing Sass syntax instead of Scss syntax. (e.g. when extracting a Vue <style lang="sass"> tag)
By default the plugin will base the filename for the css on the bundle destination.

scss({
  // Defaults to output.css, Rollup may add a hash to this!
  name: 'output.css',

  // Literal asset filename, bypasses the automated filenaming transformations
  fileName: 'output.css',

  // Callback that will be called ongenerate with two arguments:
  // - styles: the contents of all style tags combined: 'body { color: green }'
  // - styleNodes: an array of style objects: { filename: 'body { ... }' }
  output: function (styles, styleNodes) {
    writeFileSync('bundle.css', styles)
  },

  // Disable any style output or callbacks, import as string
  output: false,

  // Enables/disables generation of source map (default: false)
  sourceMap: true,

  // Choose files to include in processing (default: ['/**/*.css', '/**/*.scss', '/**/*.sass'])
  include: [],

  // Choose files to exclude from processing (default: undefined)
  exclude: [],

  // Determine if node process should be terminated on error (default: false)
  failOnError: true,

  // Prefix global scss. Useful for variables and mixins.
  prefix: `@import "./fonts.scss";`,

  // A Sass (sass compatible) compiler to use
  // - sass and node-sass packages are picked up automatically
  // - you can use this option to specify custom package (e.g. a fork of one of them)
  sass: require('node-sass'),

  // Run postcss processor before output
  processor: () => postcss([autoprefixer({ overrideBrowserslist: 'Edge 18' })]),

  // Process resulting CSS
  processor: (css, map) => ({
    css: css.replace('/*date*/', '/* ' + new Date().toJSON() + ' */'),
    map
  }),

  // or, just string (for backward compatiblity with v2 or simplicity)
  processor: css =>
    css.replace('/*date*/', '/* ' + new Date().toJSON() + ' */'),

  // Log filename and size of generated CSS files (default: true)
  verbose: true

  // Add file/folder to be monitored in watch mode so that changes to these files will trigger rebuilds.
  // Do not choose a directory where rollup output or dest is pointed to as this will cause an infinite loop
  watch: 'src/styles/components',
  watch: ['src/styles/components', 'src/multiple/folders']

  // Any other options are passed to the sass compiler
  includePaths: ...
})

Examples

Using postcss + autoprefixer + includePaths (sass option)

import scss from 'rollup-plugin-scss'
import postcss from 'postcss'
import autoprefixer from 'autoprefixer'

export default {
  input: 'input.js',
  output: {
    file: 'output.js',
    format: 'esm'
  },
  plugins: [
    scss({
      processor: () => postcss([autoprefixer()]),
      includePaths: [
        path.join(__dirname, '../../node_modules/'),
        'node_modules/'
      ]
    })
  ]
}

Minify CSS output:

scss({
  outputStyle: 'compressed'
})

Changelog

Please see CHANGELOG for more information what has changed recently.

Contributing

Contributions and feedback are very welcome. New features should include a test.

To get it running:

  1. Clone the project.
  2. npm install

Credits

License

The MIT License (MIT). Please see License File for more information.

More Repositories

1

rollup-plugin-serve

Serve your rolled up bundle like webpack-dev-server
JavaScript
248
star
2

vercel-sapper

Vercel builder for Sapper with SSR enabled
JavaScript
191
star
3

rollup-plugin-livereload

LiveReload your Rollup bundle!
TypeScript
158
star
4

rollup-plugin-css-only

Rollup plugin that bundles imported css
JavaScript
116
star
5

payload-plugin-oauth

Add oAuth sign in to your Payload CMS site
TypeScript
79
star
6

rollup-plugin-vue2

Rollup plugin for Vue 2.0 components with precompiled templates
JavaScript
61
star
7

pilon

Pilon, easy wifi hotspot for Raspberry Pi, pay with bitcoin
PHP
41
star
8

Airtable-to-Figma

Figma plugin to import Airtable data into Figma components
HTML
25
star
9

kirby-plugins

Plugins for Kirby CMS
PHP
20
star
10

vuejs-templates-rollup

Vue + Rollup + Buble + Livereload + dev-server + CSS extraction
JavaScript
19
star
11

svelte-number-gauge

JavaScript
9
star
12

payload-components

Some custom Payload components
TypeScript
8
star
13

payload-plugin-resolve-alias

Shorthand to add common webpack aliases
TypeScript
7
star
14

hivepanel

TypeScript
7
star
15

impostor.party

Web-based game inspired by Among Us
TypeScript
3
star
16

rollup-plugin-url-import

Resolve URL imports just like Deno
JavaScript
3
star
17

deno-rollup

Rollup CLI for deno
JavaScript
2
star
18

gitroom

Collaborate on a git branch by syncing your working directory
JavaScript
1
star
19

util

Stuff I often need.
JavaScript
1
star
20

gnss

Debug GNSS devices using WebSerial
TypeScript
1
star
21

wdcommunity-website

HTML
1
star
22

schemaorg-redesign

A responsive redesign & offline-first PWA of schema.org https://schemaorg-redesign.now.sh
HTML
1
star
23

heart-coherence-app

TypeScript
1
star
24

ethicsandsport.com

Static assets for ethicsandsport.com
HTML
1
star
25

hidden-territories

TypeScript
1
star
26

messenger-extension-tester

Debug & test Messenger Extensions locally
JavaScript
1
star
27

vue-year-calendar

Year calendar component for Vue 2
Vue
1
star
28

thehive.party

TypeScript
1
star
29

mindustry-webserver

Web interface for hosting a Mindustry server
TypeScript
1
star