diff --git a/vscode-extensions/vscode-bosh/README.md b/vscode-extensions/vscode-bosh/README.md index c3fbd6e47..7cc1d4061 100644 --- a/vscode-extensions/vscode-bosh/README.md +++ b/vscode-extensions/vscode-bosh/README.md @@ -1,20 +1,37 @@ -# Concourse Pipeline and Task Editor for Visual Studio Code +# Bosh Deployment Manifest Editor for Visual Studio Code This extension provides validation, content assist and documentation hovers -for editing [Concourse](https://concourse.ci/) Pipeline and Task configuration files. +for editing [Bosh](https://bosh.io/) Deployment Manifest files. ## Usage -The Concourse editor automatically activates when the name of the `.yml` file you are editing +### Activating the Editor + +The Bosh editor automatically activates when the name of the `.yml` file you are editing follows a certain pattern: - - `**/*pipeline*.yml` : activates support for editing pipelines - - `**/tasks/*.yml` : activates support for editing tasks. + - `**/*deployment*.yml` : activates support for bosh manifest file. -You can also define your own patterns and map them to the language-ids `concourse-pipeline-yaml` -or `concourse-task-yaml` by defining `files.associations` in workspace settings. +You can also define your own patterns and map them to the language-id `bosh-deployment-manifest` +by defining `files.associations` in workspace settings. See [vscode documentation](https://code.visualstudio.com/Docs/languages/overview#_adding-a-file-extension-to-a-language) for details. +### Targetting a specific Director + +Some Validation and Content Assist use information dymanically retrieved from an active Bosh director. +For these feature to work it is required that you + +- have the bosh cli V2 installed (information is obtained by executing commands using the V2 cli) +- target a director by setting the `BOSH_ENVIROMENT` variable. + +You can verify that you have set things up right by executing command: + +``` +bosh cloud-config --json +``` + +If setup correctly, it should return information about the cloud-config on your intended bosh director/environment. + ## Functionality ### Validation @@ -27,8 +44,7 @@ an error marker to see an explanation: ### Content assist Having trouble remembering all the names of the attributes, and their spelling? Or can't remember -which resource properties to set in the `get` task params versus its `source` attributes? Or -don't remember what 'special' values are acceptable for a certain property? Content assist +the exact name/version of the stemcell you just uploaded to your bosh environment? Content assist to the rescue: ![Content Assist Screenshot][ca1] @@ -44,11 +60,11 @@ read its detailed documentation: ### Goto Symbol in File -Is your Pipeline yaml file getting larger and is it becoming harder to find a particular Job, Resource or -Resource Type declaration? The "Goto Symbol in File" command helps you quickly jump to a specific +Is your Deployment Manifest getting larger and is it becoming harder to find a particular Instance Group, +Release, or Stemcell definition? The "Goto Symbol in File" command helps you quickly jump to a specific definition. -Type `CTRL-SHIFT-O` to popup a list of all symbols in your current Pipeline file. Start typing a name +Type `CTRL-SHIFT-O` to popup a list of all symbols in your current file. Start typing a name (or portion thereof) to narrow down the list. Select a symbol to jump directly to its location in the file. @@ -56,36 +72,26 @@ file. ### Goto/Peek Definition -Use "Goto Defition" or "Peek Definition" to quickly go (or peek) from a a Job- or Resource name +Use "Goto Defition" or "Peek Definition" to quickly go (or peek) from a Release or Stemcell name to its corresponding definition. ![Peek Definition Screenshot][peek] -## Limitations +### V2 versus V1 Schena -This Vscode Extension is still a work in progress. At the moment only a select few of the [built-in resource-types](https://concourse.ci/resource-types.html) -have been fully defined in the Editor's Schema. +The editor is intended primarily to support editing manifests in the [V2 schema](https://bosh.io/docs/manifest-v2.html). +When you use attributes from the V1 schema the editor will detect this however and switch to 'V1 tolerance' mode. -The resource-types that are already defined in the schema are: - - - git - - docker-image - - s3 - - pool - - semver - - time - -For other resource-types content assist and checking is still very limited. We intend -to grow this list and provide a similar level of support for all of the built-in resource types in -the near future. +In this mode, V1 properties are accepted but marked with deprecation warnings and V2 properties are marked as (unknown property) +errors. ## Issues and Feature Requests Please report bugs, issues and feature requests on the [Github STS4 issue tracker](https://github.com/spring-projects/sts4/issues). -[linting]: https://raw.githubusercontent.com/spring-projects/sts4/98148c08b608ff365fb87b2de955d6833f7ee082/vscode-extensions/vscode-concourse/readme-imgs/linting.png -[ca1]: https://raw.githubusercontent.com/spring-projects/sts4/98148c08b608ff365fb87b2de955d6833f7ee082/vscode-extensions/vscode-concourse/readme-imgs/content-assist-1.png -[ca2]: https://raw.githubusercontent.com/spring-projects/sts4/98148c08b608ff365fb87b2de955d6833f7ee082/vscode-extensions/vscode-concourse/readme-imgs/content-assist-2.png -[hovers]: https://raw.githubusercontent.com/spring-projects/sts4/98148c08b608ff365fb87b2de955d6833f7ee082/vscode-extensions/vscode-concourse/readme-imgs/hover.png -[peek]: https://raw.githubusercontent.com/spring-projects/sts4/98148c08b608ff365fb87b2de955d6833f7ee082/vscode-extensions/vscode-concourse/readme-imgs/peek.png -[goto_symbol]: https://raw.githubusercontent.com/spring-projects/sts4/d095208cfb34b0f129e6b66d41d099955a712f81/vscode-extensions/vscode-concourse/readme-imgs/goto-symbol.png +[linting]: https://raw.githubusercontent.com/spring-projects/sts4/master/vscode-extensions/vscode-bosh/readme-imgs/linting.png +[ca1]: https://raw.githubusercontent.com/spring-projects/sts4/master/vscode-extensions/vscode-bosh/readme-imgs/content-assist-1.png +[ca2]: https://raw.githubusercontent.com/spring-projects/sts4/master/vscode-extensions/vscode-bosh/readme-imgs/content-assist-2.png +[hovers]: https://raw.githubusercontent.com/spring-projects/sts4/master/vscode-extensions/vscode-bosh/readme-imgs/hover.png +[peek]: https://raw.githubusercontent.com/spring-projects/sts4/master/vscode-extensions/vscode-bosh/readme-imgs/peek.png +[goto_symbol]: https://raw.githubusercontent.com/spring-projects/sts4/master/vscode-extensions/vscode-bosh/readme-imgs/goto-symbol.png diff --git a/vscode-extensions/vscode-concourse/readme-imgs/linting.png b/vscode-extensions/vscode-concourse/readme-imgs/linting.png index 93860ed82..8c36b575d 100644 Binary files a/vscode-extensions/vscode-concourse/readme-imgs/linting.png and b/vscode-extensions/vscode-concourse/readme-imgs/linting.png differ