Compare commits

...

32 commits

Author SHA1 Message Date
selfisekai 06bd869e5d release 4.2.0 2020-11-06 14:46:25 +01:00
selfisekai 968c903c9f remove engine compatibility entry 2020-11-06 14:01:35 +01:00
selfisekai c256bbe4dd add gitlab ci 2020-11-06 13:59:31 +01:00
selfisekai b7569dd457 typescript typedefs 2020-11-06 12:24:32 +01:00
selfisekai 148502cd95 made dart sass default 2020-11-06 12:24:25 +01:00
selfisekai bcf64926b8 this is a fork 🔥 2020-11-05 23:40:12 +01:00
xzyfer 8d6ac29097 Update changelog 2020-04-23 20:26:33 +10:00
xzyfer 43c05476ed 4.1.0 2020-04-23 20:19:16 +10:00
Ken Newman ebe3ec6b5e
Set appropriate file stat times (#763)
* Set appropriate file stat times

Since we are creating the destination file, it's our responsibility to set the file stat times.

* fix code style
2020-04-23 13:12:23 +10:00
Christophe Coevoet 7ab018e367 Migrate to the lodash package
The modularized lodash packages are unmaintained since 2 years, lagging a lot
behind the main lodash package. Partial imports of lodash are the preferred
way.
2019-08-05 21:13:31 +10:00
xzyfer fa670c64b2 4.0.2 2018-10-16 19:00:47 +11:00
xzyfer fefa00e707 Revert package.json version bump 2018-10-16 19:00:43 +11:00
Natalie Weizenbaum 98254d2d0d Fix README typos 2018-10-16 17:57:46 +10:00
Natalie Weizenbaum 8a14419856 Continue loading Node Sass by default
This documents the option to use Dart Sass, and encourages users to
explicitly choose their implementation, but it doesn't change the
existing behavior.
2018-10-16 17:57:46 +10:00
Natalie Weizenbaum 938afbe3dc Add a note about synchronous versus asynchronous speed 2018-10-16 17:57:46 +10:00
Natalie Weizenbaum 7cc2db1168 Make this package implementation-agnostic
Rather than always loading Node Sass, this now requires users to pass
in either Dart Sass or Node Sass to the require() call.

Closes #672
2018-10-16 17:57:46 +10:00
Jacob Francis Powers 643f73b64a Add documentation for synchronous code options
It's not clearly documented how to add options to sass.sync, and this is implemented inconsistently across other code infrastructures, so it's not safe to assume whether it's `sass(options).sync()` or `sass.sync(options)` please accept the pull request if the proposed documentation is correct, or otherwise accept it anyways and provide a follow up merge as an update fix.
2018-05-23 09:39:48 +02:00
xzyfer 0b3c7e7b83 4.0.1 2018-04-08 13:11:09 +10:00
Michael Mifsud daca90dd95
Merge pull request #681 from DKvistgaard/master
Declaring logError as function instead of arrow function.
2018-04-08 13:10:17 +10:00
Daniel Kvistgaard 71471c2d2c Declaring logError as function instead of arrow function. 2018-04-08 13:05:50 +10:00
xzyfer 450a7b8b4f 4.0.0 2018-04-05 21:10:27 +10:00
Michael Mifsud e9b1fe8d42
Fix node versions in appveyor.yml 2018-04-05 21:08:06 +10:00
Michael Mifsud 44be409bd9
Merge pull request #667 from dlmanning/next
Drop support for non-Active LTS and Current releases
2018-04-05 16:02:00 +10:00
xzyfer 7656eff297 Adopt airbnb eslint preset 2018-03-24 12:55:37 +11:00
xzyfer 12931694be Bump autoprefixer@^8.1.0, gulp-postcss@^7.0.1 2018-03-24 12:55:37 +11:00
xzyfer 9fa817b8c4 Bump gulp-sourcemaps@^2.6.4 2018-03-24 12:55:37 +11:00
xzyfer a0576953ad Bump should@^13.2.1 2018-03-24 12:55:37 +11:00
xzyfer 549d7ba9aa Bump mocha@^5.0.4 2018-03-24 12:55:37 +11:00
Charles Samborski e61535250e Drop dependency on deprecated gulp-util
Closes dlmanning/gulp-sass#646
2018-03-24 12:55:35 +11:00
xzyfer 9a8a8797ca Drop support for non-active lts and current release
Closes #649
2018-03-24 12:55:07 +11:00
Michael Mifsud 04fb925e40
3.2.1 2018-03-24 11:33:28 +11:00
Michael Mifsud ff8b225245
Bump node-sass@^4.8.3
Make the latest stable node-sass the minimum.
2018-03-24 11:33:10 +11:00
13 changed files with 5307 additions and 620 deletions

156
.eslintrc
View file

@ -4,159 +4,9 @@ env:
mocha: true
node: true
# globals:
#########################
## Only add globals if you're absolutely certain they need to be globals
##########################
# console: true
#########################
## set to 0 to allow
## set to 1 to disallow as warning
## set to 2 to disallow as error
#########################
rules:
#########################
## Optional Rules
#########################
# Disallow use of `console`
no-console: 2
# Disallow warning comments
no-warning-comments:
- 1
- terms:
- todo
- fixme
location: anywhere
# Warns when variables are defined but never used
no-unused-vars: 1
# Enforces comma style (first or last)
comma-style:
max-len:
- 2
- last
- 120
# Enforces one true `this` variable
consistent-this:
- 2
- self
# Allows dangling underscores in identifiers
no-underscore-dangle: 2
# Enforces function expressions to have a name
func-names: 0
# Set maximum depth of nested callbacks
max-nested-callbacks:
- 1
- 3
#########################
## Core Rules
##########################
# Enforces camel case names
camelcase: 2
# Prohibit use of == and != in favor of === and !==
eqeqeq: 2
# Suppresses warnings about == null comparisons
no-eq-null: 2
# No mixing tabs and spaces, with 2 spaces only
no-mixed-spaces-and-tabs: 2
# Prohibits use of a variable before it is defined
no-use-before-define: 2
# Requires capitalized names for constructor functions
new-cap: 2
# Prohibits use of explicitly undeclared variables
no-undef: 2
# Enforces Use Strict at the top of function scope
strict:
- 2
- global
# Requires variable declarations to be at the top
vars-on-top: 2
# Enforce curly braces around blocks in loops and conditionals
curly: 2
# Prohibits the use of immediate function invocations w/o wrapping in parentheses
wrap-iife: 2
# Prohibits `argument.caller` and `argument.callee`
no-caller: 2
# Requires all `for in` loops to filter object's items
guard-for-in: 2
# Prohibits comparing a variable against itself
no-self-compare: 2
# Prohibits use of `undefined` variable
no-undefined: 0
# Prohibits nested ternaries
no-nested-ternary: 2
# Enforces a space before blocks
space-before-blocks:
- 2
- always
# Enforces spaces following keywords
keyword-spacing:
- 2
- after: true
# Enforces quoted property names
quote-props:
- 2
- always
# Enforces padded blocks
padded-blocks:
- 1
- never
# Enforce functions as expressions
func-style:
- 2
- expression
# Require brace style
brace-style:
- 2
- stroustrup
# Prohibits Yoda conditions
yoda:
- 2
- never
# Enforce use of single quotation marks for strings.
quotes:
- 2
- single
# Disallow or enforce spaces inside of curly braces in objects.
object-curly-spacing:
- 2
- always
# Disallow or enforce spaces inside of brackets.
array-bracket-spacing:
- 2
- never
# Disallow or enforce spaces inside of computed properties.
computed-property-spacing:
- 2
- never
extends: "airbnb-base"

25
.gitlab-ci.yml Normal file
View file

@ -0,0 +1,25 @@
default:
before_script:
- yarn
node12:
image: node:12
allow_failure: true
script:
- yarn test
node13:
image: node:13
allow_failure: true
script:
- yarn test
node14:
image: node:14
script:
- yarn test
node15:
image: node:15
script:
- yarn test

View file

@ -1,6 +1,8 @@
language: node_js
node_js:
- "0.10"
- node
- iojs
sudo: false
language: node_js
node_js:
- lts/boron
- lts/carbon
- current

View file

@ -1,10 +1,45 @@
# Gulp Sass Changelog
## v4.2.0
**November 6, 2020**
https://git.sakamoto.pl/selfisekai/gulp-sass/-/tags/v4.2.0
## v4.1.0
**April 23, 2020**
https://github.com/dlmanning/gulp-sass/releases/tag/v4.1.0
## v4.0.2
**October 16, 2018**
https://github.com/dlmanning/gulp-sass/releases/tag/v4.0.2
## v4.0.1
**Apr 8, 2018**
https://github.com/dlmanning/gulp-sass/releases/tag/v4.0.1
## v4.0.0
**April 5, 2018**
https://github.com/dlmanning/gulp-sass/releases/tag/v4.0.0
## v3.2.1
**March 24, 2018**
https://github.com/dlmanning/gulp-sass/releases/tag/v3.2.1
## v3.2.0
**March 11, 2018**
**March 12, 2018**
https://github.com/dlmanning/gulp-sass/releases/tag/v3.2.0
## v3.1.0
**January 9, 2017**
https://github.com/dlmanning/gulp-sass/releases/tag/v3.1.0
## v3.0.0
**January 9, 2017**

177
LICENSE
View file

@ -1,20 +1,165 @@
The MIT License (MIT)
GNU LESSER GENERAL PUBLIC LICENSE
Version 3, 29 June 2007
Copyright (c) 2013 David Manning
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
the Software, and to permit persons to whom the Software is furnished to do so,
subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
This version of the GNU Lesser General Public License incorporates
the terms and conditions of version 3 of the GNU General Public
License, supplemented by the additional permissions listed below.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
0. Additional Definitions.
As used herein, "this License" refers to version 3 of the GNU Lesser
General Public License, and the "GNU GPL" refers to version 3 of the GNU
General Public License.
"The Library" refers to a covered work governed by this License,
other than an Application or a Combined Work as defined below.
An "Application" is any work that makes use of an interface provided
by the Library, but which is not otherwise based on the Library.
Defining a subclass of a class defined by the Library is deemed a mode
of using an interface provided by the Library.
A "Combined Work" is a work produced by combining or linking an
Application with the Library. The particular version of the Library
with which the Combined Work was made is also called the "Linked
Version".
The "Minimal Corresponding Source" for a Combined Work means the
Corresponding Source for the Combined Work, excluding any source code
for portions of the Combined Work that, considered in isolation, are
based on the Application, and not on the Linked Version.
The "Corresponding Application Code" for a Combined Work means the
object code and/or source code for the Application, including any data
and utility programs needed for reproducing the Combined Work from the
Application, but excluding the System Libraries of the Combined Work.
1. Exception to Section 3 of the GNU GPL.
You may convey a covered work under sections 3 and 4 of this License
without being bound by section 3 of the GNU GPL.
2. Conveying Modified Versions.
If you modify a copy of the Library, and, in your modifications, a
facility refers to a function or data to be supplied by an Application
that uses the facility (other than as an argument passed when the
facility is invoked), then you may convey a copy of the modified
version:
a) under this License, provided that you make a good faith effort to
ensure that, in the event an Application does not supply the
function or data, the facility still operates, and performs
whatever part of its purpose remains meaningful, or
b) under the GNU GPL, with none of the additional permissions of
this License applicable to that copy.
3. Object Code Incorporating Material from Library Header Files.
The object code form of an Application may incorporate material from
a header file that is part of the Library. You may convey such object
code under terms of your choice, provided that, if the incorporated
material is not limited to numerical parameters, data structure
layouts and accessors, or small macros, inline functions and templates
(ten or fewer lines in length), you do both of the following:
a) Give prominent notice with each copy of the object code that the
Library is used in it and that the Library and its use are
covered by this License.
b) Accompany the object code with a copy of the GNU GPL and this license
document.
4. Combined Works.
You may convey a Combined Work under terms of your choice that,
taken together, effectively do not restrict modification of the
portions of the Library contained in the Combined Work and reverse
engineering for debugging such modifications, if you also do each of
the following:
a) Give prominent notice with each copy of the Combined Work that
the Library is used in it and that the Library and its use are
covered by this License.
b) Accompany the Combined Work with a copy of the GNU GPL and this license
document.
c) For a Combined Work that displays copyright notices during
execution, include the copyright notice for the Library among
these notices, as well as a reference directing the user to the
copies of the GNU GPL and this license document.
d) Do one of the following:
0) Convey the Minimal Corresponding Source under the terms of this
License, and the Corresponding Application Code in a form
suitable for, and under terms that permit, the user to
recombine or relink the Application with a modified version of
the Linked Version to produce a modified Combined Work, in the
manner specified by section 6 of the GNU GPL for conveying
Corresponding Source.
1) Use a suitable shared library mechanism for linking with the
Library. A suitable mechanism is one that (a) uses at run time
a copy of the Library already present on the user's computer
system, and (b) will operate properly with a modified version
of the Library that is interface-compatible with the Linked
Version.
e) Provide Installation Information, but only if you would otherwise
be required to provide such information under section 6 of the
GNU GPL, and only to the extent that such information is
necessary to install and execute a modified version of the
Combined Work produced by recombining or relinking the
Application with a modified version of the Linked Version. (If
you use option 4d0, the Installation Information must accompany
the Minimal Corresponding Source and Corresponding Application
Code. If you use option 4d1, you must provide the Installation
Information in the manner specified by section 6 of the GNU GPL
for conveying Corresponding Source.)
5. Combined Libraries.
You may place library facilities that are a work based on the
Library side by side in a single library together with other library
facilities that are not Applications and are not covered by this
License, and convey such a combined library under terms of your
choice, if you do both of the following:
a) Accompany the combined library with a copy of the same work based
on the Library, uncombined with any other library facilities,
conveyed under the terms of this License.
b) Give prominent notice with the combined library that part of it
is a work based on the Library, and explaining where to find the
accompanying uncombined form of the same work.
6. Revised Versions of the GNU Lesser General Public License.
The Free Software Foundation may publish revised and/or new versions
of the GNU Lesser General Public License from time to time. Such new
versions will be similar in spirit to the present version, but may
differ in detail to address new problems or concerns.
Each version is given a distinguishing version number. If the
Library as you received it specifies that a certain numbered version
of the GNU Lesser General Public License "or any later version"
applies to it, you have the option of following the terms and
conditions either of that published version or of any later version
published by the Free Software Foundation. If the Library as you
received it does not specify a version number of the GNU Lesser
General Public License, you may choose any version of the GNU Lesser
General Public License ever published by the Free Software Foundation.
If the Library as you received it specifies that a proxy can decide
whether future versions of the GNU Lesser General Public License shall
apply, that proxy's public statement of acceptance of any version is
permanent authorization for you to choose that version for the
Library.

View file

@ -1,13 +1,19 @@
# gulp-sass [![Build Status](https://travis-ci.org/dlmanning/gulp-sass.svg?branch=master)](https://travis-ci.org/dlmanning/gulp-sass) [![Join the chat at https://gitter.im/dlmanning/gulp-sass](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/dlmanning/gulp-sass?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) [![npm version](https://badge.fury.io/js/gulp-sass.svg)](http://badge.fury.io/js/gulp-sass)
# gulp-sass
Sass plugin for [Gulp](https://github.com/gulpjs/gulp).
**_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._**
This is a fork of [David Manning's Gulp Sass](https://github.com/dlmanning/gulp-sass).
# Support
Only [Active LTS and Current releases][1] are supported.
[1]: https://github.com/nodejs/Release#release-schedule
# Install
```
npm install gulp-sass --save-dev
yarn add --dev sass @selfisekai/gulp-sass
```
# Basic Usage
@ -17,16 +23,18 @@ Something like this will compile your Sass files:
```javascript
'use strict';
var gulp = require('gulp');
var sass = require('gulp-sass');
const gulp = require('gulp');
const sass = require('@selfisekai/gulp-sass');
gulp.task('sass', function () {
sass.compiler = require('sass');
gulp.task('sass', () => {
return gulp.src('./sass/**/*.scss')
.pipe(sass().on('error', sass.logError))
.pipe(gulp.dest('./css'));
});
gulp.task('sass:watch', function () {
gulp.task('sass:watch', () => {
gulp.watch('./sass/**/*.scss', ['sass']);
});
```
@ -36,42 +44,66 @@ You can also compile synchronously, doing something like this:
```javascript
'use strict';
var gulp = require('gulp');
var sass = require('gulp-sass');
const gulp = require('gulp');
const sass = require('@selfisekai/gulp-sass');
gulp.task('sass', function () {
sass.compiler = require('sass');
gulp.task('sass', () => {
return gulp.src('./sass/**/*.scss')
.pipe(sass.sync().on('error', sass.logError))
.pipe(gulp.dest('./css'));
});
gulp.task('sass:watch', function () {
gulp.task('sass:watch', () => {
gulp.watch('./sass/**/*.scss', ['sass']);
});
```
You can choose whether to use [Dart Sass][] or [Node Sass][] by setting the `sass.compiler` property. Dart 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.
Compiler | Maintained | No installation problems
------------|------------|-------------------------
[Dart Sass] | yes | yes
[Node Sass] | no | no
[Dart Sass]: http://sass-lang.com/dart-sass
[Node Sass]: https://github.com/sass/node-sass
Note that when using Dart Sass, **synchronous compilation is twice as fast as asynchronous compilation** by default, due to the overhead of asynchronous callbacks.
## Options
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.
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.
For example:
```javascript
gulp.task('sass', function () {
gulp.task('sass', () => {
return gulp.src('./sass/**/*.scss')
.pipe(sass({outputStyle: 'compressed'}).on('error', sass.logError))
.pipe(gulp.dest('./css'));
});
```
Or this for synchronous code:
```javascript
gulp.task('sass', () => {
return gulp.src('./sass/**/*.scss')
.pipe(sass.sync({outputStyle: 'compressed'}).on('error', sass.logError))
.pipe(gulp.dest('./css'));
});
```
## Source Maps
`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.
```javascript
var sourcemaps = require('gulp-sourcemaps');
const sourcemaps = require('gulp-sourcemaps');
gulp.task('sass', function () {
gulp.task('sass', () => {
return gulp.src('./sass/**/*.scss')
.pipe(sourcemaps.init())
.pipe(sass().on('error', sass.logError))
@ -83,8 +115,8 @@ gulp.task('sass', function () {
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.
```javascript
var sourcemaps = require('gulp-sourcemaps');
gulp.task('sass', function () {
const sourcemaps = require('gulp-sourcemaps');
gulp.task('sass', () => {
return gulp.src('./sass/**/*.scss')
.pipe(sourcemaps.init())
.pipe(sass().on('error', sass.logError))
@ -95,10 +127,13 @@ gulp.task('sass', function () {
# Issues
`gulp-sass` is a very light-weight wrapper around [`node-sass`](https://github.com/sass/node-sass), which in turn is a Node binding for [`libsass`](https://github.com/sass/libsass), which in turn is a port of [`Sass`](https://github.com/sass/sass). Because of this, the issue you're having likely isn't a `gulp-sass` issue, but an issue with one of those three projects.
`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.
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 `libsass` or `Sass` issue and you should file your issue with one of those projects.
[LibSass]: https://sass-lang.com/libsass
[Sass]: https://sass-lang.com
If you're having problems with the options you're passing in, it's likely a `node-sass` or `libsass` issue and you should file your issue with one of those projects.
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.
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.
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.

View file

@ -11,9 +11,6 @@ platform:
environment:
matrix:
- nodejs_version: 0.10
- nodejs_version: 0.12
- nodejs_version: 4
- nodejs_version: 6
- nodejs_version: 8
- nodejs_version: 9

44
index.d.ts vendored Normal file
View file

@ -0,0 +1,44 @@
// Type definitions originally for gulp-sass 4.0.2
// Project: https://github.com/dlmanning/gulp-sass
// Definitions by: Asana <https://asana.com>
// Yuma Hashimoto <https://github.com/yuma84>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
// TypeScript Version: 2.7
/// <reference types="node"/>
import { Options } from 'sass';
interface SassResults {
css: string;
map: string;
stats: {
entry: string;
start: Date;
end: Date;
duration: number;
includedFiles: string[];
}
}
interface SassOptions extends Options {
success?: (results: SassResults) => any;
error?: (err: Error) => any;
imagePaths?: string[];
}
interface GulpSassOptions extends SassOptions {
errLogToConsole?: boolean;
onSuccess?: (css: string) => any;
onError?: (err: Error) => any;
sync?: boolean;
}
interface Sass {
(opts?: GulpSassOptions): NodeJS.ReadWriteStream;
logError(error?: string): void;
sync(options?: GulpSassOptions): NodeJS.ReadWriteStream;
}
declare var _tmp: Sass;
export = _tmp;

312
index.js
View file

@ -1,189 +1,183 @@
'use strict';
/* eslint-disable global-require */
/* eslint-disable import/no-extraneous-dependencies */
var gutil = require('gulp-util');
var through = require('through2');
var clonedeep = require('lodash.clonedeep');
var path = require('path');
var applySourceMap = require('vinyl-sourcemaps-apply');
const chalk = require('chalk');
const PluginError = require('plugin-error');
const replaceExtension = require('replace-ext');
const stripAnsi = require('strip-ansi');
const through = require('through2');
const clonedeep = require('lodash/cloneDeep');
const path = require('path');
const applySourceMap = require('vinyl-sourcemaps-apply');
var PLUGIN_NAME = 'gulp-sass';
const PLUGIN_NAME = 'gulp-sass';
//////////////////////////////
// ////////////////////////////
// Main Gulp Sass function
//////////////////////////////
var gulpSass = function gulpSass(options, sync) {
return through.obj(function(file, enc, cb) {
var opts,
filePush,
errorM,
callback,
result;
// ////////////////////////////
const gulpSass = (options, sync) => through.obj((file, enc, cb) => { // eslint-disable-line consistent-return
if (file.isNull()) {
return cb(null, file);
}
if (file.isNull()) {
return cb(null, file);
}
if (file.isStream()) {
return cb(new gutil.PluginError(PLUGIN_NAME, 'Streaming not supported'));
}
if (path.basename(file.path).indexOf('_') === 0) {
return cb();
}
if (!file.contents.length) {
file.path = gutil.replaceExtension(file.path, '.css');
return cb(null, file);
if (file.isStream()) {
return cb(new PluginError(PLUGIN_NAME, 'Streaming not supported'));
}
if (path.basename(file.path).indexOf('_') === 0) {
return cb();
}
if (!file.contents.length) {
file.path = replaceExtension(file.path, '.css'); // eslint-disable-line no-param-reassign
return cb(null, file);
}
const opts = clonedeep(options || {});
opts.data = file.contents.toString();
// we set the file path here so that libsass can correctly resolve import paths
opts.file = file.path;
// Ensure `indentedSyntax` is true if a `.sass` file
if (path.extname(file.path) === '.sass') {
opts.indentedSyntax = true;
}
// Ensure file's parent directory in the include path
if (opts.includePaths) {
if (typeof opts.includePaths === 'string') {
opts.includePaths = [opts.includePaths];
}
} else {
opts.includePaths = [];
}
opts.includePaths.unshift(path.dirname(file.path));
opts = clonedeep(options || {});
opts.data = file.contents.toString();
// Generate Source Maps if plugin source-map present
if (file.sourceMap) {
opts.sourceMap = file.path;
opts.omitSourceMapUrl = true;
opts.sourceMapContents = true;
}
// we set the file path here so that libsass can correctly resolve import paths
opts.file = file.path;
// ////////////////////////////
// Handles returning the file to the stream
// ////////////////////////////
const filePush = (sassObj) => {
let sassMap;
let sassMapFile;
let sassFileSrc;
let sassFileSrcPath;
let sourceFileIndex;
// Ensure `indentedSyntax` is true if a `.sass` file
if (path.extname(file.path) === '.sass') {
opts.indentedSyntax = true;
}
// Ensure file's parent directory in the include path
if (opts.includePaths) {
if (typeof opts.includePaths === 'string') {
opts.includePaths = [opts.includePaths];
}
}
else {
opts.includePaths = [];
}
opts.includePaths.unshift(path.dirname(file.path));
// Generate Source Maps if plugin source-map present
if (file.sourceMap) {
opts.sourceMap = file.path;
opts.omitSourceMapUrl = true;
opts.sourceMapContents = true;
}
//////////////////////////////
// Handles returning the file to the stream
//////////////////////////////
filePush = function filePush(sassObj) {
var sassMap,
sassMapFile,
sassFileSrc,
sassFileSrcPath,
sourceFileIndex;
// Build Source Maps!
if (sassObj.map) {
// Transform map into JSON
sassMap = JSON.parse(sassObj.map.toString());
// Grab the stdout and transform it into stdin
sassMapFile = sassMap.file.replace(/^stdout$/, 'stdin');
// Grab the base file name that's being worked on
sassFileSrc = file.relative;
// Grab the path portion of the file that's being worked on
sassFileSrcPath = path.dirname(sassFileSrc);
if (sassFileSrcPath) {
// Prepend the path to all files in the sources array except the file that's being worked on
sourceFileIndex = sassMap.sources.indexOf(sassMapFile);
sassMap.sources = sassMap.sources.map(function(source, index) {
return (index === sourceFileIndex) ? source : path.join(sassFileSrcPath, source);
});
}
// Remove 'stdin' from souces and replace with filenames!
sassMap.sources = sassMap.sources.filter(function(src) {
if (src !== 'stdin') {
return src;
}
// Build Source Maps!
if (sassObj.map) {
// Transform map into JSON
sassMap = JSON.parse(sassObj.map.toString());
// Grab the stdout and transform it into stdin
sassMapFile = sassMap.file.replace(/^stdout$/, 'stdin');
// Grab the base file name that's being worked on
sassFileSrc = file.relative;
// Grab the path portion of the file that's being worked on
sassFileSrcPath = path.dirname(sassFileSrc);
if (sassFileSrcPath) {
// Prepend the path to all files in the sources array except the file that's being worked on
sourceFileIndex = sassMap.sources.indexOf(sassMapFile);
sassMap.sources = sassMap.sources.map((source, index) => { // eslint-disable-line arrow-body-style
return index === sourceFileIndex ? source : path.join(sassFileSrcPath, source);
});
// Replace the map file with the original file name (but new extension)
sassMap.file = gutil.replaceExtension(sassFileSrc, '.css');
// Apply the map
applySourceMap(file, sassMap);
}
file.contents = sassObj.css;
file.path = gutil.replaceExtension(file.path, '.css');
// Remove 'stdin' from souces and replace with filenames!
sassMap.sources = sassMap.sources.filter(src => src !== 'stdin' && src);
cb(null, file);
};
//////////////////////////////
// Handles error message
//////////////////////////////
errorM = function errorM(error) {
var relativePath = '',
filePath = error.file === 'stdin' ? file.path : error.file,
message = '';
filePath = filePath ? filePath : file.path;
relativePath = path.relative(process.cwd(), filePath);
message += gutil.colors.underline(relativePath) + '\n';
message += error.formatted;
error.messageFormatted = message;
error.messageOriginal = error.message;
error.message = gutil.colors.stripColor(message);
error.relativePath = relativePath;
return cb(new gutil.PluginError(
PLUGIN_NAME, error
));
};
if (sync !== true) {
//////////////////////////////
// Async Sass render
//////////////////////////////
callback = function(error, obj) {
if (error) {
return errorM(error);
}
filePush(obj);
};
gulpSass.compiler.render(opts, callback);
// Replace the map file with the original file name (but new extension)
sassMap.file = replaceExtension(sassFileSrc, '.css');
// Apply the map
applySourceMap(file, sassMap);
}
else {
//////////////////////////////
// Sync Sass render
//////////////////////////////
try {
result = gulpSass.compiler.renderSync(opts);
filePush(result);
}
catch (error) {
file.contents = sassObj.css; // eslint-disable-line no-param-reassign
file.path = replaceExtension(file.path, '.css'); // eslint-disable-line no-param-reassign
if (file.stat) {
file.stat.atime = file.stat.mtime = file.stat.ctime = new Date(); // eslint-disable-line
}
cb(null, file);
};
// ////////////////////////////
// Handles error message
// ////////////////////////////
const errorM = (error) => {
const filePath = (error.file === 'stdin' ? file.path : error.file) || file.path;
const relativePath = path.relative(process.cwd(), filePath);
const message = [chalk.underline(relativePath), error.formatted].join('\n');
error.messageFormatted = message; // eslint-disable-line no-param-reassign
error.messageOriginal = error.message; // eslint-disable-line no-param-reassign
error.message = stripAnsi(message); // eslint-disable-line no-param-reassign
error.relativePath = relativePath; // eslint-disable-line no-param-reassign
return cb(new PluginError(PLUGIN_NAME, error));
};
if (sync !== true) {
// ////////////////////////////
// Async Sass render
// ////////////////////////////
const callback = (error, obj) => { // eslint-disable-line consistent-return
if (error) {
return errorM(error);
}
filePush(obj);
};
gulpSass.compiler.render(opts, callback);
} else {
// ////////////////////////////
// Sync Sass render
// ////////////////////////////
try {
filePush(gulpSass.compiler.renderSync(opts));
} catch (error) {
return errorM(error);
}
});
};
}
});
//////////////////////////////
// ////////////////////////////
// Sync Sass render
//////////////////////////////
gulpSass.sync = function sync(options) {
return gulpSass(options, true);
};
// ////////////////////////////
gulpSass.sync = options => gulpSass(options, true);
//////////////////////////////
// ////////////////////////////
// Log errors nicely
//////////////////////////////
// ////////////////////////////
gulpSass.logError = function logError(error) {
var message = new gutil.PluginError('sass', error.messageFormatted).toString();
process.stderr.write(message + '\n');
const message = new PluginError('sass', error.messageFormatted).toString();
process.stderr.write(`${message}\n`);
this.emit('end');
};
//////////////////////////////
// ////////////////////////////
// Store compiler in a prop
//////////////////////////////
gulpSass.compiler = require('node-sass');
// ////////////////////////////
gulpSass.compiler = (() => {
try {
// eslint-disable-next-line global-require import/no-extraneous-dependencies
return require('sass');
} catch (e1) {
try {
// eslint-disable-next-line global-require import/no-extraneous-dependencies
return require('node-sass');
} catch (e2) {
throw new Error(`${PLUGIN_NAME}: you need either sass or node-sass module in your project`);
}
}
})();
module.exports = gulpSass;

View file

@ -1,42 +1,55 @@
{
"name": "gulp-sass",
"version": "3.2.0",
"description": "Gulp plugin for sass",
"name": "@selfisekai/gulp-sass",
"version": "4.2.0",
"description": "Gulp plugin for sass (forked)",
"main": "index.js",
"scripts": {
"test": "./node_modules/.bin/mocha test"
"test": "yarn mocha test"
},
"repository": {
"type": "git",
"url": "git://github.com/dlmanning/gulp-sass"
"url": "https://git.sakamoto.pl/selfisekai/gulp-sass.git"
},
"keywords": [
"gulpplugin",
"sass",
"gulp"
],
"author": "David Manning",
"license": "MIT",
"author": "Laura Liberda (originally: David Manning)",
"license": "LGPL-3.0",
"bugs": {
"url": "https://github.com/dlmanning/gulp-sass/issues"
"email": "gulp-sass@selfisekai.rocks"
},
"publishConfig": {
"access": "public",
"registry": "https://registry.npmjs.org/"
},
"dependencies": {
"gulp-util": "^3.0",
"lodash.clonedeep": "^4.3.2",
"node-sass": "^4.8.1",
"@types/sass": "^1.16.0",
"chalk": "^2.3.0",
"lodash": "^4.17.11",
"plugin-error": "^1.0.1",
"replace-ext": "^1.0.0",
"strip-ansi": "^4.0.0",
"through2": "^2.0.0",
"vinyl-sourcemaps-apply": "^0.2.0"
},
"devDependencies": {
"autoprefixer-core": "^5.2.1",
"eslint": "^2.9.0",
"@types/node-sass": "^4.11.1",
"autoprefixer": "^8.1.0",
"eslint": "^4.18.2",
"eslint-config-airbnb-base": "^12.1.0",
"eslint-plugin-import": "^2.9.0",
"globule": "^1.0.0",
"gulp": "^3.8.11",
"gulp-postcss": "^5.1.10",
"gulp-sourcemaps": "^1.5.2",
"gulp": "^4.0.2",
"gulp-postcss": "^7.0.1",
"gulp-sourcemaps": "^2.6.4",
"gulp-tap": "^0.1.3",
"mocha": "^2.2.1",
"mocha": "^5.0.4",
"node-sass": "^5.0.0",
"rimraf": "^2.4.3",
"should": "^8.3.1"
"sass": "^1.29.0",
"should": "^13.2.1",
"vinyl": "^2.1.0"
}
}

View file

@ -1,16 +1,12 @@
'use strict';
const eslint = require('eslint');
const should = require('should');
var eslint = require('eslint');
var should = require('should');
describe('code style guide', () => {
it('index.js should follow our lint style guide', (done) => {
const cli = new eslint.CLIEngine({ rules: { 'spaced-comment': 0 } });
const formatter = cli.getFormatter();
const report = cli.executeOnFiles(['index.js']);
var cli = new eslint.CLIEngine();
var formatter = cli.getFormatter();
var report;
describe('code style guide', function() {
it('index.js should follow our lint style guide', function(done) {
report = cli.executeOnFiles(['index.js']);
if (report.errorCount > 0 || report.warningCount > 0) {
console.log(formatter(report.results));
}
@ -20,8 +16,11 @@ describe('code style guide', function() {
done();
});
it('test/main.js should follow our lint style guide', function(done) {
report = cli.executeOnFiles(['test/main.js']);
it('test/main.js should follow our lint style guide', (done) => {
const cli = new eslint.CLIEngine();
const formatter = cli.getFormatter();
const report = cli.executeOnFiles(['test/main.js']);
if (report.errorCount > 0 || report.warningCount > 0) {
console.log(formatter(report.results));
}
@ -31,13 +30,11 @@ describe('code style guide', function() {
done();
});
it('test/lint.js should follow our lint style guide', function(done) {
cli = new eslint.CLIEngine({
'rules': {
'no-console': 0
}
});
report = cli.executeOnFiles(['test/lint.js']);
it('test/lint.js should follow our lint style guide', (done) => {
const cli = new eslint.CLIEngine({ rules: { 'no-console': 0 } });
const formatter = cli.getFormatter();
const report = cli.executeOnFiles(['test/lint.js']);
if (report.errorCount > 0 || report.warningCount > 0) {
console.log(formatter(report.results));
}

View file

@ -1,121 +1,108 @@
'use strict';
const should = require('should');
const Vinyl = require('vinyl');
const path = require('path');
const fs = require('fs');
const sass = require('../index');
sass.compiler = require('node-sass');
const rimraf = require('rimraf');
const gulp = require('gulp');
const sourcemaps = require('gulp-sourcemaps');
const postcss = require('gulp-postcss');
const autoprefixer = require('autoprefixer');
const tap = require('gulp-tap');
const globule = require('globule');
var should = require('should');
var gutil = require('gulp-util');
var path = require('path');
var fs = require('fs');
var sass = require('../index');
var rimraf = require('rimraf');
var gulp = require('gulp');
var sourcemaps = require('gulp-sourcemaps');
var postcss = require('gulp-postcss');
var autoprefixer = require('autoprefixer-core');
var tap = require('gulp-tap');
var globule = require('globule');
const createVinyl = (filename, contents) => {
const base = path.join(__dirname, 'scss');
const filePath = path.join(base, filename);
var createVinyl = function createVinyl(filename, contents) {
var base = path.join(__dirname, 'scss');
var filePath = path.join(base, filename);
return new gutil.File({
'cwd': __dirname,
'base': base,
'path': filePath,
'contents': contents || fs.readFileSync(filePath)
return new Vinyl({
cwd: __dirname,
base,
path: filePath,
contents: contents || fs.readFileSync(filePath),
});
};
var normaliseEOL = function(str) {
if (typeof(str) === 'object') {
str = str.toString('utf8');
}
const normaliseEOL = str => str.toString('utf8').replace(/\r\n/g, '\n');
return str.replace(/\r\n/g, '\n');
}
describe('test helpers', function() {
it('should normalise EOL', function(done) {
describe('test helpers', () => {
it('should normalise EOL', (done) => {
should.equal(normaliseEOL('foo\r\nbar'), 'foo\nbar');
should.equal(normaliseEOL('foo\nbar'), 'foo\nbar');
done();
});
});
describe('gulp-sass -- async compile', function() {
it('should pass file when it isNull()', function(done) {
var stream = sass();
var emptyFile = {
'isNull': function () {
return true;
}
describe('gulp-sass -- async compile', () => {
it('should pass file when it isNull()', (done) => {
const stream = sass();
const emptyFile = {
isNull: () => true,
};
stream.on('data', function(data) {
stream.on('data', (data) => {
data.should.equal(emptyFile);
done();
});
stream.write(emptyFile);
});
it('should emit error when file isStream()', function (done) {
var stream = sass();
var streamFile = {
'isNull': function () {
return false;
},
'isStream': function () {
return true;
}
it('should emit error when file isStream()', (done) => {
const stream = sass();
const streamFile = {
isNull: () => false,
isStream: () => true,
};
stream.on('error', function(err) {
stream.on('error', (err) => {
err.message.should.equal('Streaming not supported');
done();
});
stream.write(streamFile);
});
it('should compile an empty sass file', function(done) {
var sassFile = createVinyl('empty.scss');
var stream = sass();
stream.on('data', function(cssFile) {
it('should compile an empty sass file', (done) => {
const sassFile = createVinyl('empty.scss');
const stream = sass();
stream.on('data', (cssFile) => {
should.exist(cssFile);
should.exist(cssFile.path);
should.exist(cssFile.relative);
should.exist(cssFile.contents);
should.equal(path.basename(cssFile.path), 'empty.css');
String(normaliseEOL(cssFile.contents)).should.equal(
normaliseEOL(fs.readFileSync(path.join(__dirname, 'expected', 'empty.css'), 'utf8'))
);
const actual = fs.readFileSync(path.join(__dirname, 'expected', 'empty.css'), 'utf8');
String(normaliseEOL(cssFile.contents)).should.equal(normaliseEOL(actual));
done();
});
stream.write(sassFile);
});
it('should compile a single sass file', function(done) {
var sassFile = createVinyl('mixins.scss');
var stream = sass();
stream.on('data', function(cssFile) {
it('should compile a single sass file', (done) => {
const sassFile = createVinyl('mixins.scss');
const stream = sass();
stream.on('data', (cssFile) => {
should.exist(cssFile);
should.exist(cssFile.path);
should.exist(cssFile.relative);
should.exist(cssFile.contents);
String(normaliseEOL(cssFile.contents)).should.equal(
normaliseEOL(fs.readFileSync(path.join(__dirname, 'expected', 'mixins.css'), 'utf8'))
);
const actual = fs.readFileSync(path.join(__dirname, 'expected', 'mixins.css'), 'utf8');
String(normaliseEOL(cssFile.contents)).should.equal(normaliseEOL(actual));
done();
});
stream.write(sassFile);
});
it('should compile multiple sass files', function(done) {
var files = [
it('should compile multiple sass files', (done) => {
const files = [
createVinyl('mixins.scss'),
createVinyl('variables.scss')
createVinyl('variables.scss'),
];
var stream = sass();
var mustSee = files.length;
var expectedPath = path.join('expected', 'mixins.css');
const stream = sass();
let mustSee = files.length;
let expectedPath = path.join('expected', 'mixins.css');
stream.on('data', function(cssFile) {
stream.on('data', (cssFile) => {
should.exist(cssFile);
should.exist(cssFile.path);
should.exist(cssFile.relative);
@ -123,41 +110,51 @@ describe('gulp-sass -- async compile', function() {
if (cssFile.path.indexOf('variables') !== -1) {
expectedPath = path.join('expected', 'variables.css');
}
String(normaliseEOL(cssFile.contents)).should.equal(
normaliseEOL(fs.readFileSync(path.join(__dirname, expectedPath), 'utf8'))
);
mustSee--;
const actual = fs.readFileSync(path.join(__dirname, expectedPath), 'utf8');
String(normaliseEOL(cssFile.contents)).should.equal(normaliseEOL(actual));
mustSee -= 1;
if (mustSee <= 0) {
done();
}
});
files.forEach(function (file) {
files.forEach((file) => {
stream.write(file);
});
});
it('should compile files with partials in another folder', function(done) {
var sassFile = createVinyl('inheritance.scss');
var stream = sass();
stream.on('data', function(cssFile) {
it('should compile files with partials in another folder', (done) => {
const sassFile = createVinyl('inheritance.scss');
const stream = sass();
stream.on('data', (cssFile) => {
should.exist(cssFile);
should.exist(cssFile.path);
should.exist(cssFile.relative);
should.exist(cssFile.contents);
String(normaliseEOL(cssFile.contents)).should.equal(
normaliseEOL(fs.readFileSync(path.join(__dirname, 'expected', 'inheritance.css'), 'utf8'))
);
const actual = fs.readFileSync(path.join(__dirname, 'expected', 'inheritance.css'), 'utf8');
String(normaliseEOL(cssFile.contents)).should.equal(normaliseEOL(actual));
done();
});
stream.write(sassFile);
});
it('should handle sass errors', function(done) {
var errorFile = createVinyl('error.scss');
var stream = sass();
it('should emit logError on sass error', (done) => {
const errorFile = createVinyl('error.scss');
const stream = sass();
stream.on('error', function(err) {
stream.on('error', sass.logError);
stream.on('end', done);
stream.write(errorFile);
});
it('should handle sass errors', (done) => {
const errorFile = createVinyl('error.scss');
const stream = sass();
stream.on('error', (err) => {
// Error must include message body
err.message.indexOf('property "font" must be followed by a \':\'').should.not.equal(-1);
// Error must include file error occurs in
@ -171,11 +168,11 @@ describe('gulp-sass -- async compile', function() {
stream.write(errorFile);
});
it('should preserve the original sass error message', function(done) {
var errorFile = createVinyl('error.scss');
var stream = sass();
it('should preserve the original sass error message', (done) => {
const errorFile = createVinyl('error.scss');
const stream = sass();
stream.on('error', function(err) {
stream.on('error', (err) => {
// Error must include original error message
err.messageOriginal.indexOf('property "font" must be followed by a \':\'').should.not.equal(-1);
// Error must not format or change the original error message
@ -185,60 +182,48 @@ describe('gulp-sass -- async compile', function() {
stream.write(errorFile);
});
it('should compile a single sass file if the file name has been changed in the stream', function(done) {
var sassFile = createVinyl('mixins.scss');
var stream;
it('should compile a single sass file if the file name has been changed in the stream', (done) => {
const sassFile = createVinyl('mixins.scss');
// Transform file name
sassFile.path = path.join(path.join(__dirname, 'scss'), 'mixin--changed.scss');
stream = sass();
stream.on('data', function(cssFile) {
const stream = sass();
stream.on('data', (cssFile) => {
should.exist(cssFile);
should.exist(cssFile.path);
cssFile.path.split(path.sep).pop().should.equal('mixin--changed.css');
should.exist(cssFile.relative);
should.exist(cssFile.contents);
String(normaliseEOL(cssFile.contents)).should.equal(
normaliseEOL(fs.readFileSync(path.join(__dirname, 'expected', 'mixins.css'), 'utf8'))
);
const actual = fs.readFileSync(path.join(__dirname, 'expected', 'mixins.css'), 'utf8');
String(normaliseEOL(cssFile.contents)).should.equal(normaliseEOL(actual));
done();
});
stream.write(sassFile);
});
it('should preserve changes made in-stream to a Sass file', function(done) {
var sassFile = createVinyl('mixins.scss');
var stream;
it('should preserve changes made in-stream to a Sass file', (done) => {
const sassFile = createVinyl('mixins.scss');
// Transform file name
sassFile.contents = new Buffer('/* Added Dynamically */' + sassFile.contents.toString());
sassFile.contents = Buffer.from(`/* Added Dynamically */${sassFile.contents.toString()}`);
stream = sass();
stream.on('data', function(cssFile) {
const stream = sass();
stream.on('data', (cssFile) => {
should.exist(cssFile);
should.exist(cssFile.path);
should.exist(cssFile.relative);
should.exist(cssFile.contents);
String(normaliseEOL(cssFile.contents)).should.equal('/* Added Dynamically */\n' +
normaliseEOL(fs.readFileSync(path.join(__dirname, 'expected', 'mixins.css'), 'utf8'))
);
const actual = fs.readFileSync(path.join(__dirname, 'expected', 'mixins.css'), 'utf8');
String(normaliseEOL(cssFile.contents))
.should.equal(`/* Added Dynamically */\n${normaliseEOL(actual)}`);
done();
});
stream.write(sassFile);
});
it('should work with gulp-sourcemaps', function(done) {
var sassFile = createVinyl('inheritance.scss');
// Expected sources are relative to file.base
var expectedSources = [
'inheritance.scss',
'includes/_cats.scss',
'includes/_dogs.sass',
];
var stream;
it('should work with gulp-sourcemaps', (done) => {
const sassFile = createVinyl('inheritance.scss');
sassFile.sourceMap = '{' +
'"version": 3,' +
@ -249,8 +234,15 @@ describe('gulp-sass -- async compile', function() {
'"sourcesContent": [ "@import ../inheritance;" ]' +
'}';
stream = sass();
stream.on('data', function(cssFile) {
// Expected sources are relative to file.base
const expectedSources = [
'inheritance.scss',
'includes/_cats.scss',
'includes/_dogs.sass',
];
const stream = sass();
stream.on('data', (cssFile) => {
should.exist(cssFile.sourceMap);
cssFile.sourceMap.sources.should.eql(expectedSources);
done();
@ -258,32 +250,32 @@ describe('gulp-sass -- async compile', function() {
stream.write(sassFile);
});
it('should compile a single indented sass file', function(done) {
var sassFile = createVinyl('indent.sass');
var stream = sass();
stream.on('data', function(cssFile) {
it('should compile a single indented sass file', (done) => {
const sassFile = createVinyl('indent.sass');
const stream = sass();
stream.on('data', (cssFile) => {
should.exist(cssFile);
should.exist(cssFile.path);
should.exist(cssFile.relative);
should.exist(cssFile.contents);
String(normaliseEOL(cssFile.contents)).should.equal(
normaliseEOL(fs.readFileSync(path.join(__dirname, 'expected', 'indent.css'), 'utf8'))
);
const actual = fs.readFileSync(path.join(__dirname, 'expected', 'indent.css'), 'utf8');
String(normaliseEOL(cssFile.contents)).should.equal(normaliseEOL(actual));
done();
});
stream.write(sassFile);
});
it('should parse files in sass and scss', function(done) {
var files = [
it('should parse files in sass and scss', (done) => {
const files = [
createVinyl('mixins.scss'),
createVinyl('indent.sass')
createVinyl('indent.sass'),
];
var stream = sass();
var mustSee = files.length;
var expectedPath = path.join('expected', 'mixins.css');
const stream = sass();
let mustSee = files.length;
let expectedPath = path.join('expected', 'mixins.css');
stream.on('data', function(cssFile) {
stream.on('data', (cssFile) => {
should.exist(cssFile);
should.exist(cssFile.path);
should.exist(cssFile.relative);
@ -291,125 +283,123 @@ describe('gulp-sass -- async compile', function() {
if (cssFile.path.indexOf('indent') !== -1) {
expectedPath = path.join('expected', 'indent.css');
}
String(normaliseEOL(cssFile.contents)).should.equal(
normaliseEOL(fs.readFileSync(path.join(__dirname, expectedPath), 'utf8'))
);
mustSee--;
const actual = fs.readFileSync(path.join(__dirname, expectedPath), 'utf8');
String(normaliseEOL(cssFile.contents)).should.equal(normaliseEOL(actual));
mustSee -= 1;
if (mustSee <= 0) {
done();
}
});
files.forEach(function (file) {
files.forEach((file) => {
stream.write(file);
});
});
});
describe('gulp-sass -- sync compile', function() {
beforeEach(function(done) {
describe('gulp-sass -- sync compile', () => {
beforeEach((done) => {
rimraf(path.join(__dirname, 'results'), done);
});
it('should pass file when it isNull()', function(done) {
var stream = sass.sync();
var emptyFile = {
'isNull': function () {
return true;
}
it('should pass file when it isNull()', (done) => {
const stream = sass.sync();
const emptyFile = {
isNull: () => true,
};
stream.on('data', function(data) {
stream.on('data', (data) => {
data.should.equal(emptyFile);
done();
});
stream.write(emptyFile);
});
it('should emit error when file isStream()', function (done) {
var stream = sass.sync();
var streamFile = {
'isNull': function () {
return false;
},
'isStream': function () {
return true;
}
it('should emit error when file isStream()', (done) => {
const stream = sass.sync();
const streamFile = {
isNull: () => false,
isStream: () => true,
};
stream.on('error', function(err) {
stream.on('error', (err) => {
err.message.should.equal('Streaming not supported');
done();
});
stream.write(streamFile);
});
it('should compile a single sass file', function(done) {
var sassFile = createVinyl('mixins.scss');
var stream = sass.sync();
stream.on('data', function(cssFile) {
it('should compile a single sass file', (done) => {
const sassFile = createVinyl('mixins.scss');
const stream = sass.sync();
stream.on('data', (cssFile) => {
should.exist(cssFile);
should.exist(cssFile.path);
should.exist(cssFile.relative);
should.exist(cssFile.contents);
String(normaliseEOL(cssFile.contents)).should.equal(
normaliseEOL(fs.readFileSync(path.join(__dirname, 'expected', 'mixins.css'), 'utf8'))
);
const actual = fs.readFileSync(path.join(__dirname, 'expected', 'mixins.css'), 'utf8');
String(normaliseEOL(cssFile.contents)).should.equal(normaliseEOL(actual));
done();
});
stream.write(sassFile);
});
it('should compile multiple sass files', function(done) {
var files = [
it('should compile multiple sass files', (done) => {
const files = [
createVinyl('mixins.scss'),
createVinyl('variables.scss')
createVinyl('variables.scss'),
];
var stream = sass.sync();
var mustSee = files.length;
var expectedPath = path.join('expected', 'mixins.css');
const stream = sass.sync();
let mustSee = files.length;
let expectedPath = path.join('expected', 'mixins.css');
stream.on('data', function(cssFile) {
stream.on('data', (cssFile) => {
should.exist(cssFile);
should.exist(cssFile.path);
should.exist(cssFile.relative);
should.exist(cssFile.contents);
if (cssFile.path.indexOf('variables') !== -1) {
expectedPath = path.join('expected', 'variables.css');
}
String(normaliseEOL(cssFile.contents)).should.equal(
normaliseEOL(fs.readFileSync(path.join(__dirname, expectedPath), 'utf8'))
);
mustSee--;
const actual = normaliseEOL(fs.readFileSync(path.join(__dirname, expectedPath), 'utf8'));
String(normaliseEOL(cssFile.contents)).should.equal(actual);
mustSee -= 1;
if (mustSee <= 0) {
done();
}
});
files.forEach(function (file) {
files.forEach((file) => {
stream.write(file);
});
});
it('should compile files with partials in another folder', function(done) {
var sassFile = createVinyl('inheritance.scss');
var stream = sass.sync();
stream.on('data', function(cssFile) {
it('should compile files with partials in another folder', (done) => {
const sassFile = createVinyl('inheritance.scss');
const stream = sass.sync();
stream.on('data', (cssFile) => {
should.exist(cssFile);
should.exist(cssFile.path);
should.exist(cssFile.relative);
should.exist(cssFile.contents);
String(normaliseEOL(cssFile.contents)).should.equal(
normaliseEOL(fs.readFileSync(path.join(__dirname, 'expected', 'inheritance.css'), 'utf8'))
);
const actual = fs.readFileSync(path.join(__dirname, 'expected', 'inheritance.css'), 'utf8');
String(normaliseEOL(cssFile.contents)).should.equal(normaliseEOL(actual));
done();
});
stream.write(sassFile);
});
it('should handle sass errors', function(done) {
var errorFile = createVinyl('error.scss');
var stream = sass.sync();
it('should handle sass errors', (done) => {
const errorFile = createVinyl('error.scss');
const stream = sass.sync();
stream.on('error', function(err) {
stream.on('error', (err) => {
err.message.indexOf('property "font" must be followed by a \':\'').should.not.equal(-1);
err.relativePath.should.equal(path.join('test', 'scss', 'error.scss'));
done();
@ -417,18 +407,25 @@ describe('gulp-sass -- sync compile', function() {
stream.write(errorFile);
});
it('should work with gulp-sourcemaps', function(done) {
var sassFile = createVinyl('inheritance.scss');
it('should emit logError on sass error', (done) => {
const errorFile = createVinyl('error.scss');
const stream = sass.sync();
stream.on('error', sass.logError);
stream.on('end', done);
stream.write(errorFile);
});
it('should work with gulp-sourcemaps', (done) => {
const sassFile = createVinyl('inheritance.scss');
// Expected sources are relative to file.base
var expectedSources = [
const expectedSources = [
'inheritance.scss',
'includes/_cats.scss',
'includes/_dogs.sass',
];
var stream;
sassFile.sourceMap = '{' +
'"version": 3,' +
'"file": "scss/subdir/multilevelimport.scss",' +
@ -438,8 +435,8 @@ describe('gulp-sass -- sync compile', function() {
'"sourcesContent": [ "@import ../inheritance;" ]' +
'}';
stream = sass.sync();
stream.on('data', function(cssFile) {
const stream = sass.sync();
stream.on('data', (cssFile) => {
should.exist(cssFile.sourceMap);
cssFile.sourceMap.sources.should.eql(expectedSources);
done();
@ -447,14 +444,14 @@ describe('gulp-sass -- sync compile', function() {
stream.write(sassFile);
});
it('should work with gulp-sourcemaps and autoprefixer', function(done) {
var expectedSourcesBefore = [
it('should work with gulp-sourcemaps and autoprefixer', (done) => {
const expectedSourcesBefore = [
'inheritance.scss',
'includes/_cats.scss',
'includes/_dogs.sass',
];
var expectedSourcesAfter = [
const expectedSourcesAfter = [
'includes/_cats.scss',
'includes/_dogs.sass',
'inheritance.scss',
@ -463,80 +460,78 @@ describe('gulp-sass -- sync compile', function() {
gulp.src(path.join(__dirname, 'scss', 'inheritance.scss'))
.pipe(sourcemaps.init())
.pipe(sass.sync())
.pipe(tap(function(file) {
.pipe(tap((file) => {
should.exist(file.sourceMap);
file.sourceMap.sources.should.eql(expectedSourcesBefore);
}))
.pipe(postcss([autoprefixer()]))
.pipe(sourcemaps.write())
.pipe(gulp.dest(path.join(__dirname, 'results')))
.pipe(tap(function(file) {
.pipe(tap((file) => {
should.exist(file.sourceMap);
file.sourceMap.sources.should.eql(expectedSourcesAfter);
}))
.on('end', done);
});
it('should work with gulp-sourcemaps and a globbed source', function(done) {
var files, filesContent, actualContent, expectedContent, globPath;
globPath = path.join(__dirname, 'scss', 'globbed');
files = globule.find(path.join(__dirname, 'scss', 'globbed', '**', '*.scss'));
filesContent = {};
it('should work with gulp-sourcemaps and a globbed source', (done) => {
const globPath = path.join(__dirname, 'scss', 'globbed');
const files = globule.find(path.join(__dirname, 'scss', 'globbed', '**', '*.scss'));
const filesContent = {};
files.forEach(function(file) {
var source = path.normalize(path.relative(globPath, file));
files.forEach((file) => {
const source = path.normalize(path.relative(globPath, file));
filesContent[source] = fs.readFileSync(file, 'utf8');
});
gulp.src(path.join(__dirname, 'scss', 'globbed', '**', '*.scss'))
.pipe(sourcemaps.init())
.pipe(sass.sync())
.pipe(tap(function(file) {
.pipe(tap((file) => {
should.exist(file.sourceMap);
actualContent = normaliseEOL(file.sourceMap.sourcesContent[0]);
expectedContent = normaliseEOL(filesContent[path.normalize(file.sourceMap.sources[0])]);
actualContent.should.eql(expectedContent);
const actual = normaliseEOL(file.sourceMap.sourcesContent[0]);
const expected = normaliseEOL(filesContent[path.normalize(file.sourceMap.sources[0])]);
actual.should.eql(expected);
}))
.on('end', done);
});
it('should work with gulp-sourcemaps and autoprefixer with different file.base', function(done) {
var expectedSourcesBefore = [
it('should work with gulp-sourcemaps and autoprefixer with different file.base', (done) => {
const expectedSourcesBefore = [
'scss/inheritance.scss',
'scss/includes/_cats.scss',
'scss/includes/_dogs.sass'
'scss/includes/_dogs.sass',
];
var expectedSourcesAfter = [
const expectedSourcesAfter = [
'scss/includes/_cats.scss',
'scss/includes/_dogs.sass',
'scss/inheritance.scss'
'scss/inheritance.scss',
];
gulp.src(path.join(__dirname, 'scss', 'inheritance.scss'), { 'base': 'test' })
gulp.src(path.join(__dirname, 'scss', 'inheritance.scss'), { base: 'test' })
.pipe(sourcemaps.init())
.pipe(sass.sync())
.pipe(tap(function(file) {
.pipe(tap((file) => {
should.exist(file.sourceMap);
file.sourceMap.sources.should.eql(expectedSourcesBefore);
}))
.pipe(postcss([autoprefixer()]))
.pipe(tap(function(file) {
.pipe(tap((file) => {
should.exist(file.sourceMap);
file.sourceMap.sources.should.eql(expectedSourcesAfter);
}))
.on('end', done);
});
it('should work with empty files', function(done) {
it('should work with empty files', (done) => {
gulp.src(path.join(__dirname, 'scss', 'empty.scss'))
.pipe(sass.sync())
.pipe(gulp.dest(path.join(__dirname, 'results')))
.pipe(tap(function() {
.pipe(tap(() => {
try {
fs.statSync(path.join(__dirname, 'results', 'empty.css'));
}
catch (e) {
} catch (e) {
should.fail(false, true, 'Empty file was produced');
}
}))

4555
yarn.lock Normal file

File diff suppressed because it is too large Load diff