Add summary to logs (#133)

qetza · Mar 2, 2020 · d36c6fe · d36c6fe
1 parent edfadd1
commit d36c6fe
Show file tree

Hide file tree

Showing 4 changed files with 33 additions and 7 deletions.
diff --git a/README.md b/README.md
@@ -62,9 +62,12 @@ If you want to use tokens in XML based configuration files to be replaced during
   - replace tokens in your updated configuration file
 
 ## Release notes
+**New in 3.4.0**
+- Add summary in logs with number of tokens found and replaced ([#126](https://github.com/qetza/vsts-replacetokens-task/issues/126)).
+
 **New in 3.3.1**
 - **Breaking change**: If you were using negative pattern you need to use the semi colon `;` as a separator instead of new-line in _Target files_.
-- Fix negative pattern support  ([#127](https://github.com/qetza/vsts-replacetokens-task/issues/122)).
+- Fix negative pattern support ([#127](https://github.com/qetza/vsts-replacetokens-task/issues/127)).
 
 **New in 3.3.0**
 - Add support for custom output file and wildcard support ([#114](https://github.com/qetza/vsts-replacetokens-task/issues/114)).

diff --git a/task/index.ts b/task/index.ts
@@ -114,7 +114,14 @@ class Logger implements ILogger {
     }
 }
 
+class Counter {
+    public Tokens: number = 0;
+    public Replaced: number = 0;
+    public Files: number = 0;
+}
+
 var logger: ILogger = new NullLogger();
+var globalCounters: Counter = new Counter(); 
 
 var mapEncoding = function (encoding: string): string {
     switch (encoding)
@@ -203,8 +210,12 @@ var replaceTokensInFile = function (
     logger.debug('  using encoding: ' + encoding);
 
     // read file and replace tokens
+    let localCounter: Counter = new Counter();
+
     let content: string = iconv.decode(fs.readFileSync(filePath), encoding);
     content = content.replace(regex, (match, name) => {
+        ++localCounter.Tokens;
+
         let value: string = tl.getVariable(name);
 
         if (!value)
@@ -229,8 +240,13 @@ var replaceTokensInFile = function (
                     logger.debug(message);
             }
         }
-        else if (options.emptyValue && value === options.emptyValue)
-            value = '';
+        else
+        {
+            ++localCounter.Replaced;
+
+            if (options.emptyValue && value === options.emptyValue)
+                value = '';
+        }
 
         let escapeType: string = options.escapeType;
         if (escapeType === 'auto')
@@ -306,8 +322,12 @@ var replaceTokensInFile = function (
     };
     mkdirSyncRecursive(path.dirname(path.resolve(outputPath)));
 
-    // write file
+    // write file & log
     fs.writeFileSync(outputPath, iconv.encode(content, encoding, { addBOM: options.writeBOM, stripBOM: null, defaultEncoding: null }));
+    logger.info('  ' + localCounter.Replaced + ' tokens replaced out of ' + localCounter.Tokens);
+
+    globalCounters.Tokens += localCounter.Tokens;
+    globalCounters.Replaced += localCounter.Replaced;
 }
 
 var mapLogLevel = function (level: string): LogLevel {
@@ -418,8 +438,11 @@ async function run() {
                 }
 
                 replaceTokensInFile(filePath, outputPath, regex, options);
+                ++globalCounters.Files;
             });
         });
+
+        logger.info('replaced ' + globalCounters.Replaced + ' tokens out of ' + globalCounters.Tokens + ' in ' + globalCounters.Files + ' file(s).');
     }
     catch (err)
     {

diff --git a/task/task.json b/task/task.json
@@ -12,8 +12,8 @@
     "author": "Guillaume Rouchon",
     "version": {
         "Major": 3,
-        "Minor": 3,
-        "Patch": 1
+        "Minor": 4,
+        "Patch": 0
     },
     "instanceNameFormat": "Replace tokens in $(targetFiles)",
     "minimumAgentVersion": "2.105.0",

diff --git a/vss-extension.json b/vss-extension.json
@@ -2,7 +2,7 @@
     "manifestVersion": 1,
     "id": "replacetokens",
     "name": "Replace Tokens",
-    "version": "3.3.1",
+    "version": "3.4.0",
     "public": true,
     "publisher": "qetza",
     "targets": [