gulp-preprocess 1.2.0 → 3.0.2

package/.eslintrc

@@ -0,0 +1,7 @@
+{
+  "extends": "eslint:recommended",
+  "env": {
+    "node": true,
+    "mocha": true
+  }
+}

package/.travis.yml

@@ -1,3 +1,5 @@
 language: node_js
 node_js:
-  - "0.10"
+  - 6
+  - 8
+  - 10

package/README.md

@@ -1,8 +1,7 @@
-# gulp-preprocess [![Build Status](https://travis-ci.org/jas/gulp-preprocess.png?branch=master)](https://travis-ci.org/jas/gulp-preprocess) [![NPM version](https://badge.fury.io/js/gulp-preprocess.png)](http://badge.fury.io/js/gulp-preprocess)
+# gulp-preprocess [![NPM version](https://img.shields.io/npm/v/gulp-preprocess.svg)](https://www.npmjs.com/package/gulp-preprocess) [![Build Status](https://img.shields.io/travis/pioug/gulp-preprocess.svg)](https://travis-ci.org/pioug/gulp-preprocess) [![Dependency Status](https://img.shields.io/david/pioug/gulp-preprocess.svg)](https://david-dm.org/pioug/gulp-preprocess)
 
 > [Gulp](http://gulpjs.com) plugin to preprocess HTML, JavaScript, and other files based on custom context or environment configuration
 
-
 ## Information
 
 <table>
@@ -11,7 +10,7 @@
 </tr>
 <tr>
 <td>Node Version</td>
-<td>>= 0.9.0</td>
+<td>>= 6.14.3</td>
 </tr>
 <tr>
 <td>Gulp Version</td>
@@ -19,7 +18,6 @@
 </tr>
 </table>
 
-
 ## Usage
 
 ### Install
@@ -28,24 +26,25 @@
 npm install gulp-preprocess --save-dev
 ```
 
-
 ## Examples
 
 #### Gulpfile
 
 ```js
-var preprocess = require('gulp-preprocess');
+var preprocess = require("gulp-preprocess");
 
-gulp.task('html', function() {
-  gulp.src('./app/*.html')
-    .pipe(preprocess({context: { NODE_ENV: 'production', DEBUG: true}})) //To set environment variables in-line
-    .pipe(gulp.dest('./dist/'))
+gulp.task("html", function() {
+  gulp
+    .src("./app/*.html")
+    .pipe(preprocess({ context: { NODE_ENV: "production", DEBUG: true } })) // To set environment variables in-line
+    .pipe(gulp.dest("./dist/"));
 });
 
-gulp.task('scripts', function() {
-  gulp.src(['./app/*.js'])
+gulp.task("scripts", function() {
+  gulp
+    .src(["./app/*.js"])
     .pipe(preprocess())
-    .pipe(gulp.dest('./dist/'))
+    .pipe(gulp.dest("./dist/"));
 });
 ```
 
@@ -73,37 +72,38 @@ gulp.task('scripts', function() {
 #### Example JavaScript File
 
 ```js
-var configValue = '/* @echo FOO */' || 'default value';
+var configValue = "/* @echo FOO */" || "default value";
 
 // @ifdef DEBUG
-someDebuggingCall()
+someDebuggingCall();
 // @endif
 ```
 
 CoffeeScript files are also supported.
 
-
 #### More Examples
 
 `gulp-preprocess` uses [preprocess](https://github.com/jsoverson/preprocess#directive-syntax). More examples can be found in its [README](https://github.com/jsoverson/preprocess#directive-syntax).
 
-
 ## API
 
 ### preprocess(options)
 
 #### options.context
+
 Type: `Object`
 Default: `{}`
 
 Context for directives used in your preprocessed files. The default context consists of the current user environment variables. Custom context is merged with `process.env`.
 
 #### options.includeBase
+
 Type: `String`
 
 Base directory for included files. By default, the path to included files is relative to the file currently being processed.
 
 #### options.extension
+
 Type: `String`
 
 Override the file extension. This determines what [regular expressions are used for comments](https://github.com/jsoverson/preprocess/blob/master/lib/regexrules.js). You may wish to do this if you are using a custom extension or need to force a particular comment syntax (for example, to allow HTML-style comments in `.php` files).

package/index.js

@@ -1,10 +1,10 @@
-var _     = require('lodash');
-var map   = require('map-stream');
-var pp    = require('preprocess');
-var path  = require('path');
+var _ = require("lodash");
+var map = require("map-stream");
+var pp = require("preprocess");
+var path = require("path");
 
-module.exports = function (options) {
-  var opts    = _.merge({}, options);
+module.exports = function(options) {
+  var opts = _.merge({}, options);
   var context = _.merge({}, process.env, opts.context);
 
   function ppStream(file, callback) {
@@ -12,17 +12,20 @@ module.exports = function (options) {
 
     // TODO: support streaming files
     if (file.isNull()) return callback(null, file); // pass along
-    if (file.isStream()) return callback(new Error("gulp-preprocess: Streaming not supported"));
+    if (file.isStream())
+      return callback(new Error("gulp-preprocess: Streaming not supported"));
 
     context.src = file.path;
     context.srcDir = opts.includeBase || path.dirname(file.path);
-    context.NODE_ENV = context.NODE_ENV || 'development';
+    context.NODE_ENV = context.NODE_ENV || "development";
 
-    extension = _.isEmpty(opts.extension) ? getExtension(context.src) : opts.extension;
+    extension = _.isEmpty(opts.extension)
+      ? getExtension(context.src)
+      : opts.extension;
 
-    contents = file.contents.toString('utf8');
+    contents = file.contents.toString("utf8");
     contents = pp.preprocess(contents, context, extension);
-    file.contents = new Buffer(contents);
+    file.contents = Buffer.from(contents);
 
     callback(null, file);
   }
@@ -31,6 +34,6 @@ module.exports = function (options) {
 };
 
 function getExtension(filename) {
-  var ext = path.extname(filename||'').split('.');
+  var ext = path.extname(filename || "").split(".");
   return ext[ext.length - 1];
 }

package/package.json

@@ -1,32 +1,34 @@
 {
   "name": "gulp-preprocess",
   "description": "Gulp plugin to preprocess HTML, JavaScript, and other files based on custom context or environment configuration",
-  "version": "1.2.0",
-  "homepage": "http://github.com/jas/gulp-preprocess",
+  "version": "3.0.2",
+  "homepage": "http://github.com/pioug/gulp-preprocess",
   "repository": {
     "type": "git",
-    "url": "http://github.com/jas/gulp-preprocess.git"
+    "url": "http://github.com/pioug/gulp-preprocess.git"
   },
   "author": "Jason Sandmeyer",
   "main": "./index.js",
   "dependencies": {
-    "lodash": "2.4.x",
-    "map-stream": "0.1.x",
-    "preprocess": "2.1.x"
+    "lodash": "^4.17.11",
+    "map-stream": "^0.1.x",
+    "preprocess": "^3.0.0"
   },
   "devDependencies": {
-    "gulp-util": "2.2.x",
-    "mocha": "*",
-    "should": "*"
+    "eslint": "^5.13.0",
+    "mocha": "^5.2.0",
+    "prettier": "^1.16.4",
+    "should": "^13.2.3",
+    "vinyl": "^2.2.0"
   },
   "engines": {
-    "node": ">= 0.9.0"
+    "node": ">= 6.14.3"
   },
   "scripts": {
     "test": "mocha --reporter spec"
   },
   "bugs": {
-    "url": "https://github.com/jas/gulp-preprocess/issues"
+    "url": "https://github.com/pioug/gulp-preprocess/issues"
   },
   "directories": {
     "test": "test"

package/test/expected/test-base.html

@@ -2,6 +2,8 @@
 <html>
 <head>
   <title>dev title</title>
+
+
 </head>
 <body>
   <h1>bar</h1>

package/test/expected/test.coffee

@@ -4,5 +4,7 @@ define [], ->
   "use strict"
 
   superExpensiveFunction()
+
+
   !foobar!
   

package/test/expected/test.html

@@ -2,6 +2,8 @@
 <html>
 <head>
   <title>dev title</title>
+
+
 </head>
 <body>
   <h1>bar</h1>

package/test/expected/test.js

@@ -6,6 +6,8 @@ define([], function () {
   bar
 
   superExpensiveFunction()
+
+
   !foobar!
   
 

package/test/main.js

@@ -1,140 +1,144 @@
-var should = require('should');
-var gutil = require('gulp-util');
-var preprocess = require('../');
-var fs = require('fs');
+var should = require("should");
+var File = require("vinyl");
+var preprocess = require("../");
+var fs = require("fs");
 
-require('mocha');
+require("mocha");
 
 function fixtureFile(fileName) {
-  return new gutil.File({
-    base: 'test/fixtures',
-    cwd: 'test/',
-    path: 'test/fixtures/' + fileName,
-    contents: fs.readFileSync('test/fixtures/' + fileName)
+  return new File({
+    base: "test/fixtures",
+    cwd: "test/",
+    path: "test/fixtures/" + fileName,
+    contents: fs.readFileSync("test/fixtures/" + fileName)
   });
-};
+}
 
-process.env['FAKEHOME'] = '/Users/jas';
+process.env["FAKEHOME"] = "/Users/jas";
 
-describe('gulp-preprocess', function(){
-  describe('preprocess()', function(){
-
-    it('should preprocess html', function(done){
+describe("gulp-preprocess", function() {
+  describe("preprocess()", function() {
+    it("should preprocess html", function(done) {
       var stream = preprocess({
         context: {
-          firstOption: 'bar',
-          secondOption: 'foo'
+          firstOption: "bar",
+          secondOption: "foo"
         }
       });
 
-      var fakeFile = fixtureFile('test.html');
+      var fakeFile = fixtureFile("test.html");
 
-      stream.once('data', function(newFile){
+      stream.once("data", function(newFile) {
         should.exist(newFile);
         should.exist(newFile.contents);
-        String(newFile.contents).should.equal(fs.readFileSync('test/expected/test.html', 'utf8'));
+        String(newFile.contents).should.equal(
+          fs.readFileSync("test/expected/test.html", "utf8")
+        );
         done();
       });
       stream.write(fakeFile);
-
     });
 
-    it('should preprocess javascript', function(done){
+    it("should preprocess javascript", function(done) {
       var stream = preprocess({
         context: {
-          firstOption: 'bar',
-          secondOption: 'foo'
+          firstOption: "bar",
+          secondOption: "foo"
         }
       });
 
-      var fakeFile = fixtureFile('test.js');
+      var fakeFile = fixtureFile("test.js");
 
-      stream.once('data', function(newFile){
+      stream.once("data", function(newFile) {
         should.exist(newFile);
         should.exist(newFile.contents);
-        String(newFile.contents).should.equal(fs.readFileSync('test/expected/test.js', 'utf8'));
+        String(newFile.contents).should.equal(
+          fs.readFileSync("test/expected/test.js", "utf8")
+        );
         done();
       });
       stream.write(fakeFile);
-
     });
 
-    it('should preprocess coffeescript', function(done){
+    it("should preprocess coffeescript", function(done) {
       var stream = preprocess({
         context: {
-          firstOption: 'bar',
-          secondOption: 'foo'
+          firstOption: "bar",
+          secondOption: "foo"
         }
       });
 
-      var fakeFile = fixtureFile('test.coffee');
+      var fakeFile = fixtureFile("test.coffee");
 
-      stream.once('data', function(newFile){
+      stream.once("data", function(newFile) {
         should.exist(newFile);
         should.exist(newFile.contents);
-        String(newFile.contents).should.equal(fs.readFileSync('test/expected/test.coffee', 'utf8'));
+        String(newFile.contents).should.equal(
+          fs.readFileSync("test/expected/test.coffee", "utf8")
+        );
         done();
       });
       stream.write(fakeFile);
-
     });
 
-    it('should preprocess without options object', function(done){
+    it("should preprocess without options object", function(done) {
       var stream = preprocess();
 
-      var fakeFile = fixtureFile('test.coffee');
+      var fakeFile = fixtureFile("test.coffee");
 
-      stream.once('data', function(newFile){
+      stream.once("data", function(newFile) {
         should.exist(newFile);
         should.exist(newFile.contents);
-        String(newFile.contents).should.equal(fs.readFileSync('test/expected/test.coffee', 'utf8'));
+        String(newFile.contents).should.equal(
+          fs.readFileSync("test/expected/test.coffee", "utf8")
+        );
         done();
       });
       stream.write(fakeFile);
-
     });
 
-    it('should preprocess html with custom base', function(done){
+    it("should preprocess html with custom base", function(done) {
       var stream = preprocess({
-        includeBase: 'test/fixtures/base',
+        includeBase: "test/fixtures/base",
         context: {
-          firstOption: 'bar',
-          secondOption: 'foo'
+          firstOption: "bar",
+          secondOption: "foo"
         }
       });
 
-      var fakeFile = fixtureFile('test.html');
+      var fakeFile = fixtureFile("test.html");
 
-      stream.once('data', function(newFile){
+      stream.once("data", function(newFile) {
         should.exist(newFile);
         should.exist(newFile.contents);
-        String(newFile.contents).should.equal(fs.readFileSync('test/expected/test-base.html', 'utf8'));
+        String(newFile.contents).should.equal(
+          fs.readFileSync("test/expected/test-base.html", "utf8")
+        );
         done();
       });
       stream.write(fakeFile);
-
     });
 
-    it('should allow custom extension', function(done){
+    it("should allow custom extension", function(done) {
       var stream = preprocess({
-        extension: 'html',
+        extension: "html",
         context: {
-          firstOption: 'bar',
-          secondOption: 'foo'
+          firstOption: "bar",
+          secondOption: "foo"
         }
       });
 
-      var fakeFile = fixtureFile('test.php');
+      var fakeFile = fixtureFile("test.php");
 
-      stream.once('data', function(newFile){
+      stream.once("data", function(newFile) {
         should.exist(newFile);
         should.exist(newFile.contents);
-        String(newFile.contents).should.equal(fs.readFileSync('test/expected/test.html', 'utf8'));
+        String(newFile.contents).should.equal(
+          fs.readFileSync("test/expected/test.html", "utf8")
+        );
         done();
       });
       stream.write(fakeFile);
-
     });
-
   });
 });

package/.npmignore

@@ -1 +0,0 @@
-/node_modules/