aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorChimrod <>2024-01-14 14:19:29 +0100
committerChimrod <>2024-01-14 14:19:29 +0100
commit6c7c12803b3c17027309071a749939e0c8bb476c (patch)
tree9ecbc37f971608a121aa16ac2bbdd0718ab77e06
parent60cb98b4a27ff0f59298646c835606d0a9a47ba3 (diff)
Documentation update
-rw-r--r--documentation/vscode.md32
-rw-r--r--readme.md2
2 files changed, 33 insertions, 1 deletions
diff --git a/documentation/vscode.md b/documentation/vscode.md
new file mode 100644
index 0000000..cbc0370
--- /dev/null
+++ b/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
+
diff --git a/readme.md b/readme.md
index ce0f022..493d5cf 100644
--- a/readme.md
+++ b/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