Compare commits

..

No commits in common. "master" and "dev" have entirely different histories.
master ... dev

34 changed files with 308 additions and 5991 deletions

View file

@ -1,21 +0,0 @@
# EditorConfig helps developers define and maintain consistent
# coding styles between different editors and IDEs
# editorconfig.org
root = true
[*]
# Change these settings to your own preference
indent_style = space
indent_size = 2
# We recommend you to keep these unchanged
end_of_line = lf
charset = utf-8
trim_trailing_whitespace = true
insert_final_newline = true
[*.md]
trim_trailing_whitespace = false

View file

@ -1,12 +0,0 @@
root: true
env:
mocha: true
node: true
rules:
max-len:
- 2
- 120
extends: "airbnb-base"

View file

@ -1,25 +0,0 @@
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 +0,0 @@
test

View file

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

View file

@ -1,140 +0,0 @@
# 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 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**
https://github.com/dlmanning/gulp-sass/releases/tag/v3.0.0
## v2.3.2
**June 15, 2016**
https://github.com/dlmanning/gulp-sass/releases/tag/v2.3.2
## v2.3.1
**April 22, 2016**
https://github.com/dlmanning/gulp-sass/releases/tag/v2.3.1
## v2.3.0
**April 21, 2016**
https://github.com/dlmanning/gulp-sass/releases/tag/v2.3.0
## v2.3.0-beta.1
**February 4, 2016**
https://github.com/dlmanning/gulp-sass/releases/tag/v2.3.0-beta.1
## v2.2.0
**February 4, 2016**
https://github.com/dlmanning/gulp-sass/releases/tag/v2.2.0
## v2.1.0
**November 2, 2015**
https://github.com/dlmanning/gulp-sass/releases/tag/v2.1.0
## v2.1.0-beta
**September 21, 2015**
* **Change** :arrow_up: Bump to Node Sass 3.4.0-beta1
## v2.0.4
**July 15, 2015**
* **Fix** Relative file path now uses `file.relative` instead of arcane `split('/').pop` magic. Resolves lots of issues with source map paths.
* **Fix** Empty partials no longer copied to CSS folder
## v2.0.3
**June 27, 2015**
* **Fix** Empty partials no longer copied to CSS folder
## v2.0.2
**June 25, 2015**
* **Fix** Error in watch stream preventing watch from continuing
## v2.0.1
**May 13, 2015**
* **Fix** Source maps now work as expected with Autoprefixer
* **Fix** Current file directory `unshift` onto includePaths stack so it's checked first
* **Fix** Error message returned is unformatted so as to not break other error handling (*i.e.* `gulp-notify`)
## v2.0.0
**May 6, 2015**
* **Change** :arrow_up: Bump to Node Sass 3.0.0
## v2.0.0-alpha.1
**March 26, 2015**
* **New** Added `renderSync` option that can be used through `sass.sync()`
### March 24, 2015
* **Change** Updated to `node-sass` 3.0.0-alpha.1
* **New** Added support for `gulp-sourcemaps` including tests
* **New** Added `.editorconfig` for development consistency
* **New** Added linting and test for said linting
* **Change** Updated the README
* **New** `logError` function to make streaming errors possible instead of breaking the stream
### 1.3.3
* updated to node-sass 2.0 (final)
* should now work with node 0.12 and io.js
### 1.3.2
* fixed errLogToConsole
### 1.3.1
* bug fix
## Version 1.3.0
* Supports node-sass 2.0 (thanks laurelnaiad!)

View file

@ -1,63 +0,0 @@
# Contributing to Gulp Sass
Gulp Sass is a very light-weight [Gulp](https://github.com/gulpjs/gulp) wrapper for [`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).
## Submitting Issues
* Before creating a new issue, perform a [cursory search](https://github.com/issues?utf8=%E2%9C%93&q=repo%3Adlmanning%2Fgulp-sass+repo%3Asass%2Fnode-sass+repo%3Asass%2Flibsass+repo%3Asass%2Fsass+repo%3Asass-eyeglass%2Feyeglass) in the Gulp Sass, Node Sass, Libsass, and main Sass repos to see if a similar issue has already been submitted. Please also refer to our [Common Issues and Their Fixes](https://github.com/dlmanning/gulp-sass/wiki/Common-Issues-and-Their-Fixes) page for some basic troubleshooting.
* You can create an issue [here](https://github.com/dlmanning/gulp-sass/issues). Please include as many details as possible in your report.
* Issue titles should be descriptive, explaining at the high level what it is about.
* Please include the version of `gulp-sass`, Node, and NPM you are using, as well as what operating system you are having a problem on.
* _Do not open a [pull request](#pull-requests) to resolve an issue without first receiving feedback from a `collaborator` or `owner` and having them agree on a solution forward_.
* Include screenshots and animated GIFs whenever possible; they are immensely helpful.
* Issues that have a number of sub-items that need to be complete should use [task lists](https://github.com/blog/1375%0A-task-lists-in-gfm-issues-pulls-comments) to track the sub-items in the main issue comment.
## Pull Requests
* **DO NOT ISSUE A PULL REQUEST WITHOUT FIRST [SUBMITTING AN ISSUE](#submitting-issues)**
* Pull requests should reference their related issues. If the pull request closes an issue, [please reference its closing in your commit messages](https://help.github.com/articles/closing-issues-via-commit-messages/). Pull requests not referencing any issues will be closed.
* Pull request titles should be descriptive, explaining at the high level what it is doing, and should be written in the same style as [Git commit messages](#git-commit-messages).
* Update the `CHANGELOG` with the changes made by your pull request, making sure to use the proper [Emoji](#emoji-cheatsheet).
* Follow our JavaScript styleguides. Tests will fail if you do not.
* Ensure that you have [EditorConfig](http://editorconfig.org/) installed in your editor of choice and that it is functioning properly.
* Do not squash or rebase your commits when submitting a Pull Request. It makes it much harder to follow your work and make incremental changes.
* Update the [CHANGELOG](#maintaining-thechangelog) with your changes.
* Branches should be made off of the most current `master` branch from `git@github.com:dlmanning/gulp-sass.git`
* Pull requests should be made into our [master](https://github.com/dlmanning/gulp-sass/tree/master) branch.
### Git Commit Messages
* Use the present tense (`"Add feature"` not `"Added Feature"`)
* Use the imperative mood (`"Move cursor to…"` not `"Moves cursor to…"`)
* Limit the first line to 72 characters or less
* Consider including relevant Emoji from our [Emoji cheatsheet](#emoji-cheatsheet)
## Creating a New Version
Versioning is done through [SEMVER](http://semver.org/). When creating a new version, create new release branch off of `master` with the version's name, and create a new tag with `v` prefixed with the version's name from that branch.
For instance, if you are creating version `1.1.0`, you would create a branch `release/1.1.0` from `master` and create a tag `v1.1.0` from branch `release/1.1.0`.
### Maintaining the Changelog
The Changelog should have a list of changes made for each version. They should be organized so additions come first, changes come second, and deletions come third. Version numbers should be 2nd level headers with the `v` in front (like a tag) and the date of the version's most recent update should be underneath in italics.
Changelog messages do not need to cover each individual commit made, but rather should have individual summaries of the changes made. Changelog messages should be written in the same style as [Git commit messages](#git-commit-messages).
## Emoji Cheatsheet
When creating creating commits or updating the CHANGELOG, please **start** the commit message or update with one of the following applicable Emoji. Emoji should not be used at the start of issue or pull request titles.
* :art: `:art:` when improving the format/structure of the code
* :racehorse: `:racehorse:` when improving performance
* :memo: `:memo:` when writing long-form text (documentation, guidelines, principles, etc…)
* :bug: `:bug:` when fixing a bug
* :fire: `:fire:` when removing code or files
* :green_heart: `:green_heart:` when fixing the CI build
* :white_check_mark: `:white_check_mark:` when adding tests
* :lock: `:lock:` when dealing with security
* :arrow_up: `:arrow_up:` when upgrading dependencies
* :arrow_down: `:arrow_down:` when downgrading dependencies
* :shirt: `:shirt:` when removing linter warnings
* :shipit: `:shipit:` when creating a new release

177
LICENSE
View file

@ -1,165 +1,20 @@
GNU LESSER GENERAL PUBLIC LICENSE
Version 3, 29 June 2007
The MIT License (MIT)
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.
Copyright (c) 2013 David Manning
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:
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 above copyright notice and this permission notice shall be included in all
copies or substantial portions of 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.
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.

162
README.md
View file

@ -1,139 +1,103 @@
# gulp-sass
[![Build Status](https://travis-ci.org/dlmanning/gulp-sass.svg?branch=master)](https://travis-ci.org/dlmanning/gulp-sass)
Sass plugin for [Gulp](https://github.com/gulpjs/gulp).
gulp-sass
=========
This is a fork of [David Manning's Gulp Sass](https://github.com/dlmanning/gulp-sass).
SASS plugin for [gulp](https://github.com/gulpjs/gulp).
# Support
Only [Active LTS and Current releases][1] are supported.
[1]: https://github.com/nodejs/Release#release-schedule
# Install
#Install
```
yarn add --dev sass @selfisekai/gulp-sass
npm install gulp-sass
```
# Basic Usage
#Basic Usage
Something like this will compile your Sass files:
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');
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', () => {
gulp.watch('./sass/**/*.scss', ['sass']);
gulp.task('sass', function () {
gulp.src('./scss/*.scss')
.pipe(sass())
.pipe(gulp.dest('./css'));
});
```
You can also compile synchronously, doing something like this:
Options passed as a hash into `sass()` will be passed along to [`node-sass`](https://github.com/sass/node-sass)
```javascript
'use strict';
## gulp-sass specific options
const gulp = require('gulp');
const sass = require('@selfisekai/gulp-sass');
#### `errLogToConsole: true`
sass.compiler = require('sass');
If you pass `errLogToConsole: true` into the options hash, sass errors will be logged to the console instead of generating a `gutil.PluginError` object. Use this option with `gulp.watch` to keep gulp from stopping every time you mess up your sass.
gulp.task('sass', () => {
return gulp.src('./sass/**/*.scss')
.pipe(sass.sync().on('error', sass.logError))
.pipe(gulp.dest('./css'));
});
#### `onSuccess: callback`
gulp.task('sass:watch', () => {
gulp.watch('./sass/**/*.scss', ['sass']);
});
```
Pass in your own callback to be called upon successful compilaton by node-sass. The callback has the form `callback(css)`, and is passed the compiled css as a string. Note: This *does not* prevent gulp-sass's default behavior of writing the output css file.
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.
#### `onError: callback`
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.
For example:
```javascript
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'));
});
```
Pass in your own callback to be called upon a sass error from node-sass. The callback has the form `callback(err)`, where err is the error string generated by libsass. Note: this *does* prevent an actual `gulpPluginError` object from being created.
## 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.
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 the gulp-sass compiler and write the source maps after.
```javascript
const sourcemaps = require('gulp-sourcemaps');
var sourcemaps = require('gulp-sourcemaps');
gulp.task('sass', () => {
return gulp.src('./sass/**/*.scss')
.pipe(sourcemaps.init())
.pipe(sass().on('error', sass.logError))
gulp.src('./scss/*.scss')
.pipe(sourcemaps.init());
.pipe(sass())
.pipe(sourcemaps.write())
.pipe(gulp.dest('./css'));
});
.pipe('./css');
// will write the source maps inline in the compiled CSS files
```
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.
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 relative file path in the `sourcemaps.write()` function.
```javascript
const sourcemaps = require('gulp-sourcemaps');
gulp.task('sass', () => {
return gulp.src('./sass/**/*.scss')
.pipe(sourcemaps.init())
.pipe(sass().on('error', sass.logError))
var sourcemaps = require('gulp-sourcemaps');
gulp.src('./scss/*.scss')
.pipe(sourcemaps.init());
.pipe(sass())
.pipe(sourcemaps.write('./maps'))
.pipe(gulp.dest('./css'));
});
.pipe('./css');
// will write the source maps to ./dest/css/maps
```
# Issues
#Imports and Partials
`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.
gulp-sass now automatically passes along the directory of every scss file it parses as an include path for node-sass. This means that as long as you specify your includes relative to path of your scss file, everything will just work.
[LibSass]: https://sass-lang.com/libsass
[Sass]: https://sass-lang.com
scss/includes/_settings.scss:
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.
```scss
$blue: #3bbfce;
$margin: 16px;
```
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.
scss/style.scss:
```scss
@import "includes/settings";
.content-navigation {
border-color: $blue;
color:
darken($blue, 9%);
}
.border {
padding: $margin / 2;
margin: $margin / 2;
border-color: $blue;
}
```
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

@ -1,25 +0,0 @@
version: "{build}"
cache:
- '%AppData%\npm-cache'
build: off
platform:
- x64
- x86
environment:
matrix:
- nodejs_version: 6
- nodejs_version: 8
- nodejs_version: 9
install:
- ps: Install-Product node $env:nodejs_version $env:platform
- npm install
test_script:
- node --version
- npm --version
- npm test

44
index.d.ts vendored
View file

@ -1,44 +0,0 @@
// 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;

241
index.js
View file

@ -1,183 +1,92 @@
/* eslint-disable global-require */
/* eslint-disable import/no-extraneous-dependencies */
var fs = require('fs')
, map = require('map-stream')
, sass = require('node-sass')
, path = require('path')
, gutil = require('gulp-util')
, ext = gutil.replaceExtension
, 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');
module.exports = function (options) {
var opts = options || {};
const PLUGIN_NAME = 'gulp-sass';
function nodeSass (file, cb) {
var fileDir = path.dirname(file.path);
var addedLocalDirPath = false;
// ////////////////////////////
// Main Gulp Sass function
// ////////////////////////////
const gulpSass = (options, sync) => through.obj((file, enc, cb) => { // eslint-disable-line consistent-return
if (file.isNull()) {
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];
if (file.isNull()) {
return cb(null, file);
}
if (path.basename(file.path).indexOf('_') === 0) {
return cb();
}
} else {
opts.includePaths = [];
}
opts.includePaths.unshift(path.dirname(file.path));
if (file.sourceMap) {
opts.sourceComments = 'map';
opts.sourceMap = file.path;
}
// Generate Source Maps if plugin source-map present
if (file.sourceMap) {
opts.sourceMap = file.path;
opts.omitSourceMapUrl = true;
opts.sourceMapContents = true;
}
if (opts.sourceComments === 'map' || opts.sourceComments === 'normal') {
opts.sourceMap = opts.sourceMap || '';
opts.file = file.path;
} else {
opts.data = file.contents.toString();
}
// ////////////////////////////
// Handles returning the file to the stream
// ////////////////////////////
const filePush = (sassObj) => {
let sassMap;
let sassMapFile;
let sassFileSrc;
let sassFileSrcPath;
let sourceFileIndex;
if (opts.includePaths && Array.isArray(opts.includePaths)) {
if (opts.includePaths.indexOf(fileDir) === -1) {
opts.includePaths.push(fileDir);
addedLocalDirPath = true;
}
} else {
opts.includePaths = [fileDir];
}
// 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);
});
opts.success = function (css, map) {
var sourceMap;
if (typeof opts.onSuccess === 'function') opts.onSuccess(css, map);
if (map) {
// hack to remove the already added sourceMappingURL from libsass
css = css.replace(/\n\/\*#\s*sourceMappingURL\=.*\*\//, '');
applySourceMap(file, map);
}
// Remove 'stdin' from souces and replace with filenames!
sassMap.sources = sassMap.sources.filter(src => src !== 'stdin' && src);
// Replace the map file with the original file name (but new extension)
sassMap.file = replaceExtension(sassFileSrc, '.css');
// Apply the map
applySourceMap(file, sassMap);
}
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);
file.path = ext(file.path, '.css');
file.contents = new Buffer(css);
cb(null, file);
};
gulpSass.compiler.render(opts, callback);
} else {
// ////////////////////////////
// Sync Sass render
// ////////////////////////////
try {
filePush(gulpSass.compiler.renderSync(opts));
} catch (error) {
return errorM(error);
}
opts.error = function (err) {
if (opts.errLogToConsole) {
gutil.log('[gulp-sass] ' + err);
return cb();
}
if (typeof opts.onError === 'function') {
opts.onError(err);
return cb();
}
return cb(new gutil.PluginError('gulp-sass', err));
};
sass.render(opts);
if (addedLocalDirPath) opts.includePaths.pop();
}
});
// ////////////////////////////
// Sync Sass render
// ////////////////////////////
gulpSass.sync = options => gulpSass(options, true);
// ////////////////////////////
// Log errors nicely
// ////////////////////////////
gulpSass.logError = function logError(error) {
const message = new PluginError('sass', error.messageFormatted).toString();
process.stderr.write(`${message}\n`);
this.emit('end');
return map(nodeSass);
};
// ////////////////////////////
// Store compiler in a prop
// ////////////////////////////
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`);
}
}
})();
function getSourcesContent (sources) {
sourcesContent = [];
module.exports = gulpSass;
for (var i = 0; i < sources.length; i++) {
sourcesContent[i] = fs.readFileSync(sources[i], { encoding: 'utf8' });
}
return sourcesContent;
}

View file

@ -1,55 +1,36 @@
{
"name": "@selfisekai/gulp-sass",
"version": "4.2.0",
"description": "Gulp plugin for sass (forked)",
"name": "gulp-sass",
"version": "0.7.3",
"description": "Gulp plugin for sass",
"main": "index.js",
"scripts": {
"test": "yarn mocha test"
"test": "node test/test.js"
},
"repository": {
"type": "git",
"url": "https://git.sakamoto.pl/selfisekai/gulp-sass.git"
"url": "git://github.com/dlmanning/gulp-sass"
},
"keywords": [
"gulpplugin",
"sass",
"gulp"
],
"author": "Laura Liberda (originally: David Manning)",
"license": "LGPL-3.0",
"author": "David Manning",
"license": "MIT",
"bugs": {
"email": "gulp-sass@selfisekai.rocks"
},
"publishConfig": {
"access": "public",
"registry": "https://registry.npmjs.org/"
"url": "https://github.com/dlmanning/gulp-sass/issues"
},
"dependencies": {
"@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"
"node-sass": "^0.9",
"gulp-util": "^3.0",
"map-stream": "~0.1",
"vinyl-sourcemaps-apply": "~0.1.1"
},
"devDependencies": {
"@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": "^4.0.2",
"gulp-postcss": "^7.0.1",
"gulp-sourcemaps": "^2.6.4",
"gulp-tap": "^0.1.3",
"mocha": "^5.0.4",
"node-sass": "^5.0.0",
"rimraf": "^2.4.3",
"sass": "^1.29.0",
"should": "^13.2.1",
"vinyl": "^2.1.0"
"tape": "~2.3",
"concat-stream": "~1.4"
},
"jshintConfig": {
"laxcomma": true
}
}

View file

@ -1,2 +0,0 @@
body .div {
color: blue; }

View file

@ -1,46 +0,0 @@
const eslint = require('eslint');
const 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']);
if (report.errorCount > 0 || report.warningCount > 0) {
console.log(formatter(report.results));
}
should(report.errorCount).equal(0);
should(report.warningCount).equal(0);
done();
});
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));
}
should(report.errorCount).equal(0);
should(report.warningCount).equal(0);
done();
});
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));
}
should(report.errorCount).equal(0);
should(report.warningCount).equal(0);
done();
});
});

View file

@ -1,540 +0,0 @@
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');
const createVinyl = (filename, contents) => {
const base = path.join(__dirname, 'scss');
const filePath = path.join(base, filename);
return new Vinyl({
cwd: __dirname,
base,
path: filePath,
contents: contents || fs.readFileSync(filePath),
});
};
const normaliseEOL = str => str.toString('utf8').replace(/\r\n/g, '\n');
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', () => {
it('should pass file when it isNull()', (done) => {
const stream = sass();
const emptyFile = {
isNull: () => true,
};
stream.on('data', (data) => {
data.should.equal(emptyFile);
done();
});
stream.write(emptyFile);
});
it('should emit error when file isStream()', (done) => {
const stream = sass();
const streamFile = {
isNull: () => false,
isStream: () => true,
};
stream.on('error', (err) => {
err.message.should.equal('Streaming not supported');
done();
});
stream.write(streamFile);
});
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');
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', (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);
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', (done) => {
const files = [
createVinyl('mixins.scss'),
createVinyl('variables.scss'),
];
const stream = sass();
let mustSee = files.length;
let expectedPath = path.join('expected', 'mixins.css');
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');
}
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((file) => {
stream.write(file);
});
});
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);
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 emit logError on sass error', (done) => {
const errorFile = createVinyl('error.scss');
const stream = sass();
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
err.message.indexOf('test', 'scss', 'error.scss').should.not.equal(-1);
// Error must include line and column error occurs on
err.message.indexOf('on line 2').should.not.equal(-1);
// Error must include relativePath property
err.relativePath.should.equal(path.join('test', 'scss', 'error.scss'));
done();
});
stream.write(errorFile);
});
it('should preserve the original sass error message', (done) => {
const errorFile = createVinyl('error.scss');
const stream = sass();
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
err.messageOriginal.indexOf('on line 2').should.equal(-1);
done();
});
stream.write(errorFile);
});
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');
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);
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', (done) => {
const sassFile = createVinyl('mixins.scss');
// Transform file name
sassFile.contents = Buffer.from(`/* Added Dynamically */${sassFile.contents.toString()}`);
const stream = sass();
stream.on('data', (cssFile) => {
should.exist(cssFile);
should.exist(cssFile.path);
should.exist(cssFile.relative);
should.exist(cssFile.contents);
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', (done) => {
const sassFile = createVinyl('inheritance.scss');
sassFile.sourceMap = '{' +
'"version": 3,' +
'"file": "scss/subdir/multilevelimport.scss",' +
'"names": [],' +
'"mappings": "",' +
'"sources": [ "scss/subdir/multilevelimport.scss" ],' +
'"sourcesContent": [ "@import ../inheritance;" ]' +
'}';
// 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();
});
stream.write(sassFile);
});
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);
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', (done) => {
const files = [
createVinyl('mixins.scss'),
createVinyl('indent.sass'),
];
const stream = sass();
let mustSee = files.length;
let expectedPath = path.join('expected', 'mixins.css');
stream.on('data', (cssFile) => {
should.exist(cssFile);
should.exist(cssFile.path);
should.exist(cssFile.relative);
should.exist(cssFile.contents);
if (cssFile.path.indexOf('indent') !== -1) {
expectedPath = path.join('expected', 'indent.css');
}
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((file) => {
stream.write(file);
});
});
});
describe('gulp-sass -- sync compile', () => {
beforeEach((done) => {
rimraf(path.join(__dirname, 'results'), done);
});
it('should pass file when it isNull()', (done) => {
const stream = sass.sync();
const emptyFile = {
isNull: () => true,
};
stream.on('data', (data) => {
data.should.equal(emptyFile);
done();
});
stream.write(emptyFile);
});
it('should emit error when file isStream()', (done) => {
const stream = sass.sync();
const streamFile = {
isNull: () => false,
isStream: () => true,
};
stream.on('error', (err) => {
err.message.should.equal('Streaming not supported');
done();
});
stream.write(streamFile);
});
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);
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', (done) => {
const files = [
createVinyl('mixins.scss'),
createVinyl('variables.scss'),
];
const stream = sass.sync();
let mustSee = files.length;
let expectedPath = path.join('expected', 'mixins.css');
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');
}
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((file) => {
stream.write(file);
});
});
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);
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', (done) => {
const errorFile = createVinyl('error.scss');
const stream = sass.sync();
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();
});
stream.write(errorFile);
});
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
const expectedSources = [
'inheritance.scss',
'includes/_cats.scss',
'includes/_dogs.sass',
];
sassFile.sourceMap = '{' +
'"version": 3,' +
'"file": "scss/subdir/multilevelimport.scss",' +
'"names": [],' +
'"mappings": "",' +
'"sources": [ "scss/subdir/multilevelimport.scss" ],' +
'"sourcesContent": [ "@import ../inheritance;" ]' +
'}';
const stream = sass.sync();
stream.on('data', (cssFile) => {
should.exist(cssFile.sourceMap);
cssFile.sourceMap.sources.should.eql(expectedSources);
done();
});
stream.write(sassFile);
});
it('should work with gulp-sourcemaps and autoprefixer', (done) => {
const expectedSourcesBefore = [
'inheritance.scss',
'includes/_cats.scss',
'includes/_dogs.sass',
];
const expectedSourcesAfter = [
'includes/_cats.scss',
'includes/_dogs.sass',
'inheritance.scss',
];
gulp.src(path.join(__dirname, 'scss', 'inheritance.scss'))
.pipe(sourcemaps.init())
.pipe(sass.sync())
.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((file) => {
should.exist(file.sourceMap);
file.sourceMap.sources.should.eql(expectedSourcesAfter);
}))
.on('end', done);
});
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((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((file) => {
should.exist(file.sourceMap);
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', (done) => {
const expectedSourcesBefore = [
'scss/inheritance.scss',
'scss/includes/_cats.scss',
'scss/includes/_dogs.sass',
];
const expectedSourcesAfter = [
'scss/includes/_cats.scss',
'scss/includes/_dogs.sass',
'scss/inheritance.scss',
];
gulp.src(path.join(__dirname, 'scss', 'inheritance.scss'), { base: 'test' })
.pipe(sourcemaps.init())
.pipe(sass.sync())
.pipe(tap((file) => {
should.exist(file.sourceMap);
file.sourceMap.sources.should.eql(expectedSourcesBefore);
}))
.pipe(postcss([autoprefixer()]))
.pipe(tap((file) => {
should.exist(file.sourceMap);
file.sourceMap.sources.should.eql(expectedSourcesAfter);
}))
.on('end', 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(() => {
try {
fs.statSync(path.join(__dirname, 'results', 'empty.css'));
} catch (e) {
should.fail(false, true, 'Empty file was produced');
}
}))
.on('end', done);
});
});

View file

@ -1,14 +1,8 @@
body {
background: pink; }
footer {
background: red; }
.error, .badError {
border: #f00;
background: #fdd; }
.error.intrusion, .intrusion.badError {
.error.intrusion {
font-size: 1.3em;
font-weight: bold; }

9
test/ref/nesting.css Normal file
View file

@ -0,0 +1,9 @@
table.hl {
margin: 2em 0; }
table.hl td.ln {
text-align: right; }
li {
font-family: serif;
font-weight: bold;
font-size: 1.2em; }

View file

@ -1,3 +0,0 @@
body {
background: red;
}

View file

View file

@ -1,3 +0,0 @@
body {
font 'Comic Sans';
}

View file

@ -1,15 +0,0 @@
p {
border: 1px solid red;
}
small {
font: {
size: 72px;
}
}
h1 {
font: {
size: 8px;
}
}

View file

@ -1,4 +0,0 @@
h1, h2, h3, h4, h5 {
color: green;
font-weight: 800;
}

View file

@ -1,6 +1,2 @@
$blue: #3bbfce;
$margin: 16px;
body {
background: pink;
}
$margin: 16px;

View file

@ -1,5 +0,0 @@
$blue: #3bbfce;
$margin: 16px;
footer
background: red;

View file

@ -1,4 +0,0 @@
$color: blue
body .div
color: $color

View file

@ -1,5 +1,4 @@
@import "includes/cats";
@import "includes/dogs";
.error {
border: #f00;
@ -14,4 +13,4 @@
.badError {
@extend .error;
border-width: 3px;
}
}

14
test/scss/nesting.scss Normal file
View file

@ -0,0 +1,14 @@
table.hl {
margin: 2em 0;
td.ln {
text-align: right;
}
}
li {
font: {
family: serif;
weight: bold;
size: 1.2em;
}
}

View file

@ -11,4 +11,4 @@ $margin: 16px;
padding: $margin / 2;
margin: $margin / 2;
border-color: $blue;
}
}

109
test/test.js Normal file
View file

@ -0,0 +1,109 @@
var assert = require('assert');
var gsass = require('../');
var gutil = require('gulp-util');
var fs = require('fs');
var path = require('path');
var test = require('tape');
function createVinyl(sassFileName, contents) {
var base = path.join(__dirname, 'scss');
var filePath = path.join(base, sassFileName);
return new gutil.File({
cwd: __dirname,
base: base,
path: filePath,
contents: contents || fs.readFileSync(filePath)
});
}
test('pass file when isNull()', function (t) {
var stream = gsass();
var emptyFile = {
isNull: function () { return true; }
};
stream.on('data', function (data) {
t.equal(data, emptyFile);
t.end();
});
stream.write(emptyFile);
});
// test('emit error when file isStream()', function (t) {
// var stream = gsass();
// var streamFile = {
// isNull: function () { return false; },
// isStream: function () { return true; }
// };
// stream.on()
// });
test('compile a single sass file', function (t) {
var sassFile = createVinyl('mixins.scss');
var stream = gsass();
stream.on('data', function (cssFile) {
t.ok(cssFile, 'cssFile should exist');
t.ok(cssFile.path, 'cssFile.path should exist');
t.ok(cssFile.relative, 'cssFile.relative should exist');
t.ok(cssFile.contents, 'cssFile.contents should exist');
t.equal(cssFile.path, path.join(__dirname, 'scss', 'mixins.css'));
t.equal(
fs.readFileSync(path.join(__dirname, 'ref/mixins.css'), 'utf8'),
cssFile.contents.toString(),
'file compiles correctly to css'
);
t.end();
})
stream.write(sassFile);
});
test('compile multiple sass files', function (t) {
var files = [
createVinyl('inheritance.scss'),
createVinyl('mixins.scss'),
createVinyl('nesting.scss'),
createVinyl('variables.scss')
];
t.plan(files.length * 4);
var stream = gsass();
stream.on('data', function (cssFile) {
t.ok(cssFile, 'cssFile exists');
t.ok(cssFile.path, 'cssFile.path exists');
t.ok(cssFile.relative, 'cssFile.relative exists');
t.ok(cssFile.contents, 'cssFile.contents exists');
});
files.forEach(function (file) {
stream.write(file);
});
});
test('emit error on sass errors', function (t) {
var stream = gsass();
var errorFile = createVinyl('somefile.sass',
new Buffer('body { font \'Comic Sans\'; }'));
stream.on('error', function (err) {
t.equal(err.message,
'source string:1: error: property "font" must be followed by a \':\'\n'
);
t.end();
});
stream.write(errorFile);
});
test('call custom error callback when opts.onError is given', function (t) {
var stream = gsass({ onError: function (err) {
t.equal(err,
'source string:1: error: property "font" must be followed by a \':\'\n'
);
t.end();
}});
var errorFile = createVinyl('somefile.sass',
new Buffer('body { font \'Comic Sans\'; }'));
stream.write(errorFile);
});

4555
yarn.lock

File diff suppressed because it is too large Load diff