chore: release v2.0.0

Author: yocontra

.jscsrc

@@ -1,5 +1,7 @@
 language: node_js
 node_js:
+  - '12'
+  - '11'
   - '10'
   - '9'
   - '8'

.jshintrc

@@ -0,0 +1,10 @@
+# v2.0.0
+
+#### Breaking
+
+- Add the ability to use the function argument as an immutable map function (This may be breaking for users who were relying on the return value of the function being ignored)
+
+#### Chores
+
+- Update deps
+- Switch from JSCS/JSHint to Prettier

.travis.yml

@@ -4,57 +4,54 @@ var Stream = require('stream');
 var Path = require('path');
 
 function gulpRename(obj, options) {
-
   options = options || {};
 
-  var stream = new Stream.Transform({objectMode: true});
+  var stream = new Stream.Transform({ objectMode: true });
 
   function parsePath(path) {
-    var extname = options.multiExt ? Path.basename(path).slice(Path.basename(path).indexOf('.')) : Path.extname(path);
+    var extname = options.multiExt
+      ? Path.basename(path).slice(Path.basename(path).indexOf('.'))
+      : Path.extname(path);
     return {
       dirname: Path.dirname(path),
       basename: Path.basename(path, extname),
       extname: extname
     };
   }
 
-  stream._transform = function (originalFile, unused, callback) {
-
-
-    var file = originalFile.clone({contents: false});
+  stream._transform = function(originalFile, unused, callback) {
+    var file = originalFile.clone({ contents: false });
     var parsedPath = parsePath(file.relative);
     var path;
 
     var type = typeof obj;
 
     if (type === 'string' && obj !== '') {
-
       path = obj;
-
     } else if (type === 'function') {
-
       let newParsedPath = obj(parsedPath, file);
       if (typeof newParsedPath === 'object' && newParsedPath !== null) {
         parsedPath = newParsedPath;
       }
-      
-      path = Path.join(parsedPath.dirname, parsedPath.basename + parsedPath.extname);
 
+      path = Path.join(
+        parsedPath.dirname,
+        parsedPath.basename + parsedPath.extname
+      );
     } else if (type === 'object' && obj !== undefined && obj !== null) {
-
       var dirname = 'dirname' in obj ? obj.dirname : parsedPath.dirname,
         prefix = obj.prefix || '',
         suffix = obj.suffix || '',
         basename = 'basename' in obj ? obj.basename : parsedPath.basename,
         extname = 'extname' in obj ? obj.extname : parsedPath.extname;
 
       path = Path.join(dirname, prefix + basename + suffix + extname);
-
     } else {
-
-      callback(new Error('Unsupported renaming parameter type supplied'), undefined);
+      callback(
+        new Error('Unsupported renaming parameter type supplied'),
+        undefined
+      );
       return;
-
     }
 
     file.path = Path.join(file.base, path);

CHANGELOG.md

@@ -1,6 +1,6 @@
 {
   "name": "gulp-rename",
-  "version": "1.4.0",
+  "version": "2.0.0",
   "description": "Rename files",
   "keywords": [
     "gulpplugin"
@@ -21,17 +21,16 @@
     "url": "git://github.com/hparra/gulp-rename.git"
   },
   "scripts": {
-    "pretest": "jscs index.js test/ && jshint index.js test/",
+    "pretest": "prettier --single-quote --write index.js test/**/*.js",
     "test": "mocha"
   },
   "devDependencies": {
-    "gulp": "^4.0.0",
-    "gulp-sourcemaps": "^2.6.4",
-    "jscs": "^3.0.0",
-    "jshint": "^2.0.0",
+    "gulp": "^4.0.2",
+    "gulp-sourcemaps": "^2.6.5",
     "map-stream": "^0.0.7",
-    "mocha": "^5.0.0",
-    "should": "^13.0.0",
+    "mocha": "^6.0.0",
+    "prettier": "^1.19.1",
+    "should": "^13.2.3",
     "vinyl": "^2.0.0"
   },
   "engines": {

index.js

@@ -4,129 +4,134 @@
 require('./spec-helper');
 var Path = require('path');
 
-describe('gulp-rename path parsing', function () {
-  describe('dirname', function () {
-    context('when src pattern contains no globs', function () {
-      it('dirname is \'.\'', function (done) {
+describe('gulp-rename path parsing', function() {
+  describe('dirname', function() {
+    context('when src pattern contains no globs', function() {
+      it("dirname is '.'", function(done) {
         var srcPattern = 'test/fixtures/hello.txt';
-        var obj = function (path) {
+        var obj = function(path) {
           path.dirname.should.equal('.');
         };
         helper(srcPattern, obj, null, done);
       });
     });
 
-    context('when src pattern contains filename glob', function () {
-      it('dirname is \'.\'', function (done) {
+    context('when src pattern contains filename glob', function() {
+      it("dirname is '.'", function(done) {
         var srcPattern = 'test/fixtures/*.min.txt';
-        var obj = function (path) {
+        var obj = function(path) {
           path.dirname.should.equal('.');
         };
         helper(srcPattern, obj, null, done);
       });
     });
 
-    var dirnameHelper = function (srcPattern) {
-      it('dirname is path from directory glob to file', function (done) {
-        var obj = function (path) {
+    var dirnameHelper = function(srcPattern) {
+      it('dirname is path from directory glob to file', function(done) {
+        var obj = function(path) {
           path.dirname.should.match(/^fixtures[0-9]?$/);
         };
         helper(srcPattern, obj, null, done);
       });
     };
 
-    context('when src pattern matches a directory with *', function () {
+    context('when src pattern matches a directory with *', function() {
       dirnameHelper('test/*/*.min.txt');
     });
 
-    context('when src pattern matches a directory with **', function () {
+    context('when src pattern matches a directory with **', function() {
       dirnameHelper('test/**/*.min.txt');
     });
 
-    context('when src pattern matches a directory with [...]', function () {
+    context('when src pattern matches a directory with [...]', function() {
       dirnameHelper('test/fixt[a-z]res/*.min.txt');
     });
 
-    context('when src pattern matches a directory with {...,...}', function () {
+    context('when src pattern matches a directory with {...,...}', function() {
       dirnameHelper('test/f{ri,ixtur}es/*.min.txt');
     });
 
     /* SKIP: glob2base does not handle brace expansion as expected. See wearefractal/glob2base#1 */
-    context.skip('when src pattern matches a directory with {#..#}', function () {
-      dirnameHelper('test/fixtures{0..9}/*.min.txt');
-    });
-
-    context('when src pattern matches a directory with an extglob', function () {
+    context.skip(
+      'when src pattern matches a directory with {#..#}',
+      function() {
+        dirnameHelper('test/fixtures{0..9}/*.min.txt');
+      }
+    );
+
+    context('when src pattern matches a directory with an extglob', function() {
       dirnameHelper('test/f+(ri|ixtur)es/*.min.txt');
     });
 
-    context('when src pattern includes `base` option', function () {
-      it('dirname is path from given directory to file', function (done) {
+    context('when src pattern includes `base` option', function() {
+      it('dirname is path from given directory to file', function(done) {
         var srcPattern = 'test/**/*.min.txt';
-        var srcOptions = {base: process.cwd()};
-        var obj = function (path) {
+        var srcOptions = { base: process.cwd() };
+        var obj = function(path) {
           path.dirname.should.equal(Path.join('test', 'fixtures'));
         };
-        helper({pattern: srcPattern, options: srcOptions}, obj, null, done);
+        helper({ pattern: srcPattern, options: srcOptions }, obj, null, done);
       });
     });
   });
 
-  describe('basename', function () {
-    it('strips extension like Path.basename(path, ext)', function (done) {
+  describe('basename', function() {
+    it('strips extension like Path.basename(path, ext)', function(done) {
       var srcPattern = 'test/fixtures/hello.min.txt';
-      var obj = function (path) {
+      var obj = function(path) {
         path.basename.should.equal('hello.min');
-        path.basename.should.equal(Path.basename(srcPattern, Path.extname(srcPattern)));
+        path.basename.should.equal(
+          Path.basename(srcPattern, Path.extname(srcPattern))
+        );
       };
       helper(srcPattern, obj, null, done);
     });
   });
 
-  describe('extname', function () {
-    it('includes \'.\' like Path.extname', function (done) {
+  describe('extname', function() {
+    it("includes '.' like Path.extname", function(done) {
       var srcPattern = 'test/fixtures/hello.txt';
-      var obj = function (path) {
+      var obj = function(path) {
         path.extname.should.equal('.txt');
         path.extname.should.equal(Path.extname(srcPattern));
       };
       helper(srcPattern, obj, null, done);
     });
 
-    it('excludes multiple extensions like Path.extname', function (done) {
+    it('excludes multiple extensions like Path.extname', function(done) {
       var srcPattern = 'test/fixtures/hello.min.txt';
-      var obj = function (path) {
+      var obj = function(path) {
         path.extname.should.equal('.txt');
         path.extname.should.equal(Path.extname(srcPattern));
       };
       helper(srcPattern, obj, null, done);
     });
   });
 
-  describe('multiExt option', function () {
-    it('includes multiple extensions in extname', function (done) {
+  describe('multiExt option', function() {
+    it('includes multiple extensions in extname', function(done) {
       var srcPattern = 'test/fixtures/hello.min.txt';
-      var obj = function (path) {
+      var obj = function(path) {
         path.extname.should.equal('.min.txt');
         path.basename.should.equal('hello');
       };
       helper(srcPattern, obj, null, done, { multiExt: true });
     });
   });
 
-  describe('original file context', function () {
-    it('passed to plugin as second argument', function (done) {
+  describe('original file context', function() {
+    it('passed to plugin as second argument', function(done) {
       var srcPattern = 'test/fixtures/hello.min.txt';
-      var obj = function (path, file) {
+      var obj = function(path, file) {
         file.should.be.instanceof(Object);
         file.should.be.ok();
       };
       helper(srcPattern, obj, null, done, { multiExt: true });
     });
 
-    it('has expected properties', function (done) {
+    it('has expected properties', function(done) {
       var srcPattern = 'test/fixtures/hello.min.txt';
-      var obj = function (path, file) {
+      var obj = function(path, file) {
         file.path.should.equal(Path.resolve(srcPattern));
         file.base.should.equal(Path.dirname(Path.resolve(srcPattern)));
         file.basename.should.equal(Path.basename(srcPattern));

package.json

@@ -5,33 +5,29 @@ var Vinyl = require('vinyl');
 var sourceMaps = require('gulp-sourcemaps');
 require('should');
 
-describe('gulp-rename', function () {
-
-  context('when file has source map', function () {
-
-    it ('updates source map file to match relative path of renamed file', function (done) {
-
+describe('gulp-rename', function() {
+  context('when file has source map', function() {
+    it('updates source map file to match relative path of renamed file', function(done) {
       var init = sourceMaps.init();
       var stream = init
         .pipe(rename({ prefix: 'test-' }))
         .pipe(rename({ prefix: 'test-' }));
 
-      stream.on('data', function (file) {
+      stream.on('data', function(file) {
         file.sourceMap.file.should.equal('test-test-fixture.css');
         file.sourceMap.file.should.equal(file.relative);
         done();
       });
 
-      init.write(new Vinyl({
-        base: 'fixtures',
-        path: 'fixtures/fixture.css',
-        contents: new Buffer('')
-      }));
+      init.write(
+        new Vinyl({
+          base: 'fixtures',
+          path: 'fixtures/fixture.css',
+          contents: new Buffer('')
+        })
+      );
 
       init.end();
-
     });
-
   });
-
 });