feat: add support for snippets and toolbar button for action command

Signed-off-by: Owen Rumney <[email protected]>

CHANGELOG.md

@@ -2,6 +2,11 @@
 
 All notable changes to the "tfsec" extension will be documented in this file.
 
+### 1.8.0
+- Add snippets support
+  - using `tfsec-check-file` in a yaml file to create custom check
+  - using `tfsec-custom-check` in the existing check file to add a new custom check
+- Add icon on toolbar to get the version
 
 ### 1.7.5
 - Update the severity icons inline with Aqua colours

README.md

@@ -24,6 +24,12 @@ Ignore codes will be automatically resolved and the description of the error wil
 
 ## Release Notes
 
+### 1.8.0
+- Add snippets support
+  - using `tfsec-check-file` in a yaml file to create custom check
+  - using `tfsec-custom-check` in the existing check file to add a new custom check
+- Add icon on toolbar to get the version
+
 ### 1.7.5
 - Update the severity icons inline with Aqua colours
 

package.json

@@ -3,7 +3,7 @@
   "displayName": "tfsec",
   "publisher": "tfsec",
   "description": "tfsec integration for Visual Studio Code",
-  "version": "1.7.5",
+  "version": "1.8.0",
   "engines": {
     "vscode": "^1.54.0"
   },
@@ -101,7 +101,11 @@
       },
       {
         "command": "tfsec.version",
-        "title": "tfsec: Get the current version of tfsec"
+        "title": "tfsec: Get the current version of tfsec",
+        "icon": {
+          "light": "resources/light/help.svg",
+          "dark": "resources/dark/help.svg"
+        }
       }
     ],
     "viewsContainers": {
@@ -156,6 +160,11 @@
           "command": "tfsec.updatebinary",
           "when": "view == tfsec.issueview",
           "group": "navigation@2"
+        },
+        {
+          "command": "tfsec.version",
+          "when": "view == tfsec.issueview",
+          "group": "navigation@2"
         }
       ],
       "view/item/context": [
@@ -172,7 +181,13 @@
           "when": "view == tfsec.issueview && viewItem == TFSEC_SEVERITY"
         }
       ]
-    }
+    },
+    "snippets": [
+      {
+        "language": "yaml",
+        "path": "./src/snippets/custom_checks.json"
+      }
+    ]
   },
   "scripts": {
     "vscode:prepublish": "npm run esbuild-base -- --minify",

src/snippets/custom_checks.json

@@ -0,0 +1,48 @@
+{
+    "custom_checks_yaml": {
+        "prefix": [
+            "tfsec-check-file"
+        ],
+        "body": [
+            "---",
+            "checks:",
+            "  - code: ${1}",
+            "    description: ${2}",
+            "    requiredTypes:",
+            "      - ${3:resource}",
+            "    requiredLabels:",
+            "      - ${4}",
+            "    severity: ${5:MEDIUM}",
+            "    matchSpec:",
+            "    name: ${6}",
+            "    action: ${7}",
+            "    value: ${8}",
+            "    errorMessage: ${9}",
+            "    relatedLinks:",
+            "      - ${10}"
+        ],
+        "description": "Add the body for custom checks file."
+    },
+    "custom_check": {
+        "prefix": [
+            "tfsec-custom-check"
+        ],
+        "body": [
+            "  - code: ${1}",
+            "    description: ${2}",
+            "    requiredTypes:",
+            "      - ${3:resource}",
+            "    requiredLabels:",
+            "      - ${4}",
+            "    severity: ${5:MEDIUM}",
+            "    matchSpec:",
+            "    name: ${6}",
+            "    action: ${7}",
+            "    value: ${8}",
+            "    errorMessage: ${9}",
+            "    relatedLinks:",
+            "      - ${10}"
+        ],
+        "description": "Add the body for an individual custom check."
+    }
+}

src/tfsec_wrapper.ts

@@ -34,7 +34,7 @@ export class TfsecWrapper {
             return;
         }
 
-        var files = readdirSync(this.resultsStoragePath).filter(fn => fn.endsWith('_results.json') || fn.endsWith('_results.json.json') );
+        var files = readdirSync(this.resultsStoragePath).filter(fn => fn.endsWith('_results.json') || fn.endsWith('_results.json.json'));
         files.forEach(file => {
             let deletePath = path.join(this.resultsStoragePath, file);
             unlinkSync(deletePath);
@@ -59,6 +59,7 @@ export class TfsecWrapper {
             execution.on('exit', function (code) {
                 if (code !== 0) {
                     vscode.window.showErrorMessage("tfsec failed to run");
+                    outputChannel.show();
                     return;
                 };
                 vscode.window.showInformationMessage('tfsec ran successfully, updating results');