Merge branch 'release/0.0.6'

Author: willasm

CHANGELOG.md

@@ -1,12 +1,15 @@
 # Change Log
 
 ## [0.0.6] 2022-02-01
-- Added - Files settings option to retain v-inc line in file.
+- Added - Files settings option to retain v-inc line in file (`RetainLine`).
+- Added - Files settings option to trim characters from start of line with V-INC macro (`TrimTextStart`).
+- Added - Files settings option to trim characters from end of line with V-INC macro (`TrimTextEnd`).
 - Added - Date and Time macros.
 - Added - Edit example files command.
+- Updated - Screenshot has been updated to reflect the new changes.
 
 ## [0.0.5] 2022-01-23
-- Fixed - Status bar item will default to `"name"` entry if `"displayName"` entry is not defined.
+- Fixed - Status bar item text will default to `"name"` entry if `"displayName"` entry is not defined.
 
 ## [0.0.4] 2022-01-17
 - Fixed - Will now create projects files list json file if it does not exist.

README.md

@@ -37,20 +37,24 @@ Here is the default settings...
 ```
 [
 	{
-		"filename": "example.md",
-		"filelocation": "${globalStorage}",
-		"enable": false,
+		"Filename": "example.md",
+		"FileLocation": "${globalStorage}",
+		"Enable": false,
 		"RetainLine": true,
-		"insertbefore": "",
-		"insertafter": ""
+		"InsertBefore": "",
+		"InsertAfter": ""
+		"TrimTextStart": 5,
+		"TrimTextEnd": 38
 	},
 	{
-		"filename": "example.js",
-		"filelocation": "${globalStorage}",
-		"enable": false,
+		"Filename": "example.js",
+		"FileLocation": "${globalStorage}",
+		"Enable": false,
 		"RetainLine": false,
-		"insertbefore": "v",
-		"insertafter": "-Beta"
+		"InsertBefore": "v",
+		"InsertAfter": "-Beta"
+		"TrimTextStart": 0,
+		"TrimTextEnd": 0
 	}
 ]
 ```
@@ -66,10 +70,14 @@ The `"FileLocation":` entry is the path to the file to update. This can be set t
 
 `"InsertAfter":` String to insert after the new version string.
 
+`"TrimTextStart":` Number of characters to trim from the start of the line with the v-inc macro.
 
-To see this extension in operation, open the example files with the command `Version Inc: Edit Example Files`, then enable the example files (Set Enable to true), then run the increment version command to see the results.
+`"TrimTextEnd":` Number of characters to trim from the end of the line with the v-inc macro.
 
-Note: The `RetainLine` option was added in v0-0-0-6 so if you have modified the settings file from a previous version you will need to add the line to the settings file (see the example settings above).
+
+To see this extension in operation, open the example files with the command `Version Inc: Edit Example Files`, then enable the example files (Set Enable to true), then run the increment version command to see the results. Note that this will increment the version in your package.json file but you can use the command `Version Inc: Decrement Package.json Version` to restore it after you have examined the example files.
+
+Note: The `RetainLine`, `"TrimTextStart"` and `"TrimTextStart"` options were added in v0-0-0-6 so if you have modified the settings file from a previous version you will need to add the line to the settings file (see the example settings above).
 
 Note: The updated files are not automatically saved. This allows you to review the changes made and to continue making any other changes you require.
 

RELEASE.md

@@ -1,9 +1,12 @@
 # Release Notes
 
 ## [0.0.6] 2022-02-01
-- Added - Files settings option to retain v-inc line in file.
+- Added - Files settings option to retain v-inc line in file (`RetainLine`).
+- Added - Files settings option to trim characters from start of line with V-INC macro (`TrimTextStart`).
+- Added - Files settings option to trim characters from end of line with V-INC macro (`TrimTextEnd`).
 - Added - Date and Time macros.
 - Added - Edit example files command.
+- Updated - Screenshot has been updated to reflect the new changes.
 
 
 For a full list of changes, please see the projects [Changelog](CHANGELOG.md) file.

images/version-inc-demo.gif

@@ -289,10 +289,12 @@ async function updateOtherFiles(newVersion) {
         }
 
         // Retrieve the rest of the settings
-        var enable = packageJson[i]['Enable'];          // Enable replace flag
-        var insBefore = packageJson[i]['InsertBefore']; // String to insert before version string
-        var insAfter = packageJson[i]['InsertAfter'];   // String to insert after version string
-        var retainLine = packageJson[i]['RetainLine'];  // Retain version string trigger line
+        var enable = packageJson[i]['Enable'];                      // Enable replace flag
+        var insBefore = packageJson[i]['InsertBefore'];             // String to insert before version string
+        var insAfter = packageJson[i]['InsertAfter'];               // String to insert after version string
+        var retainLine = packageJson[i]['RetainLine'];              // Retain version string macro line
+        var trimTextStart = packageJson[i]['TrimTextStart'];        // Number of characters to trim from start of line
+        var trimTextEnd = packageJson[i]['TrimTextEnd'];            // Number of characters to trim from end of line
         var newVersionString = insBefore + newVersion + insAfter;   // Final new version string
 
         //----------------------------------------
@@ -338,8 +340,8 @@ async function updateOtherFiles(newVersion) {
         var date = new Date();
         var [year, month, day] = [date.getFullYear(), date.getMonth()+1, date.getDate()];
         var [hours, minutes, seconds] = [date.getHours(), date.getMinutes(), date.getSeconds()];
-//hours = 12; // For testing hours, REMOVE when done
-//month = 12; // For testing months, REMOVE when done
+        //hours = 12; // For testing hours, REMOVE when done
+        //month = 12; // For testing months, REMOVE when done
         var h12 = hours;
         var h24 = hours;
         var ampmU = 'AM';
@@ -512,11 +514,14 @@ async function updateOtherFiles(newVersion) {
                 }
 
                 if (vincMatched) {
-                    if (retainLine == true) {
-                        result = text+'\n\n'+result;    // Save Trigger Line for Reuse
-                    }
                     dirtyFlag = true;
+                    if (trimTextStart > 0 || trimTextEnd > 0) {
+                        result = result.substring(trimTextStart,result.length-trimTextEnd)
                     }
+                    if (retainLine == true) {
+                        result = text+'\n\n'+result;            // Save Macro Line for Reuse
+                    }
+                }
 
                 //----------------------------------------
                 // Now Replace Current Line in the File
@@ -539,11 +544,44 @@ async function updateOtherFiles(newVersion) {
 async function initSettingsFilePath(context) {
 
     // Default files list settings json file
-    const defaultSettings = "[\n\t{\n\t\t\"Filename\": \"example.md\",\n\t\t\"FileLocation\": \"${globalStorage}\",\n\t\t\"Enable\": false,\n\t\t\"RetainLine\": true,\n\t\t\"InsertBefore\": \"\",\n\t\t\"InsertAfter\": \"\"\n\t},\n\t{\n\t\t\"Filename\": \"example.js\",\n\t\t\"FileLocation\": \"${globalStorage}\",\n\t\t\"Enable\": false,\n\t\t\"RetainLine\": false,\n\t\t\"InsertBefore\": \"v\",\n\t\t\"InsertAfter\": \"-Beta\"\n\t}\n]\n";
+    const defaultSettings = '[\n\t' +
+                            '{\n\t\t' +
+                            '\"Filename\": \"example.md\",\n\t\t' +
+                            '\"FileLocation\": \"${globalStorage}\",\n\t\t' +
+                            '\"Enable\": false,\n\t\t' +
+                            '\"RetainLine\": true,\n\t\t' +
+                            '\"InsertBefore\": \"\",\n\t\t' +
+                            '\"InsertAfter\": \"\",\n\t\t' +
+                            '\"TrimTextStart\": 5,\n\t\t' +
+                            '\"TrimTextEnd\": 38\n\t' +
+                            '},\n\t' +
+                            '{\n\t\t' +
+                            '\"Filename\": \"example.js\",\n\t\t' +
+                            '\"FileLocation\": \"${globalStorage}\",\n\t\t' +
+                            '\"Enable\": false,\n\t\t' +
+                            '\"RetainLine\": false,\n\t\t' +
+                            '\"InsertBefore\": \"v\",\n\t\t' +
+                            '\"InsertAfter\": \"-Beta\",\n\t\t' +
+                            '\"TrimTextStart\": 0,\n\t\t' +
+                            '\"TrimTextEnd\": 0\n\t' +
+                            '}\n' +
+                            ']\n';
     // example.md file
-    const exampleMD = "# Example of using Version-Inc in a markdown file\n\n## Change Log\n\n## [v-inc] - ${DATE}\n";
+    const exampleMD = '# Version-Inc example in a markdown file\n\n' +
+                      '## Change Log\n\n' +
+                      '<!-- ## [v-inc] - ${YEAR4}-${MONTHNUMBER}-${DATE} Note: this Line will be preserved -->\n';
     // example.js file
-    const exampleJS = "//----------------------------------\n// Version-Inc example in a java script file\n//\n// File version: V-INC\n//\n// Product version: v-inc\n//----------------------------------\n";
+    const exampleJS = '//--------------------------------------------------\n' +
+                      '// Version-Inc example in a java script file\n' +
+                      '//--------------------------------------------------\n' +
+                      '//\n' +
+                      '// Last Modification: ${MONTHTEXTL} ${DATE} ${YEAR4}\n' +
+                      '//                At: ${H12}:${MIN}:${SEC} ${AMPMU}\n' +
+                      '//\n' +
+                      '// File Version...: V-INC\n' +
+                      '//\n' +
+                      '// Product version: v-inc\n' +
+                      '//--------------------------------------------------\n';
     // If folder does exist then verifiy extensions files exist
     if (fs.existsSync(globalSettingsPath)) {
         if (!fs.existsSync(globalSettingsFile)) {