azp: vscode-ext Update Readme

ChristopherHX · Oct 29, 2023 · 90e38fa · 90e38fa
1 parent 9c0f1bc
commit 90e38fa
Show file tree

Hide file tree

Showing 3 changed files with 74 additions and 8 deletions.
diff --git a/docs/azure-pipelines/images/demo.gif b/docs/azure-pipelines/images/demo.gif
diff --git a/src/azure-pipelines-vscode-ext/README.md b/src/azure-pipelines-vscode-ext/README.md
@@ -1,6 +1,8 @@
 # Azure Pipelines VSCode Extension
 
-This is a minimal Azure Pipelines Extension
+This is a minimal Azure Pipelines Extension, the first vscode Extension which can Validate and Expand Azure Pipeline YAML files locally without any REST service.
+
+![Demo](https://github.com/ChristopherHX/runner.server/blob/main/docs/azure-pipelines/demo.gif?raw=true)
 
 ## Features
 
@@ -24,6 +26,39 @@ _Once this extension has been activated by any command, you can validate your pi
 
 This command tries to evaluate your current open Azure Pipeline including templates and show the result in a new document, which you can save or validate via the official api.
 
+### Azure Pipelines Debug Adapter
+
+Sample Debugging configuration
+```jsonc
+{
+    "type": "azure-pipelines-vscode-ext",
+    "request": "launch",
+    "name": "Test Pipeline (watch)",
+    "program": "${workspaceFolder}/azure-pipeline.yml",
+    "repositories": {},
+    "parameters": {},
+    "variables": {},
+    "watch": true,
+    "preview": true
+}
+```
+
+## Pros
+- Make changes in multiple dependent template files and show a live preview on save
+- Everything is done locally
+- Whole template engine is open source
+- You can run template files with the same template engine locally using the Runner.Client tool using the official Azure Pipelines Agent
+- Fast feedback
+- Less trial and error commits
+- You can help by reporting bugs
+- It's fully Open Source under the MIT license
+
+## Cons
+- May contain different bugs than the Azure Pipelines Service
+- You could self-host Azure Devops Server and commit your changes to your local system, may have license implications with more accurate results of the template engine
+- May not have feature parity with Azure Pipelines
+- Missing predefined Variables, feel free to add them manually as needed
+
 ## Running the Extension
 
 ```sh

diff --git a/src/azure-pipelines-vscode-ext/package.json b/src/azure-pipelines-vscode-ext/package.json
@@ -83,21 +83,21 @@
 							"trace": {
 								"type": "boolean",
 								"description": "Enable logging of the Debug Adapter Protocol.",
-								"default": false
+								"default": true
 							},
 							"watch": {
 								"type": "boolean",
 								"description": "Keep Debug Session alive and watch for changes",
-								"default": false
+								"default": true
 							},
 							"preview": {
 								"type": "boolean",
-								"description": "Keep Debug Session alive and watch for changes",
+								"description": "Opens a live Preview side by side to your current code editor, if disabled you will only see a message with the conclusion",
 								"default": true
 							},
 							"repositories": {
 								"type": "object",
-								"description": "Syntax \"[<owner>/]<repo>@<ref>\": \"<uri>\". <uri> can be formed like file:///<folder>, vscode-vfs://github/<owner>/<repository> and vscode-vfs://azurerepos/<owner>/<project>/<repository>",
+								"description": "Syntax \"[owner/]repo@ref\": \"uri\". uri can be formed like file:///folder, vscode-vfs://github/owner/repository and vscode-vfs://azurerepos/owner/project/repository",
 								"additionalProperties": {
 									"type": "string"
 								}
@@ -111,7 +111,7 @@
 							"parameters": {
 								"type": "object",
 								"additionalProperties": {},
-								"description": "Syntax \"<name>\": <json object>"
+								"description": "Syntax \"name\": json-object"
 							}
 						}
 					}
@@ -120,11 +120,13 @@
 					{
 						"type": "azure-pipelines-vscode-ext",
 						"request": "launch",
-						"name": "Test Pipeline",
+						"name": "Test Pipeline (watch)",
 						"program": "${workspaceFolder}/azure-pipeline.yml",
 						"repositories": {},
 						"parameters": {},
-						"variables": {}
+						"variables": {},
+						"preview": true,
+						"watch": true
 					}
 				],
 				"configurationSnippets": [
@@ -140,6 +142,35 @@
 							"parameters": {},
 							"variables": {}
 						}
+					},
+					{
+						"label": "Azure Pipeline Debug: Launch (preview)",
+						"description": "A new configuration for checking a single azure pipeline file.",
+						"body": {
+							"type": "azure-pipelines-vscode-ext",
+							"request": "launch",
+							"name": "Test Pipeline (preview)",
+							"program": "^\"\\${workspaceFolder}/azure-pipeline.yml\"",
+							"repositories": {},
+							"parameters": {},
+							"variables": {},
+							"preview": true
+						}
+					},
+					{
+						"label": "Azure Pipeline Debug: Launch (watch)",
+						"description": "A new configuration for checking a single azure pipeline file.",
+						"body": {
+							"type": "azure-pipelines-vscode-ext",
+							"request": "launch",
+							"name": "Test Pipeline (watch)",
+							"program": "^\"\\${workspaceFolder}/azure-pipeline.yml\"",
+							"repositories": {},
+							"parameters": {},
+							"variables": {},
+							"preview": true,
+							"watch": true
+						}
 					}
 				]
 			}