Skip to content

Latest commit

 

History

History
62 lines (39 loc) · 3.32 KB

README.md

File metadata and controls

62 lines (39 loc) · 3.32 KB
Raw

VSCode language support for IBM Cloud Schematics Blueprints

Create and edit blueprint templates in VSCode using the Redhat YAML language server extension and a blueprint template schema.

The Red Hat YAML VSCode extension provides a framework for editing blueprint yaml files, using a blueprint schema defined using JSON-Schema.

Support:

  • YAML language support with blueprint template schema validation
    • Validation of YAML structure and blueprint keywords
  • Autocomplete
    • Auto complete for template keywords
  • Hover support
    • Hovering over a keyword shows the blueprint schema description
  • Outlining for complex templates

1. Install the Red Hat YAML Language extension

Click on the “Extensions” button in the Activity Bar. It’s located on the side of VS Code’s client. Alternatively, you can use the keyboard shortcut “Ctrl+Shift+X” or "Cmd+Shift+X" on MacOS to open the “Extensions” screen.

This will bring you to the “Extensions” list. Type YAML in the search box and this will sort the available YAML extensions with the Red Hat extension at the top.

yamlextension

Click on Install to install the extension into your workspace.

2. Using the blueprint JSON schema

The blueprint JSON schema must be identified to VSCode. It is not automatically recognised. The association of the blueprint schema can be done either in the blueprint YAML file itself using a modeline or in the VSCode User or Workspace settings under the property yaml.schemas.

Associating the schema in the blueprint YAML file

It is possible to specify the blueprint schema using a modeline in the blueprint YAML file. The blueprint schema url can be a relative path to a local file or the url of the schema in the Cloud-Schematics Github repo.

Cut and paste the following text into the blueprint YAML file, within the first few lines of the file.

# yaml-language-server: $schema=https://raw.githubusercontent.com/Cloud-Schematics/vscode-blueprint-json-schema/master/blueprint_schema.json

Associating the blueprint schema via user and workspace settings

Alternatively the schema can be automatically applied using file matching defined in the VSCode user or workspace settings. The yaml.schemas setting applies a YAML schema to a file by file matching.

Open user and workspace settings and navigate to the extensions yaml.schemas section. Cut and paste the following value onto the section. The schema will be associated with all template files with the file pattern '*_blueprint.yaml'

yaml.schemas: {
    "https://raw.githubusercontent.com/Cloud-Schematics/blueprint-json-schema/master/vscode_blueprint_schema.json": "/*_blueprint.yaml"
}

Schema releases

Initial blueprint schema release

  • All blueprint template keywords defined for Blueprint Schema V1.0.0
  • No conditional evaluation of sub-schemas, e.g. source_type > github/catalog is broken after release 1.2.2. of the YAML extension. redhat-developer/vscode-yaml#769

Sample blueprint templates

Sample templates to validate the schema can be found in the /templates folder