Skip to content

Latest commit

 

History

History
70 lines (63 loc) · 2.64 KB

instructions.md

File metadata and controls

70 lines (63 loc) · 2.64 KB
Raw

VSCode instructions

Install VSCode

  1. Install VS code binary. Here are links to Windows, macOS, linux-debian
  2. Start VSCode, on macOS press CMD+ and type code
  3. Install YAML support for VSCode. Here is the github repo

JSON/YAML Setup

  1. Edit "user.settings" on macOS CMD+, or click on Code -> Preferences -> Settings
  2. In the search bar search for json.schemas VS-Code-Setup
  3. Click on settings.json
  4. Cut-n-paste the following settings
{
    "[yaml]": {
        "editor.insertSpaces": true,
        "editor.tabSize": 2,
        "editor.quickSuggestions": {
            "other": true,
            "comments": false,
            "strings": true
        },
        "editor.autoIndent": true
    },
    "editor.renderWhitespace": "all",
    "editor.tabSize": 2,
    "editor.autoIndent": true,
    "yaml.format.enable": true,
    "yaml.trace.server": "verbose",
    "yaml.customTags": [
        "!And",
        "!If",
        "!Not",
        "!Equals",
        "!Or",
        "!FindInMap",
        "!Base64",
        "!Cidr",
        "!Ref",
        "!Sub",
        "!GetAtt",
        "!GetAZs",
        "!ImportValue",
        "!Select",
        "!Split",
        "!Join"
    ],
    "json.schemas": [
        {
            "fileMatch": [
                "*-template.json"
            ],
            "url": "https://s3.amazonaws.com/cfn-resource-specifications-us-east-1-prod/schemas/2.15.0/all-spec.json"
        }
    ],
    "yaml.schemas": {
        "https://s3.amazonaws.com/cfn-resource-specifications-us-east-1-prod/schemas/2.15.0/all-spec.json": "*-template.yaml"
    }
}
  1. Create new file with the extension specified in the mapping (e.g; my-app-template.json, or my-app-template.yaml). VSCode will use the mapping to determine which files should be treated as CloudFormation templates.

YAML Gotchas

YAML is very whitespace sensitive for code completion. YAML LSP support does not deal with whitespace correctly. Here are tips to follow along if code completion isn't working as desired

  1. Ensure to get rid of all white spaces below the line you are editing (redhat-developer/vscode-yaml#141)
  2. Remember that you can not edit in between. Editing towards the end is the only one works. You still will have some partial results but experience is sub-par. This is true for all json schemas