diff --git a/README.md b/README.md index a4eb309..5a78da9 100644 --- a/README.md +++ b/README.md @@ -1,65 +1,19 @@ -# azure-devops-yaml-pipeline-validator README +# Azure Pipelines YAML Validator -This is the README for your extension "azure-devops-yaml-pipeline-validator". After writing up a brief description, we recommend including the following sections. +This extension allows you to validate your Azure DevOps YAML pipelines without commiting them from within VS Code. -## Features +## Usage -Describe specific features of your extension including screenshots of your extension in action. Image paths are relative to this README file. - -For example if there is an image subfolder under your extension project workspace: - -\!\[feature X\]\(images/feature-x.png\) - -> Tip: Many popular extensions utilize animations. This is an excellent way to show off your extension! We recommend short, focused animations that are easy to follow. +From within a YAML file open the Command Palette (Ctrl+Shift+P) and select the 'Azure Pipelines YAML Validator: Validate' command. Your YAML file will then be validated and any problems reported. ## Requirements -If you have any requirements or dependencies, add a section describing those and how to install and configure them. - -## Extension Settings - -Include if your extension adds any VS Code settings through the `contributes.configuration` extension point. - -For example: - -This extension contributes the following settings: - -* `myExtension.enable`: enable/disable this extension -* `myExtension.thing`: set to `blah` to do something +None ## Known Issues -Calling out known issues can help limit users opening duplicate issues against your extension. - -## Release Notes - -Users appreciate release notes as you update your extension. +None ### 1.0.0 -Initial release of ... - -### 1.0.1 - -Fixed issue #. - -### 1.1.0 - -Added features X, Y, and Z. - ------------------------------------------------------------------------------------------------------------ - -## Working with Markdown - -**Note:** You can author your README using Visual Studio Code. Here are some useful editor keyboard shortcuts: - -* Split the editor (`Cmd+\` on macOS or `Ctrl+\` on Windows and Linux) -* Toggle preview (`Shift+CMD+V` on macOS or `Shift+Ctrl+V` on Windows and Linux) -* Press `Ctrl+Space` (Windows, Linux) or `Cmd+Space` (macOS) to see a list of Markdown snippets - -### For more information - -* [Visual Studio Code's Markdown Support](http://code.visualstudio.com/docs/languages/markdown) -* [Markdown Syntax Reference](https://help.github.com/articles/markdown-basics/) - -**Enjoy!** +Initial release of Azure Azure Pipelines YAML Validator diff --git a/images/Command.png b/images/Command.png new file mode 100644 index 0000000..3a6209b Binary files /dev/null and b/images/Command.png differ diff --git a/images/icon.png b/images/icon.png new file mode 100644 index 0000000..5ea8c14 Binary files /dev/null and b/images/icon.png differ diff --git a/package.json b/package.json index 6ba91fe..51aaf75 100644 --- a/package.json +++ b/package.json @@ -1,8 +1,21 @@ { "name": "azure-devops-yaml-pipeline-validator", - "displayName": "Azure DevOps YAML Pipeline Validator", - "description": "Validated Azure DevOps YAML Pipelines", - "version": "0.0.1", + "displayName": "Azure Pipelines YAML Validator", + "description": "Validates Azure DevOps YAML Pipelines", + "author": { + "name": "Tom Austin" + }, + "publisher": "Tom Austin", + "license": "MIT", + "icon": "images/icon.png", + "repository": { + "type": "git", + "url": "https://github.com/tomaustin700/YAML-Pipeline-Validator-VS-Code-Extension" + }, + "bugs": { + "url": "https://github.com/tomaustin700/YAML-Pipeline-Validator-VS-Code-Extension/issues" + }, + "version": "1.0.0", "engines": { "vscode": "^1.48.0" }, @@ -17,7 +30,7 @@ "commands": [ { "command": "azure-devops-yaml-pipeline-validator.validate", - "title": "Validate" + "title": "Azure Pipelines YAML Validator: Validate" } ], "menus": { @@ -53,4 +66,4 @@ "dependencies": { "got": "^11.5.2" } -} +} \ No newline at end of file diff --git a/src/extension.ts b/src/extension.ts index 6f4eff6..2bf1f0f 100644 --- a/src/extension.ts +++ b/src/extension.ts @@ -19,7 +19,7 @@ export function activate(context: vscode.ExtensionContext) { // The code you place here will be executed every time your command is executed // Display a message box to the user - //vscode.window.showInformationMessage('Validating YAML Pipeline'); + vscode.window.showInformationMessage('Validating Pipeline'); let editor = vscode.window.activeTextEditor; @@ -38,7 +38,7 @@ export function activate(context: vscode.ExtensionContext) { vscode.window.showInformationMessage('Valid YAML Pipeline'); } catch (error) { - let options: MessageOptions = { modal: false}; + let options: MessageOptions = { modal: true}; vscode.window.showErrorMessage('Invalid YAML Pipeline - ' + error.response.body, options); }