You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+21-6Lines changed: 21 additions & 6 deletions
Original file line number
Diff line number
Diff line change
@@ -21,11 +21,23 @@ Usage
21
21
YAML templates
22
22
------------------
23
23
24
-
Extension fully supports YAML templates. YAML template creation follows the same syntax rules: type **start** to populate new template.
24
+
Extension fully supports YAML templates. YAML template creation follows the same syntax rules:
25
25
26
-
YAML Language Server is required.
27
-
1. Install [YAML Language Server](https://marketplace.visualstudio.com/items?itemName=redhat.vscode-yaml)
28
-
2. Whitelist intrinsic function tags - paste preferences below into your User Settings (Ctrl + ,)
26
+
1. Create new YAML document
27
+
2. type **start** to populate new template
28
+
3.**Start typing** desired **resource name** and hit ```tab``` key
29
+
30
+
> **Note:** YAML support is dependent on YAML Language Server.
31
+
By default, YAML Language Server (Red Hat YAML recommended) will be installed automatically as prerequisite.
32
+
33
+
> **Note:** If you do not want to install YAML Language Server, install version **cform-noyaml.vsix** from GitHub [here]().
34
+
35
+
YAML setup
36
+
------------------
37
+
38
+
After installation, open your User Settings ```(Ctrl + ,)``` and paste preferences below into your settings file.
39
+
40
+
> **Note:** This will whitelist CloudFormation intrinsic functions tags. Otherwise you will end up with *Unknown Tag* showing up in your YAML document.
29
41
30
42
```json
31
43
// Custom tags for the parser to use
@@ -64,21 +76,24 @@ Known issues
64
76
When working with YAML documents, your current YAML language interpreter might not support syntax of AWS intrinsic functions, thus marking them as *unknown tag*.
65
77
This however has no effect on validity of the YAML document.
66
78
67
-
> **Note:** You can solve this issue by whitelisting specific tags following instructions under section **YAML Templates**.
79
+
> **Note:** You can solve this issue by whitelisting specific tags following instructions under section **YAML Setup**.
68
80
69
81
> **Note:** Tested only with Red Hat YAML Language Server
70
82
71
83

72
84
73
-
Contributing
85
+
Contributions
74
86
-------------------
87
+
Contributions:
75
88
76
89
1. Fork
77
90
2. Create your feature branch (git checkout -b my-new-feature)
78
91
3. Commit your changes (git commit -am 'Add some feature')
79
92
4. Push to the branch (git push origin my-new-feature)
0 commit comments