new context menu, print all parameters command,..

- var from shell command output
- update documentation

Author: doi

.gitignore

@@ -1,2 +1,4 @@
-node_modules/*
-.vscode/*
+node_modules
+.vscode/
+.vscode-test/
+*.vsix

README.md

@@ -3,16 +3,17 @@
 This extension allow you to insert timestamp, copyright or any information to your file like comment below
 
 	/*
-	 * Created on Tue Feb 18 2020
+	 * Created on Tue Feb 18 2025
 	 *
-	 * Copyright (c) 2020 - Your Company
+	 * Copyright (c) 2025 - Your Company
 	 */
 
 ## Features
 
-- insert defined parameter like `date`, `time`, `datetime`, `day`, `month`, `month3`, `year`, `hour`, `minute`, `second`, `company`, `filename`
-- insert your own parameter and template
-- define multiple templates
+- insert defined variable like `date`, `time`, `datetime`, `day`, `month`, `month3`, `year`, `hour`, `minute`, `second`, `company`, `filename`, `workspacename`, `username`
+- insert your own variable and template
+- create variable from shell command output (experimental)
+- create multiple templates
 
 ## Install
 
@@ -26,14 +27,18 @@ Execute it from `Command Pallete` (menu View - Command Pallete...) then type com
 
 1. `FileHeaderComment: Insert Default Template at Cursor`
 2. `FileHeaderComment: Select from Available Templates`
+3. `FileHeaderCOmment: Print All Variables`
 
-The second command will show your available templates defined in Settings
+These commands can also be accessed from the context menu.
 
-If you want to set your own parameter and template (set from menu Preferences - User Settings), you can read explanation below
+The second command will display the available templates defined in Settings.
+You can see all available variables using command number 3.
+
+If you want to set your own variables and templates (set from the Preferences - User Settings menu), you can read the explanation below
 
 This is default configuration
 
-```
+```json
 	"fileHeaderComment.parameter":{
 		"*":{
 			"commentbegin": "/*",
@@ -53,21 +58,48 @@ This is default configuration
 	}
 ```
 
-Define all custom variables/paramenters in asterisk `*` like
+Define all custom variables/parameters in asterisk `*` like
 
+```json
+"fileHeaderComment.parameter":{
+	"*":{
+		"company": "Your Company"
+		"myvar1": "My Variable 1",
+		"myvar2": "My Variable 2"
+	}
+}
 ```
+
+You can create/override variables for specific file language, ie python
+
+```json
 "fileHeaderComment.parameter":{
 	"*":{
 		"company": "Your Company"
 		"myvar1": "My Variable 1",
 		"myvar2": "My Variable 2"
+	},
+	"python": {
+		"commentbegin": "\"\"\"",
+		"commentend": "\"\"\"",
+		"commentprefix": ""
 	}
 }
 ```
 
-Use your variable in template like (asterisk `*` will be default template)
+(Experimental) You can get shell command output as a variable like
 
+```json
+"fileHeaderComment.parameter: {
+	"myvar3": "cmd(ls -alh)"
+}"
 ```
+my_command inside `cmd(my_command)` i.e. `ls -alh` in the example above will be executed in the current file directory. It only captures the last line output of 255 characters.
+
+
+Use your variable in template like (asterisk `*` will be default template)
+
+```json
 "fileHeaderComment.template":{
 	"*":[
 		"${commentbegin}",
@@ -81,7 +113,7 @@ Use your variable in template like (asterisk `*` will be default template)
 ```
 You can define multiple templates, for instance template for MIT License
 
-```
+```json
 "fileHeaderComment.parameter":{
 	"*":{
 		"author": "Your Name",
@@ -117,33 +149,47 @@ You can define multiple templates, for instance template for MIT License
 ```
 You can use your `mit` template above by calling it through 	`Command Pallete` and choose `FileHeaderComment: Select from Available Templates`.
 
-You can use parameters below in your template
+You can use variables below in your template
 
+- `company` : print "Your Company"
 - `date` : print current date
-- `time` : print current time
 - `time24h` : print current time in 24 hour format
 - `datetime`: print current date + time
 - `datetime24h` : print current date + time in 24 hour format
-- `company` : print "Your Company"
 - `day`: print day of the month
-- `month`: print current month
-- `month3`: first-3 letters of the month, e.g "Mar"
-- `year`: print current year
+- `filename`: print filename,
 - `hour`: print current hour (24h)
 - `minute`: print current minute
+- `month`: print current month
+- `month3`: first-3 letters of the month, e.g "Mar"
+- `now`: same as datetime
+- `now24h`: same as datetime24h
 - `second`: print current second
-- `filename`: print filename
+- `time` : print current time
+- `time24h`: print current time in 24 hour format
+- `username`: user name
+- `weeknumber` : print week number,
+- `workspacename`: workspace name,
+- `year`: print current year
+- `yearshort`: print 2 digit of current year
 
 
 
 ## Release Notes
 ### 0.0.6
+- variable for specific file language
 - add month3 (thanks to @kfsone)
+- add workspacename (thanks to @ljahier)
+- add username (thanks to @mosayyeb-ebrahimi)
+- add context menu (thanks to @bwilliams-sequence)
+- custom variable from shell command output
+
 ### 0.0.5
 - fixing python comment style (thanks to @ronak1009)
+
 ### 0.0.4
 - support yaml, shellscript language (thanks to @waddyvic)
-- add day, month, hour, minute, second, filename parameter (thanks to @rcabg, @ternvein)
+- add day, month, hour, minute, second, filename variables (thanks to @rcabg, @ternvein)
 
 ### 0.0.3
 - fixing "unknown configuration setting" message in Settings (thanks to @isuda)
@@ -153,5 +199,4 @@ You can use parameters below in your template
 - bugfixes
 
 ### 0.0.1
-
 - Initial release

command.js

@@ -19,47 +19,50 @@
  * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  */
 
-var vscode = require('vscode');
+var vscode = require('vscode'),
+    os = require('os'),
+    exec_sync = require("child_process").execSync
 
-function insertFileHeaderComment(picked_template){
+// run shell command and get last line
+function run_shell_command(command){
+    var output = ""
+    try{
+        output = exec_sync(command, {encoding: 'utf8', cwd: vscode.window.activeTextEditor.document.fileName.split("/").slice(0,-1).join("/")});
+        if(output){
+            // take the last line of the output, trim it, and limit to 255 characters
+            output = (output.trim().split("\n").pop()+"").trim().substring(0, 255)
+        }
+    }catch(e){
+    }
+    return output
+}
+
+//https://www.w3resource.com/javascript-exercises/javascript-date-exercise-24.php
+Date.prototype.ISO8601_week_number = function(){
+    var tdt = new Date(this.valueOf()),
+        dayn = (this.getDay() + 6) % 7;
+    tdt.setDate(tdt.getDate() - dayn + 3);
+    var firstThursday = tdt.valueOf();
+    tdt.setMonth(0, 1);
+    if (tdt.getDay() !== 4){
+        tdt.setMonth(0, 1 + ((4 - tdt.getDay()) + 7) % 7);
+    }
+    return 1 + Math.ceil((firstThursday - tdt) / 604800000);
+}
+
+function get_all_variables(is_all){
     var workspace = vscode.workspace,
         editor = vscode.window.activeTextEditor,
-        // root = workspace.rootPath,
         prefix = 'fileHeaderComment',
         lang_id = editor.document.languageId,
-        t_default = workspace.getConfiguration(prefix+".template").get('*'),
-        // t_lang = workspace.getConfiguration(prefix+".template".get(lang_id),
-        r_default = workspace.getConfiguration(prefix+".parameter").get('*'),
         r_lang = workspace.getConfiguration(prefix+".parameter").get(lang_id),
-        template = [];
-    if(picked_template){
-        t_default = workspace.getConfiguration(prefix+".template").get(picked_template);
-        var tmp_r_default = workspace.getConfiguration(prefix+".parameter").get(picked_template);
-        if(tmp_r_default instanceof Object){
-            Object.assign(r_default, tmp_r_default);
-        }
-    }
-
-    //remove feature template detection per language
-    //this feature is replaced by "select from available templates"
-    // if((t_lang instanceof Array)){
-    //     template = t_lang;
-    // }else
-    if(t_default instanceof Array){
-        template = t_default;
-    }else{
-        template = [
-            "${commentbegin}",
-            "${commentprefix} Created on ${date}",
-            "${commentprefix}",
-            "${commentprefix} Copyright (c) ${year} ${company}",
-            "${commentend}"
-        ];
-    }
+        r_default = workspace.getConfiguration(prefix+".parameter").get('*');
+    
     var date = new Date(),
         h = (date.getHours()+"").padStart(2, '0'),
         m = (date.getMinutes()+"").padStart(2, '0'),
         s = (date.getSeconds()+"").padStart(2, '0'),
+        username = os.userInfo().username,
         replace = {
             'date': date.toDateString(),
             'time': date.toLocaleTimeString(),
@@ -70,12 +73,14 @@ function insertFileHeaderComment(picked_template){
             'year': date.getFullYear(),
             'company': 'Your Company',
             'filename': vscode.window.activeTextEditor.document.fileName.replace(/^.*[\\\/]/, ''),
-            'workspaceName': vscode.workspace.name,
+            'workspacename': vscode.workspace.name,
             'hour': h,
             'minute': m,
-            'second': s
+            'second': s,
+            'weeknumber': date.ISO8601_week_number(),
+            'yearshort': (date.getFullYear()+"").slice(-2),
+            username,
         };
-    
     replace = Object.assign(replace, {
         'commentbegin': '/*',
         'commentprefix': ' *',
@@ -85,8 +90,8 @@ function insertFileHeaderComment(picked_template){
     });
     replace.now = replace.datetime;
     replace.now24h = replace.datetime24h;
-    Object.assign(replace, r_default);
-    
+    Object.assign(replace, JSON.parse(JSON.stringify(r_default)));
+
     switch(lang_id){
         case "swift":
             replace.commentbegin = "/**";
@@ -102,6 +107,7 @@ function insertFileHeaderComment(picked_template){
         case "ruby":
         case "shellscript":
         case "yaml":
+        case "cmake":
         case "python":
             Object.assign(replace, {
                 'commentbegin': "#",
@@ -134,16 +140,70 @@ function insertFileHeaderComment(picked_template){
     }
     Object.assign(replace, r_lang);
 
+    for(var r_key in replace){
+        var r_val = replace[r_key]+""
+        // find cmd() syntax and replace it with the output (last line) of the command
+        if(r_val && r_val.indexOf("cmd(") === 0){
+            var shell_command = r_val.match(/^cmd\((.+?)\)$/);
+            if(shell_command && shell_command[1]){
+                replace[r_key] = run_shell_command(shell_command[1]);
+            }
+        }
+        if(!is_all && Array.isArray(replace[r_key])){
+            // take out if array
+            delete replace[r_key];
+        }
+    }
+    return JSON.parse(JSON.stringify(replace));
+}
+
+function insertFileHeaderComment(picked_template){
+    var workspace = vscode.workspace,
+        editor = vscode.window.activeTextEditor,
+        // root = workspace.rootPath,
+        prefix = 'fileHeaderComment',
+        lang_id = editor.document.languageId,
+        t_default = workspace.getConfiguration(prefix+".template").get('*'),
+        // t_lang = workspace.getConfiguration(prefix+".template".get(lang_id),
+        r_default = workspace.getConfiguration(prefix+".parameter").get('*'),
+        r_lang = workspace.getConfiguration(prefix+".parameter").get(lang_id),
+        template = [];
+    if(picked_template){
+        t_default = workspace.getConfiguration(prefix+".template").get(picked_template);
+        var tmp_r_default = workspace.getConfiguration(prefix+".parameter").get(picked_template);
+        if(tmp_r_default instanceof Object){
+            Object.assign(r_default, tmp_r_default);
+        }
+    }
+
+    //remove feature template detection per language
+    //this feature is replaced by "select from available templates"
+    // if((t_lang instanceof Array)){
+    //     template = t_lang;
+    // }else
+    if(t_default instanceof Array){
+        template = t_default;
+    }else{
+        template = [
+            "${commentbegin}",
+            "${commentprefix} Created on ${date}",
+            "${commentprefix}",
+            "${commentprefix} Copyright (c) ${year} ${company}",
+            "${commentend}"
+        ];
+    }
+    var replace = get_all_variables(true);
+
     if(!editor)
         return;
-    replace = JSON.parse(JSON.stringify(replace));
+
     var s_template = template.join("\n"),
         escape = function(string) {
             return string.replace(/([.*+?^${}()|\[\]\/\\])/g, "\\$1");
         };
-    for(var r in replace){
-        var regexp = new RegExp(escape("${"+r+"}"), "gi"),
-            replace_with = replace[r];
+    for(var r_key in replace){
+        var regexp = new RegExp(escape("${"+r_key+"}"), "gi"),
+            replace_with = replace[r_key];
         if(replace_with.join){
             replace_with = replace_with.join("\n"+ replace.commentprefix);
         }else if(replace_with.replace){
@@ -186,3 +246,26 @@ function insertFileHeaderCommentOther(){
         });
 }
 exports.insertFileHeaderCommentOther = insertFileHeaderCommentOther;
+
+exports.printAllParameters = function(){
+    var editor = vscode.window.activeTextEditor;
+    editor.edit(function(edit){
+        var unordered = get_all_variables(),
+            ordered = {};
+        Object.keys(unordered).sort().forEach(function(key) {
+          ordered[key] = unordered[key];
+        });
+        var output = []
+        output.push(ordered['commentbegin']);
+        output.push(ordered['commentprefix']+" Available parameters:");
+        for(var key in ordered){
+            if(['commentbegin', 'commentprefix', 'commentend'].indexOf(key) !== -1){
+                continue;
+            }
+            output.push(ordered['commentprefix']+" "+key+": "+ordered[key]);
+        }
+        output.push(ordered['commentend']);
+        // edit.insert(editor.selection.active, JSON.stringify(ordered, null, 2)+"\n");
+        edit.insert(editor.selection.active, output.join("\n")+"\n");
+    });
+};