|
1 | | -# gulp-sass [](https://travis-ci.org/dlmanning/gulp-sass) [](https://gitter.im/dlmanning/gulp-sass?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) [](http://badge.fury.io/js/gulp-sass) |
| 1 | +# gulp-sass  [](https://gitter.im/dlmanning/gulp-sass?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)   |
2 | 2 |
|
3 | 3 | Sass plugin for [Gulp](https://github.com/gulpjs/gulp). |
4 | 4 |
|
5 | | -**_Before filing an issue, please make sure you have [Updated to the latest Gulp Sass](https://github.com/dlmanning/gulp-sass/wiki/Update-to-the-latest-Gulp-Sass) and have gone through our [Common Issues and Their Fixes](https://github.com/dlmanning/gulp-sass/wiki/Common-Issues-and-Their-Fixes) section._** |
| 5 | +**_Before filing an issue, please make sure you have [updated to the latest version of `gulp-sass`](https://github.com/dlmanning/gulp-sass/wiki/Update-to-the-latest-Gulp-Sass) and have gone through our [Common Issues and Their Fixes](https://github.com/dlmanning/gulp-sass/wiki/Common-Issues-and-Their-Fixes) section._** |
6 | 6 |
|
7 | | -# Support |
| 7 | +**Migrating your existing project to version 5? Please read our (short!) [migration guide](#migrating-to-version-5).** |
| 8 | + |
| 9 | +## Support |
8 | 10 |
|
9 | 11 | Only [Active LTS and Current releases][1] are supported. |
10 | 12 |
|
11 | 13 | [1]: https://github.com/nodejs/Release#release-schedule |
12 | 14 |
|
13 | | -# Install |
| 15 | +## Installation |
| 16 | + |
| 17 | +To use `gulp-sass`, you must install both `gulp-sass` itself *and* a Sass compiler. `gulp-sass` supports both [Dart Sass][] and [Node Sass][], but Node Sass is [deprecated](https://sass-lang.com/blog/libsass-is-deprecated). We recommend that you use Dart Sass for new projects, and migrate Node Sass projects to Dart Sass when possible. |
| 18 | + |
| 19 | +Whichever compiler you choose, it's best to install these as dev dependencies: |
14 | 20 |
|
15 | 21 | ``` |
16 | | -npm install node-sass gulp-sass --save-dev |
| 22 | +npm install sass gulp-sass --save-dev |
17 | 23 | ``` |
18 | 24 |
|
19 | | -# Basic Usage |
| 25 | +## Usage |
| 26 | + |
| 27 | +**Note:** These examples assume you're using Gulp 4. For examples that work with Gulp 3, [check the docs for an earlier version of `gulp-sass`](https://github.com/dlmanning/gulp-sass/tree/v4.1.1). |
| 28 | + |
| 29 | +`gulp-sass` runs inside of Gulp tasks. No matter what else you do with `gulp-sass`, you must first import it into your gulpfile, making sure to pass it the compiler of your choice. From there, create a Gulp task that calls either `sass()` (to asynchronously render your CSS), or `sass.sync()` (to render it synchronously). Then, export your task with the `export` keyword. We'll show some examples of how to do that. |
| 30 | + |
| 31 | +**⚠️ Note:** With Dart Sass, **synchronous rendering is twice as fast as asynchronous rendering**. The Sass team is exploring ways to improve asynchronous rendering with Dart Sass, but for now you will get the best performance from `sass.sync()` |
| 32 | + |
| 33 | +### Render your CSS |
20 | 34 |
|
21 | | -Something like this will compile your Sass files: |
| 35 | +To render your CSS with a build task, then watch your files for changes, you might write something like this.: |
22 | 36 |
|
23 | 37 | ```javascript |
24 | 38 | 'use strict'; |
25 | 39 |
|
26 | 40 | var gulp = require('gulp'); |
27 | | -var sass = require('gulp-sass'); |
| 41 | +var sass = require('gulp-sass')(require('sass')); |
28 | 42 |
|
29 | | -sass.compiler = require('node-sass'); |
30 | | - |
31 | | -gulp.task('sass', function () { |
| 43 | +function buildStyles() { |
32 | 44 | return gulp.src('./sass/**/*.scss') |
33 | 45 | .pipe(sass().on('error', sass.logError)) |
34 | 46 | .pipe(gulp.dest('./css')); |
35 | | -}); |
| 47 | +}; |
36 | 48 |
|
37 | | -gulp.task('sass:watch', function () { |
| 49 | +exports.buildStyles = buildStyles; |
| 50 | +exports.watch = function () { |
38 | 51 | gulp.watch('./sass/**/*.scss', ['sass']); |
39 | | -}); |
| 52 | +}; |
40 | 53 | ``` |
41 | 54 |
|
42 | | -You can also compile synchronously, doing something like this: |
43 | | - |
44 | | -```javascript |
45 | | -'use strict'; |
46 | | - |
47 | | -var gulp = require('gulp'); |
48 | | -var sass = require('gulp-sass'); |
49 | | - |
50 | | -sass.compiler = require('node-sass'); |
| 55 | +With synchronous rendering, that Gulp task looks like this: |
51 | 56 |
|
52 | | -gulp.task('sass', function () { |
| 57 | +``` javascript |
| 58 | +function buildStyles() { |
53 | 59 | return gulp.src('./sass/**/*.scss') |
54 | 60 | .pipe(sass.sync().on('error', sass.logError)) |
55 | 61 | .pipe(gulp.dest('./css')); |
56 | | -}); |
57 | | - |
58 | | -gulp.task('sass:watch', function () { |
59 | | - gulp.watch('./sass/**/*.scss', ['sass']); |
60 | | -}); |
| 62 | +}; |
61 | 63 | ``` |
62 | 64 |
|
63 | | -You can choose whether to use [Dart Sass][] or [Node Sass][] by setting the `sass.compiler` property. Node Sass will be used by default, but it's strongly recommended that you set it explicitly for forwards-compatibility in case the default ever changes. |
| 65 | +### Render with options |
64 | 66 |
|
65 | | -[Dart Sass]: http://sass-lang.com/dart-sass |
66 | | -[Node Sass]: https://github.com/sass/node-sass |
| 67 | +To change the final output of your CSS, you can pass an options object to your renderer. `gulp-sass` supports [Node Sass's render options](https://github.com/sass/node-sass#options), with two unsupported exceptions: |
67 | 68 |
|
68 | | -Note that when using Dart Sass, **synchronous compilation is twice as fast as asynchronous compilation** by default, due to the overhead of asynchronous callbacks. To avoid this overhead, you can use the [`fibers`](https://www.npmjs.com/package/fibers) package to call asynchronous importers from the synchronous code path. To enable this, pass the `Fiber` class to the `fiber` option: |
| 69 | +- The `data` option, which is used by `gulp-sass` internally. |
| 70 | +- The `file` option, which has undefined behavior that may change without notice. |
| 71 | + |
| 72 | +For example, to compress your CSS, you can call `sass({outputStyle: 'compressed'}`. In the context of a Gulp task, that looks like this: |
69 | 73 |
|
70 | 74 | ```javascript |
71 | | -'use strict'; |
| 75 | +function buildStyles() { |
| 76 | + return gulp.src('./sass/**/*.scss') |
| 77 | + .pipe(sass({outputStyle: 'compressed'}).on('error', sass.logError)) |
| 78 | + .pipe(gulp.dest('./css')); |
| 79 | +}; |
72 | 80 |
|
73 | | -var Fiber = require('fibers'); |
74 | | -var gulp = require('gulp'); |
75 | | -var sass = require('gulp-sass'); |
| 81 | +exports.buildStyles = buildStyles; |
| 82 | +``` |
76 | 83 |
|
77 | | -sass.compiler = require('sass'); |
| 84 | +Or this for synchronous rendering: |
78 | 85 |
|
79 | | -gulp.task('sass', function () { |
| 86 | +```javascript |
| 87 | +function buildStyles() { |
80 | 88 | return gulp.src('./sass/**/*.scss') |
81 | | - .pipe(sass({fiber: Fiber}).on('error', sass.logError)) |
| 89 | + .pipe(sass.sync({outputStyle: 'compressed'}).on('error', sass.logError)) |
82 | 90 | .pipe(gulp.dest('./css')); |
83 | | -}); |
| 91 | +}; |
84 | 92 |
|
85 | | -gulp.task('sass:watch', function () { |
86 | | - gulp.watch('./sass/**/*.scss', ['sass']); |
87 | | -}); |
| 93 | +exports.buildStyles = buildStyles; |
88 | 94 | ``` |
89 | 95 |
|
90 | | -## Options |
91 | | - |
92 | | -Pass in options just like you would for [Node Sass](https://github.com/sass/node-sass#options); they will be passed along just as if you were using Node Sass. Except for the `data` option which is used by gulp-sass internally. Using the `file` option is also unsupported and results in undefined behaviour that may change without notice. |
| 96 | +### Include a source map |
93 | 97 |
|
94 | | -For example: |
| 98 | +`gulp-sass` can be used in tandem with [`gulp-sourcemaps`](https://github.com/floridoo/gulp-sourcemaps) to generate source maps for the Sass-to-CSS compilation. You will need to initialize `gulp-sourcemaps` _before_ running `gulp-sass`, and write the source maps after. |
95 | 99 |
|
96 | 100 | ```javascript |
97 | | -gulp.task('sass', function () { |
98 | | - return gulp.src('./sass/**/*.scss') |
99 | | - .pipe(sass({outputStyle: 'compressed'}).on('error', sass.logError)) |
100 | | - .pipe(gulp.dest('./css')); |
101 | | -}); |
| 101 | +var sourcemaps = require('gulp-sourcemaps'); |
| 102 | + |
| 103 | +function buildStyles() { |
| 104 | + return gulp.src('./sass/**/*.scss') |
| 105 | + .pipe(sourcemaps.init()) |
| 106 | + .pipe(sass().on('error', sass.logError)) |
| 107 | + .pipe(sourcemaps.write()) |
| 108 | + .pipe(gulp.dest('./css')); |
| 109 | +} |
| 110 | + |
| 111 | +exports.buildStyles = buildStyles; |
102 | 112 | ``` |
103 | 113 |
|
104 | | -Or this for synchronous code: |
| 114 | +By default, `gulp-sourcemaps` writes the source maps inline, in the compiled CSS files. To write them to a separate file, specify a path relative to the `gulp.dest()` destination in the `sourcemaps.write()` function. |
105 | 115 |
|
106 | 116 | ```javascript |
107 | | -gulp.task('sass', function () { |
108 | | - return gulp.src('./sass/**/*.scss') |
109 | | - .pipe(sass.sync({outputStyle: 'compressed'}).on('error', sass.logError)) |
110 | | - .pipe(gulp.dest('./css')); |
111 | | -}); |
| 117 | +var sourcemaps = require('gulp-sourcemaps'); |
| 118 | + |
| 119 | +function buildStyles() { |
| 120 | + return gulp.src('./sass/**/*.scss') |
| 121 | + .pipe(sourcemaps.init()) |
| 122 | + .pipe(sass().on('error', sass.logError)) |
| 123 | + .pipe(sourcemaps.write('./maps')) |
| 124 | + .pipe(gulp.dest('./css')); |
| 125 | +}; |
| 126 | + |
| 127 | +exports.buildStyles = buildStyles; |
112 | 128 | ``` |
113 | 129 |
|
114 | | -## Source Maps |
| 130 | +<h2 id="migrating-to-version-5">Migrating to version 5</h2> |
115 | 131 |
|
116 | | -`gulp-sass` can be used in tandem with [gulp-sourcemaps](https://github.com/floridoo/gulp-sourcemaps) to generate source maps for the Sass to CSS compilation. You will need to initialize [gulp-sourcemaps](https://github.com/floridoo/gulp-sourcemaps) prior to running `gulp-sass` and write the source maps after. |
| 132 | +`gulp-sass` version 5 requires Node 12 or later, and introduces some breaking changes. Additionally, changes in Node itself mean that we should no longer use Node fibers to speed up asynchronous rendering with Dart Sass. |
117 | 133 |
|
118 | | -```javascript |
119 | | -var sourcemaps = require('gulp-sourcemaps'); |
| 134 | +### Setting a Sass compiler |
120 | 135 |
|
121 | | -gulp.task('sass', function () { |
122 | | - return gulp.src('./sass/**/*.scss') |
123 | | - .pipe(sourcemaps.init()) |
124 | | - .pipe(sass().on('error', sass.logError)) |
125 | | - .pipe(sourcemaps.write()) |
126 | | - .pipe(gulp.dest('./css')); |
127 | | -}); |
| 136 | +As of version 5, `gulp-sass` _does not include a default Sass compiler_, so you must install one (either `node-sass` or `sass`) along with `gulp-sass`. |
| 137 | + |
| 138 | +``` |
| 139 | +npm install sass gulp-sass --save-dev |
128 | 140 | ``` |
129 | 141 |
|
130 | | -By default, [gulp-sourcemaps](https://github.com/floridoo/gulp-sourcemaps) writes the source maps inline in the compiled CSS files. To write them to a separate file, specify a path relative to the `gulp.dest()` destination in the `sourcemaps.write()` function. |
| 142 | +Then, you must explicitly set that compiler in your gulpfille. Instead of setting a `compiler` prop on the `gulp-sass` instance, you pass the compiler into a function call when instantiating `gulp-sass`. |
131 | 143 |
|
132 | | -```javascript |
133 | | -var sourcemaps = require('gulp-sourcemaps'); |
134 | | -gulp.task('sass', function () { |
135 | | - return gulp.src('./sass/**/*.scss') |
136 | | - .pipe(sourcemaps.init()) |
137 | | - .pipe(sass().on('error', sass.logError)) |
138 | | - .pipe(sourcemaps.write('./maps')) |
139 | | - .pipe(gulp.dest('./css')); |
140 | | -}); |
| 144 | +These changes look something like this: |
| 145 | + |
| 146 | +``` diff |
| 147 | +- var sass = require('gulp-sass')); |
| 148 | +- var compiler = require('sass'); |
| 149 | +- sass.compiler = compiler; |
| 150 | ++ var sass = require('gulp-sass')(require('sass')); |
141 | 151 | ``` |
142 | 152 |
|
143 | | -# Issues |
| 153 | +### What about fibers? |
144 | 154 |
|
145 | | -`gulp-sass` is a very light-weight wrapper around either [Dart Sass][] or [Node Sass][] (which in turn is a Node binding for [LibSass][]). Because of this, the issue you're having likely isn't a `gulp-sass` issue, but an issue with one those projects or with [Sass][] as a whole. |
| 155 | +We used to recommend Node fibers as a way to speed up asynchronous rendering with Dart Sass. Unfortunately, [Node fibers are discontinued](https://sass-lang.com/blog/node-fibers-discontinued). The Sass team is exploring its optons for future performance improvements, but for now you will get the best performance from `sass.sync()`. |
146 | 156 |
|
147 | | -[LibSass]: https://sass-lang.com/libsass |
148 | | -[Sass]: https://sass-lang.com |
| 157 | +## Issues |
| 158 | + |
| 159 | +`gulp-sass` is a light-weight wrapper around either [Dart Sass][] or [Node Sass][] (which in turn is a Node binding for [LibSass][]. Because of this, the issue you're having likely isn't a `gulp-sass` issue, but an issue with one those projects or with [Sass][] as a whole. |
149 | 160 |
|
150 | 161 | If you have a feature request/question how Sass works/concerns on how your Sass gets compiled/errors in your compiling, it's likely a Dart Sass or LibSass issue and you should file your issue with one of those projects. |
151 | 162 |
|
152 | 163 | If you're having problems with the options you're passing in, it's likely a Dart Sass or Node Sass issue and you should file your issue with one of those projects. |
153 | 164 |
|
154 | 165 | We may, in the course of resolving issues, direct you to one of these other projects. If we do so, please follow up by searching that project's issue queue (both open and closed) for your problem and, if it doesn't exist, filing an issue with them. |
| 166 | + |
| 167 | +[Dart Sass]: http://sass-lang.com/dart-sass |
| 168 | +[LibSass]: https://sass-lang.com/libsass |
| 169 | +[Node Sass]: https://github.com/sass/node-sass |
| 170 | +[Sass]: https://sass-lang.com |
0 commit comments