Merge pull request #667 from dlmanning/next

Drop support for non-Active LTS and Current releases

Author: xzyfer

.eslintrc

@@ -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:
-    - 2
-    - last
-
-  # Enforces one true `this` variable
-  consistent-this:
+  max-len:
     - 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
+    - 120
 
-  # 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"

.travis.yml

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

README.md

@@ -4,6 +4,12 @@ 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._**
 
+# Support
+
+Only [Active LTS and Current releases][1] are supported.
+
+[1]: https://github.com/nodejs/Release#release-schedule
+
 # Install
 
 ```
@@ -52,7 +58,7 @@ gulp.task('sass:watch', function () {
 
 ## 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:
 

appveyor.yml

@@ -11,12 +11,9 @@ platform:
 
 environment:
   matrix:
-    - nodejs_version: 0.10
-    - nodejs_version: 0.12
-    - nodejs_version: 4
-    - nodejs_version: 6
-    - nodejs_version: 8
-    - nodejs_version: 9
+    - nodejs_version: lts/boron
+    - nodejs_version: lts/carbon
+    - nodejs_version: current
 
 install:
   - ps: Install-Product node $env:nodejs_version $env:platform

index.js

@@ -1,183 +1,158 @@
-'use strict';
+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 gutil = require('gulp-util');
-var through = require('through2');
-var clonedeep = require('lodash.clonedeep');
-var path = require('path');
-var 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;
-
-    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);
+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];
     }
+  } 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
+  //////////////////////////////
+  const filePush = (sassObj) => {
+    let sassMap;
+    let sassMapFile;
+    let sassFileSrc;
+    let sassFileSrcPath;
+    let 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((source, index) => { // eslint-disable-line arrow-body-style
+          return index === sourceFileIndex ? source : path.join(sassFileSrcPath, source);
+        });
+      }
 
+      // Remove 'stdin' from souces and replace with filenames!
+      sassMap.sources = sassMap.sources.filter(src => src !== 'stdin' && src);
 
-    opts = clonedeep(options || {});
-    opts.data = file.contents.toString();
+      // Replace the map file with the original file name (but new extension)
+      sassMap.file = replaceExtension(sassFileSrc, '.css');
+      // Apply the map
+      applySourceMap(file, sassMap);
+    }
 
-    // we set the file path here so that libsass can correctly resolve import paths
-    opts.file = file.path;
+    file.contents = sassObj.css; // eslint-disable-line no-param-reassign
+    file.path = replaceExtension(file.path, '.css'); // eslint-disable-line no-param-reassign
 
-    // Ensure `indentedSyntax` is true if a `.sass` file
-    if (path.extname(file.path) === '.sass') {
-      opts.indentedSyntax = true;
-    }
+    cb(null, file);
+  };
 
-    // Ensure file's parent directory in the include path
-    if (opts.includePaths) {
-      if (typeof opts.includePaths === 'string') {
-        opts.includePaths = [opts.includePaths];
-      }
-    }
-    else {
-      opts.includePaths = [];
-    }
+  //////////////////////////////
+  // 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');
 
-    opts.includePaths.unshift(path.dirname(file.path));
+    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
 
-    // Generate Source Maps if plugin source-map present
-    if (file.sourceMap) {
-      opts.sourceMap = file.path;
-      opts.omitSourceMapUrl = true;
-      opts.sourceMapContents = true;
-    }
+    return cb(new PluginError(PLUGIN_NAME, error));
+  };
 
+  if (sync !== true) {
     //////////////////////////////
-    // Handles returning the file to the stream
+    // Async Sass render
     //////////////////////////////
-    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;
-          }
-        });
-
-        // Replace the map file with the original file name (but new extension)
-        sassMap.file = gutil.replaceExtension(sassFileSrc, '.css');
-        // Apply the map
-        applySourceMap(file, sassMap);
+    const callback = (error, obj) => { // eslint-disable-line consistent-return
+      if (error) {
+        return errorM(error);
       }
-
-      file.contents = sassObj.css;
-      file.path = gutil.replaceExtension(file.path, '.css');
-
-      cb(null, file);
+      filePush(obj);
     };
 
+    gulpSass.compiler.render(opts, callback);
+  } else {
     //////////////////////////////
-    // Handles error message
+    // Sync Sass render
     //////////////////////////////
-    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);
+    try {
+      filePush(gulpSass.compiler.renderSync(opts));
+    } catch (error) {
+      return errorM(error);
     }
-    else {
-      //////////////////////////////
-      // Sync Sass render
-      //////////////////////////////
-      try {
-        result = gulpSass.compiler.renderSync(opts);
-
-        filePush(result);
-      }
-      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');
+gulpSass.logError = (error) => {
+  const message = new PluginError('sass', error.messageFormatted).toString();
+  process.stderr.write(`${message}\n`);
   this.emit('end');
 };
 

package.json

@@ -3,6 +3,9 @@
   "version": "3.2.1",
   "description": "Gulp plugin for sass",
   "main": "index.js",
+  "engines": {
+    "node": ">=6"
+  },
   "scripts": {
     "test": "./node_modules/.bin/mocha test"
   },
@@ -21,22 +24,28 @@
     "url": "https://github.com/dlmanning/gulp-sass/issues"
   },
   "dependencies": {
-    "gulp-util": "^3.0",
+    "chalk": "^2.3.0",
     "lodash.clonedeep": "^4.3.2",
     "node-sass": "^4.8.3",
+    "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",
+    "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-postcss": "^7.0.1",
+    "gulp-sourcemaps": "^2.6.4",
     "gulp-tap": "^0.1.3",
-    "mocha": "^2.2.1",
+    "mocha": "^5.0.4",
     "rimraf": "^2.4.3",
-    "should": "^8.3.1"
+    "should": "^13.2.1",
+    "vinyl": "^2.1.0"
   }
 }

test/lint.js

@@ -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));
     }