From 6c7c12803b3c17027309071a749939e0c8bb476c Mon Sep 17 00:00:00 2001 From: Chimrod <> Date: Sun, 14 Jan 2024 14:19:29 +0100 Subject: Documentation update --- documentation/vscode.md | 32 ++++++++++++++++++++++++++++++++ readme.md | 2 +- 2 files changed, 33 insertions(+), 1 deletion(-) create mode 100644 documentation/vscode.md 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 -- cgit v1.2.3