Add env-var to replace env var in template strings (#175)

* Add env-var to replace env var in template strings

* Windows has it’s user in USERNAME

6 files changed, 67 insertions, 7 deletions

diff --git a/CHANGELOG.md b/CHANGELOG.md
index 552b4bc..1cdf8b6 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -6,6 +6,8 @@
 
 - Support for arbitrary tags (#169)
 
+- Replace environment variables in templated strings. If no environment variable can be found the name of the variable will be inserted (#110)
+
 ### Fix
 
 - Incorrect parameter name of template (#170)
diff --git a/LICENSE b/LICENSE
index b0772e0..4283dff 100644
--- a/LICENSE
+++ b/LICENSE
@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2017-2019 Christoph Schlosser
+Copyright (c) 2017-2020 Christoph Schlosser
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
diff --git a/package-lock.json b/package-lock.json
index 26ce289..5d9ebd8 100644
--- a/package-lock.json
+++ b/package-lock.json
@@ -406,6 +406,14 @@
       "integrity": "sha512-CwBLREIQ7LvYFB0WyRvwhq5N5qPhc6PMjD6bYggFlI5YyDgl+0vxq5VHbMOFqLg7hfWzmu8T5Z1QofhmTIhItA==",
       "dev": true
     },
+    "env-var": {
+      "version": "4.1.0",
+      "resolved": "https://registry.npmjs.org/env-var/-/env-var-4.1.0.tgz",
+      "integrity": "sha512-nPHfStlNHmQsxCmLe2Bjx+MARZ2/03/JkNpnDNSCW2uE/F1a59zePBf9Opj7Gp2d6EXowvYTl9nlL1V7ycVaIQ==",
+      "requires": {
+        "is-url": "~1.2.2"
+      }
+    },
     "es-abstract": {
       "version": "1.15.0",
       "resolved": "https://registry.npmjs.org/es-abstract/-/es-abstract-1.15.0.tgz",
@@ -812,6 +820,11 @@
       "integrity": "sha1-5HnICFjfDBsR3dppQPlgEfzaSpo=",
       "dev": true
     },
+    "is-url": {
+      "version": "1.2.4",
+      "resolved": "https://registry.npmjs.org/is-url/-/is-url-1.2.4.tgz",
+      "integrity": "sha512-ITvGim8FhRiYe4IQ5uHSkj7pVaPDrCTkNd3yq3cV7iZAcJdHTUMPMEHcqSOy9xZ9qFenQCvi+2wjH9a1nXqHww=="
+    },
     "is-wsl": {
       "version": "1.1.0",
       "resolved": "https://registry.npmjs.org/is-wsl/-/is-wsl-1.1.0.tgz",
diff --git a/package.json b/package.json
index 4e2618b..d863f36 100644
--- a/package.json
+++ b/package.json
@@ -253,6 +253,7 @@
     "test": "npm run compile && node ./node_modules/vscode/bin/test"
   },
   "dependencies": {
+    "env-var": "^4.1.0",
     "moment": "^2.20.1",
     "opn": "^5.2.0"
   },
diff --git a/src/Lang/Cpp/CppDocGen.ts b/src/Lang/Cpp/CppDocGen.ts
index 1e73804..2795ec6 100644
--- a/src/Lang/Cpp/CppDocGen.ts
+++ b/src/Lang/Cpp/CppDocGen.ts
@@ -1,10 +1,10 @@
+import * as env from "env-var";
 import * as moment from "moment";
-import { Position, Range, Selection, TextEditor, TextLine, WorkspaceEdit } from "vscode";
+import { Position, Range, Selection, TextEditor } from "vscode";
 import { IDocGen } from "../../Common/IDocGen";
 import { Config } from "../../Config";
 import { CppArgument } from "./CppArgument";
 import * as CppParser from "./CppParser";
-import { CppParseTree } from "./CppParseTree";
 import { CppToken, CppTokenType } from "./CppToken";
 
 export enum SpecialCase {
@@ -144,9 +144,31 @@ export class CppDocGen implements IDocGen {
         return indentedString;
     }
 
+    protected getEnvVars(replace: string): string {
+        let replacement = replace;
+        const regex = /\$\{env\:([\w|\d|_]+)\}/m;
+        let match: RegExpExecArray;
+
+        // tslint:disable-next-line:no-conditional-assignment
+        while ((match = regex.exec(replacement)) !== null) {
+            if (match.index === regex.lastIndex) {
+                regex.lastIndex++;
+            }
+
+            const m = match[1];
+
+            const envVar: string = env.get(m, m).asString();
+
+            replacement = replacement.replace("${env:" + m + "}", envVar);
+        }
+
+        return replacement;
+    }
+
     protected getTemplatedString(replace: string, template: string, param: string): string {
         const replacedTemplate = template.replace(replace, param);
-        return this.getIndentedTemplate(replacedTemplate);
+        const replacedWithEnv = this.getEnvVars(replacedTemplate);
+        return this.getIndentedTemplate(replacedWithEnv);
     }
 
     protected getMultiTemplatedString(replace: string[], template: string, param: string[]): string {
@@ -156,7 +178,7 @@ export class CppDocGen implements IDocGen {
               template = template.replace(replace[i], param[i]);
             }
         }
-        return template;
+        return this.getEnvVars(template);
     }
 
     protected getSmartText(): string {
@@ -453,13 +475,15 @@ export class CppDocGen implements IDocGen {
                             lines,
                             this.cfg.typeTemplateReplace,
                             this.cfg.Generic.returnTemplate,
-                            returnParams
+                            returnParams,
                         );
                     }
                     break;
                 }
                 case "custom": {
-                    lines.push(...this.cfg.Generic.customTags);
+                    this.cfg.Generic.customTags.forEach((elem) => {
+                        lines.push(this.getEnvVars(elem));
+                    });
                     break;
                 }
                 default: {
diff --git a/src/test/CppTests/Config.test.ts b/src/test/CppTests/Config.test.ts
index 3915f11..d479d2d 100644
--- a/src/test/CppTests/Config.test.ts
+++ b/src/test/CppTests/Config.test.ts
@@ -227,4 +227,24 @@ suite("C++ - Configuration Tests", () => {
         assert.equal("/**\n * @note\n */", result);
     });
 
+    test("Env variable", () => {
+        testSetup.cfg = new Config();
+        testSetup.cfg.Generic.order = ["custom"];
+        if (process.platform === "win32") {
+            testSetup.cfg.Generic.customTags = ["@author ${env:USERNAME}"];
+            const res = testSetup.SetLine("void foo();").GetResult();
+            // USERNAME env var is different for everybody
+            assert.notEqual("/**\n * @author USERNAME\n */", res);
+        } else {
+            testSetup.cfg.Generic.customTags = ["@author ${env:USER}"];
+            const res = testSetup.SetLine("void foo();").GetResult();
+            // USER env var is different for everybody
+            assert.notEqual("/**\n * @author USER\n */", res);
+        }
+
+        testSetup.cfg.Generic.customTags = ["@author ${env:MY_VARIABLE}"];
+        const result = testSetup.SetLine("void foo();").GetResult();
+        assert.equal("/**\n * @author MY_VARIABLE\n */", result);
+    });
+
 });