fix: only log file count for files actually injected (closes #184)

Author: joakimbeng

package.json

@@ -25,7 +25,8 @@
   "scripts": {
     "lint": "xo",
     "pretest": "npm run -s lint",
-    "test": "mocha -R spec src/**/*_test.js"
+    "test": "mocha -R spec src/**/*_test.js",
+    "release": "standard-version"
   },
   "dependencies": {
     "arrify": "^1.0.1",
@@ -39,6 +40,8 @@
   "devDependencies": {
     "mocha": "~2.0.1",
     "should": "^4.0.4",
+    "standard-version": "^2.2.1",
+    "strip-color": "^0.1.0",
     "xo": "^0.13.0"
   },
   "engines": {
@@ -51,7 +54,10 @@
       "node"
     ],
     "rules": {
-      "object-shorthand": [2, "never"]
+      "object-shorthand": [
+        2,
+        "never"
+      ]
     }
   }
 }

src/inject/index.js

@@ -12,6 +12,7 @@ var getFilepath = require('../path');
 var PluginError = gutil.PluginError;
 var magenta = gutil.colors.magenta;
 var cyan = gutil.colors.cyan;
+var noop = function noop() {};
 
 /**
  * Constants
@@ -103,19 +104,20 @@ function handleVinylStream(sources, opt) {
  * @returns {Buffer}
  */
 function getNewContent(target, collection, opt) {
-  if (!opt.quiet) {
-    if (collection.length) {
-      log(cyan(collection.length) + ' files into ' + magenta(target.relative) + '.');
+  var logger = opt.quiet ? noop : function (filesCount) {
+    if (filesCount) {
+      log(cyan(filesCount) + ' files into ' + magenta(target.relative) + '.');
     } else {
       log('Nothing to inject into ' + magenta(target.relative) + '.');
     }
-  }
+  };
   var content = String(target.contents);
   var targetExt = extname(target.path);
   var files = prepareFiles(collection, targetExt, opt);
   var filesPerTags = groupArray(files, 'tagKey');
   var startAndEndTags = Object.keys(filesPerTags);
   var matches = [];
+  var injectedFilesCount = 0;
 
   startAndEndTags.forEach(function (tagKey) {
     var files = filesPerTags[tagKey];
@@ -128,12 +130,17 @@ function getNewContent(target, collection, opt) {
       endTag: endTag,
       tagsToInject: tagsToInject,
       removeTags: opt.removeTags,
+      willInject: function (filesToInject) {
+        injectedFilesCount += filesToInject.length;
+      },
       onMatch: function (match) {
         matches.push(match[0]);
       }
     });
   });
 
+  logger(injectedFilesCount);
+
   if (opt.empty) {
     var ext = '{{ANY}}';
     var startTag = getTagRegExp(opt.tags.start(targetExt, ext, opt.starttag), ext, opt);
@@ -191,6 +198,11 @@ function inject(content, opt) {
       throw error('Missing end tag for start tag: ' + startMatch[0]);
     }
     var toInject = opt.tagsToInject.slice();
+
+    if (typeof opt.willInject === 'function') {
+      opt.willInject(toInject);
+    }
+
     // <everything before startMatch>:
     var newContents = content.slice(0, startMatch.index);
 

src/inject/inject_test.js

@@ -6,6 +6,7 @@ var path = require('path');
 var es = require('event-stream');
 var should = require('should');
 var gutil = require('gulp-util');
+var stripColor = require('strip-color');
 var inject = require('../../.');
 
 describe('gulp-inject', function () {
@@ -522,6 +523,33 @@ describe('gulp-inject', function () {
     });
   });
 
+  it('should produce log output only for files actually injected (issue #184)', function (done) {
+    var logOutput = [];
+    gutil.log = function (a, b) {
+      logOutput.push(a + ' ' + b);
+    };
+
+    var target = src(['template2.html'], {read: true});
+    var sources = src([
+      'lib.js',
+      'component.html',
+      'styles.css',
+      'image.png'
+    ]);
+
+    var stream = target.pipe(inject(sources));
+
+    // Dummy data reader to make the `end` event be triggered
+    stream.on('data', function () {
+    });
+
+    stream.on('end', function () {
+      logOutput.should.have.length(1);
+      stripColor(logOutput[0]).should.equal('gulp-inject 1 files into template2.html.');
+      done();
+    });
+  });
+
   it('should be able to modify only the filepath (Issue #107)', function (done) {
     var version = '1.0.0';