Browse Source

Documentation update

Chimrod 3 months ago
parent
commit
6c7c12803b
2 changed files with 33 additions and 1 deletions
  1. 32 0
      documentation/vscode.md
  2. 1 1
      readme.md

+ 32 - 0
documentation/vscode.md

@@ -0,0 +1,32 @@
+# VSCode integration
+
+`tasks.json` vscode task to run the parser on current file:
+
+```
+{
+    "label": "QSP Parser",
+    "type": "shell",
+    "command": ".\\tools\\Parser\\qsp_parser.exe ${file}",
+    "presentation": {
+        "clear": true,
+        "focus": false,
+        "showReuseMessage": false,
+        "panel": "shared",
+        "reveal": "silent"
+    }
+}
+```
+
+and a `settings.json` part that runs said task when you save the file
+
+```
+"triggerTaskOnSave.tasks": {
+    "QSP Parser": [
+        "*.qsrc"
+    ]
+}
+```
+
+(requires Trigger Task on Save extension)
+https://marketplace.visualstudio.com/items?itemName=Gruntfuggly.triggertaskonsave 
+

+ 1 - 1
readme.md

@@ -39,7 +39,7 @@ results will be printed in the standard output:
 ### Return code
 
 The application will return the code `0` when all the tests are passed without
-errors or warnings and `1` otherwise.
+errors, warnings or debug report and `1` otherwise.
 
 ## Checks provided