From b0c39e4843a93cf17b76305e4d74abee27d19108 Mon Sep 17 00:00:00 2001 From: Nils Mittler <70568139+mittler-works@users.noreply.github.com> Date: Tue, 30 Apr 2024 22:08:30 +0200 Subject: [PATCH] website/developer-docs: Add note for custom YAML tags in an IDE (#9528) Add note for custom tags in an IDE Custom tags are not provided via the schema file, but must be defined in the IDE. If this is not done, the IDE displays syntax errors when using the custom tags. Signed-off-by: Nils Mittler <70568139+mittler-works@users.noreply.github.com> --- website/developer-docs/blueprints/v1/tags.md | 21 ++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/website/developer-docs/blueprints/v1/tags.md b/website/developer-docs/blueprints/v1/tags.md index 045092274b..a931063b83 100644 --- a/website/developer-docs/blueprints/v1/tags.md +++ b/website/developer-docs/blueprints/v1/tags.md @@ -1,5 +1,26 @@ # YAML Tags +To use the custom tags with your preferred editor, you must make the editor aware of the custom tags. + +For VS Code, for example, add these entries to your `settings.json`: + +``` +{ + "yaml.customTags": [ + "!KeyOf scalar", + "!Env scalar", + "!Find sequence", + "!Context scalar", + "!Format sequence", + "!If sequence", + "!Condition sequence", + "!Enumerate sequence", + "!Index scalar", + "!Value scalar" + ] +} +``` + #### `!KeyOf` Example: