Doesn't like AWS CloudFormation templates #20

ffxsam · 2017-11-20T15:35:21Z

I understand the CloudFormation format is a bit non-standard, but it would at least be nice to have an option in this extension to disable syntax-checking. I mostly want it since it adds the YAML structure to the Code Outline extension.

JPinkney · 2017-11-28T21:03:12Z

This is available in 0.0.7 of the language server!

ffxsam · 2017-11-29T00:10:38Z

@JPinkney YOU, SIR... are a hero.

richardmaltais · 2018-02-14T18:40:05Z

Hey, sorry to re-open an old issue, but I can't make the server to work with AWS CloudFormation. Is there a specific setting to input somewhere?

I'm on VS Code and I tried to reference to a schema, tried different ways, but it just doesn't work.

Thank you in advance!

esn89 · 2018-11-29T21:26:23Z

Bump. I was wanting to know if there is a setting I have to do

JPinkney · 2018-11-29T21:51:26Z

You have to manually add custom tags to the yaml.customTags setting. Here is the explanation from readme: yaml.customTags: Array of custom tags that the parser will validate against. It has two ways to be used. Either an item in the array is a custom tag such as "!Ref" or you can specify the type of the object !Ref should be by doing "!Ref Scalar". For example: ["!Ref", "!Some-Tag Scalar"]. The type of object can be one of Scalar, Sequence, Mapping, Map.

There are a few issues with custom tags that are known: #77.

From the snippet posted above I believe it would be
yaml.customTags: [
"!Sub"
]

or

yaml.customTags: [
"!Sub scalar"
]

(it defaults the type to scalar so you don't have to specify the scalar for the property)

esn89 · 2018-11-29T22:00:57Z

So all I have to do is, for each custom tag I have, I add them, AND a version with them with the word "Scalar" next to it?

esn89 · 2018-11-29T22:08:21Z

I have something like this set up:

				"customTags": [
					"!fn",
					"!And",
					"!If",
					"!Not",
					"!Equals",
					"!Or",
					"!FindInMap sequence",
					"!Base64",
					"!Cidr",
					"!Ref",
					"!Ref Scalar",
					"!Sub",
					"!GetAtt",
					"!GetAZs",
					"!ImportValue",
					"!Select",
					"!Split",
					"!Join sequence"
				]

But I am still getting this error: https://i.imgur.com/gj32GKq.png

JPinkney · 2018-11-29T22:12:41Z

"!Ref",
"!Ref Scalar",

You might be running into the issue in #77 (i'm not sure on first glance).

However, those two tags mean the same thing and the type should be lower cased (if you include it). You should only have to do either "!Ref" or "!Ref scalar".

If there still is an error after that can you open a new issue just to make sure everything is logged so it doesn't get forgotten!

esn89 · 2018-11-30T09:05:30Z

Hi @JPinkney,

Thanks for the help, so far I've kept it lean and only used the !Ref tag at the moment.

I have the langserv set up like so:

		"yaml": {
			"module": "/Users/esn89/.config/coc/extensions/node_modules/yaml-language-server/out/server/src/server.js",
			"filetypes": ["yaml"],
			"cwd": "./src",
			"settings": {
				"format.enable": true,
				"validate": true,
				"completion": true,
				"customTags": [
					"!Ref scalar"
				]
			}
		}

And I still have the same error of:
[yaml] [E] unknown tag <!Ref>

I am happy to say that the format settings, validate settings and completion works.
Am I doing something obviously wrong?

JPinkney · 2018-11-30T15:12:23Z

It looks right to me. I'm not sure if the customTags isn't being synced or whats going on because its working through VSCode:

esn89 · 2018-11-30T16:04:35Z

Thanks for your reply.

I am wondering if it could be a result of using a different client?

Right now I am using:
https://github.com/neoclide/coc.nvim/

And my entire set up looks like this:

	"languageserver": {
		"yaml": {
			"module": "/Users/esn89/.config/coc/extensions/node_modules/yaml-language-server/out/server/src/server.js",
			"filetypes": ["yaml"],
			"cwd": "./src",
			"settings": {
				"format.enable": true,
				"validate": true,
				"completion": true,
				"customTags": [
					"!Ref scalar",
					"!GetAtt",
					"!FindInMap sequence",
					"!FindInMap"
				],
				"schemas": {
					"https://raw.githubusercontent.com/awslabs/goformation/master/schema/cloudformation.schema.json": "/*"
				}
			}

		}
	}

JPinkney · 2018-11-30T16:32:21Z

I'm not entirely sure, does turning off and on validation/completion settings etc work? Also for custom tags you cant have both !FindInMap sequence and !FindInMap currently. It will result in error (see discussion in #77 (comment) for more info)

esn89 · 2018-11-30T16:36:30Z

Alright, so I have removed !FindInMap sequence turn off validation and completion (all set to false), however, I am still getting "[yaml] [E] unknown tag <!Ref>"

As this comes from the server, this should be client agnostic, yes?

JPinkney · 2018-11-30T16:48:57Z

As this comes from the server, this should be client agnostic, yes?

Correct, I was just trying to see whether the settings synced when you turned off validation and completion. When validation is false you shouldn't be getting any errors at all (regardless of if they exist or not). Do you know if there's any way to see the language server trace from that client?

esn89 · 2018-11-30T17:34:54Z

I will see if I can make that happen.

esn89 · 2018-11-30T18:34:52Z

So it turns out that my customTags: was in the wrong place. For my coc.nvim client, I have to do it like this to make it work:

	"yaml.schemas": {
		"https://raw.githubusercontent.com/awslabs/goformation/master/schema/cloudformation.schema.json": "/*"
	},
	"yaml.customTags": [
		"!Ref",
		"!GetAtt",
		"!fn",
		"!And",
		"!If",
		"!Not",
		"!Equals",
		"!Or",
		"!FindInMap sequence",
		"!Base64",
		"!Cidr",
		"!Sub",
		"!GetAZs",
		"!ImportValue",
		"!Select",
		"!Split",
		"!Join sequence"
	],
	"languageserver": {
		"yaml": {
			"module": "/Users/esn89/.config/coc/extensions/node_modules/yaml-language-server/out/server/src/server.js",
			"filetypes": ["yaml"],
			"cwd": "./src",
			"settings": {
				"format.enable": true,
				"validate": true,
				"completion": true
			}
		}
	}

Now it works. :D

My second question now is regarding the schemas, I have added the schema's as per:
https://raw.githubusercontent.com/awslabs/goformation/master/schema/cloudformation.schema.json

For CloudFormation, and at the moment it isn't doing anything to the file. My guess is that by adding this schema, it will check for the valid type and whether or not the keys are valid.

I have been putting in random values in my yaml file, typos on purpose and the wrong types. However, it doesn't seem to detect errors. Do I have the right impression of schemas? IS that what they're supposed to do?

JPinkney · 2018-11-30T18:56:05Z

hmm, after setting yaml.schemas are you able to activate any of the other features that rely on a schemas (such as autocomplete)?

My only guesses are that the schema is slow to load, its not being set, or the schema may not catching everything. Can you try out

AWSTemplateFormatVersion: False

and tell me if it errors

Do I have the right impression of schemas? IS that what they're supposed to do?

Yes, depending on how well built the schemas are

esn89 · 2018-11-30T19:12:41Z

Yup, I have reactivated them:

	"yaml.schemas": {
		"https://raw.githubusercontent.com/awslabs/goformation/master/schema/cloudformation.schema.json": "/*"
	},
	"yaml.customTags": [
		"!Ref",
		"!GetAtt",
		"!fn",
		"!And",
		"!If",
		"!Not",
		"!Equals",
		"!Or",
		"!FindInMap sequence",
		"!Base64",
		"!Cidr",
		"!Sub",
		"!GetAZs",
		"!ImportValue",
		"!Select",
		"!Split",
		"!Join sequence"
	],
	"languageserver": {
		"yaml": {
			"module": "/Users/esn89/.config/coc/extensions/node_modules/yaml-language-server/out/server/src/server.js",
			"filetypes": ["yaml"],
			"cwd": "./src",
			"settings": {
				"format.enable": true,
				"validate": true,
				"completion": true
			}
		}
	}

And with your suggestion of setting the flag to false, it doesn't seem to pick up any errors. In one of my resources like RDS::DBInstance, I put:
FOOOOOO: "bar" as a property and that, I would assume would trigger an error.
Could it be a issue with the /*?

JPinkney · 2018-11-30T19:23:02Z

Could it be a issue with the /*?

The /* is just telling the schema to map to all yaml files.

setting the flag to false

By flag do you mean AWSTemplateFormatVersion: False?

In one of my resources like RDS::DBInstance I put:
FOOOOOO: "bar" as a property and that, I would assume would trigger an error.

Can you post a snippet of that part its hard to diagnose without being able to see it. (I have no knowledge of AWS CloudFormation so I can only look at the schema and compare it with what I think it is doing).

Currently, can you trigger an error at all doing anything?

esn89 · 2018-11-30T19:35:08Z

Sure thing, let me show you:
https://i.imgur.com/8SG2z3G.png

Here is a picture of my vim with this.

And the corresponding config is in my previous post, I haven't changed anything.

JPinkney · 2018-11-30T19:47:45Z

I might have to actually go in and install everything to see if I can get it working, because I'm not exactly sure why the errors aren't showing. On VSCode I get this:

esn89 · 2018-11-30T19:50:37Z

Correct that is what it's supposed to happen, but it isn't what I am seeing. So it is working for you. Gah!!

You also have validation, completion and format installed?

I can give you the instructions to get this up running real quick (if you need/want):

grab neovim
install vim-plug into your neovim
install coc.nvim
install the coc-yaml for coc.nvim: :CocInstall coc-yaml
try my configuration file for coc.nvim. :CocConfig and paste my config:

{
	"coc.preferences.diagnostic.errorSign": " ",
	"coc.preferences.diagnostic.warningSign": " ",
	"coc.preferences.diagnostic.infoSign": " ",
	"coc.preferences.diagnostic.hintSign": "",
	"yaml.schemas": {
		"https://raw.githubusercontent.com/awslabs/goformation/master/schema/cloudformation.schema.json": "/*"
	},
	"yaml.customTags": [
		"!Ref",
		"!GetAtt",
		"!fn",
		"!And",
		"!If",
		"!Not",
		"!Equals",
		"!Or",
		"!FindInMap sequence",
		"!Base64",
		"!Cidr",
		"!Sub",
		"!GetAZs",
		"!ImportValue",
		"!Select",
		"!Split",
		"!Join sequence"
	],
	"languageserver": {
		"yaml": {
			"module": "/Users/esn89/.config/coc/extensions/node_modules/yaml-language-server/out/server/src/server.js",
			"filetypes": ["yaml"],
			"cwd": "./src",
			"settings": {
				"format.enable": true,
				"validate": true,
				"completion": true
			}
		}
	}
}

JPinkney · 2018-11-30T20:40:11Z

I think I may have found the issue. I'm still debugging but it looks like the trace is yielding this:

Which doesn't make sense at all. The schema is in a mangled format and thats probably why ?

EDIT: So I think I figured it out but i'm not really sure how to fix it. In neovim if you don't escape the dots inside the schema url then you get that mangled path (like above) but if you do you get:

because its trying to load a url with escaped dots.

esn89 · 2018-11-30T20:50:35Z

What would happen if in the first picture you add dots to the broken down url, like:

"schemas": {
"https://raw." {
"githubusercontent." {
..... .....

The URL definitely does look mangled. So is this a behavior of coc?

JPinkney · 2018-11-30T20:57:31Z

I'm not sure if its a behaviour of coc or something else but I don't think its an issue with the language server itself (because it only tries to interpret that mangled URL and can't). In VSCode for example we would get:

without having to escape the dots or anything.

I'm not sure if it helps at all but these were the settings I was using.

{
          "yaml.customTags": [
                  "!Ref",
                  "!GetAtt",
                  "!fn",
                  "!And",
                  "!If",
                  "!Not",
                  "!Equals",
                  "!Or",
                  "!FindInMap sequence",
                  "!Base64",
                  "!Cidr",
                  "!Sub",
                  "!GetAZs",
                  "!ImportValue",
                  "!Select",
                  "!Split",
                  "!Join sequence"
          ],
          "languageserver": {
                  "yaml": {
                          "module": "/Users/joshpinkney/.config/coc/extensions/node_modules/yaml-language-server/out/server/src/server.js",
                          "filetypes": ["yaml", "yml"],
                          "args": ["--stdio"]
                  }
          },
          "yaml.hover":true,
          "yaml.validate": true,
          "yaml.trace.server": "verbose",
          "yaml.schemas": {"https://raw\.githubusercontent\.com/awslabs/goformation/master/schema/cloudformation\.schema\.json": "/*"
          }

JPinkney · 2018-11-30T21:01:49Z

Interestingly enough the json language server does not run into this issue (although they use a slightly different way of configuring their schemas)

esn89 · 2018-11-30T21:05:48Z

So then for the json language server, and then json schema this works.......would rule out neovim, yes?

JPinkney · 2018-11-30T21:12:23Z

No, the problem is whatever is sending the requests to the language server is messing up the URL in the workspace/didChangeConfiguration request. JSON language server has a different way of setting up the schemas that doesn't trigger the errors. Actually now that I think about it, I think whats causing the issue is that they're splitting yaml.schemas and then splitting everything with a period after that so it results in the split up URL below, instead of preserving it.

JPinkney closed this as completed Nov 28, 2017

17twenty mentioned this issue Jul 19, 2018

[Regression] Cloudformation Support #77

Closed

esn89 mentioned this issue Nov 30, 2018

yaml-language-server sending the LanguageServer the wrong URL. neoclide/coc.nvim#215

Closed

Slooz mentioned this issue Jan 15, 2022

Allow string operations on nodes with custom tags mikefarah/yq#933

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Doesn't like AWS CloudFormation templates #20

Doesn't like AWS CloudFormation templates #20

ffxsam commented Nov 20, 2017

JPinkney commented Nov 28, 2017

ffxsam commented Nov 29, 2017

richardmaltais commented Feb 14, 2018

esn89 commented Nov 29, 2018

JPinkney commented Nov 29, 2018

esn89 commented Nov 29, 2018 •

edited

Loading

esn89 commented Nov 29, 2018

JPinkney commented Nov 29, 2018

esn89 commented Nov 30, 2018

JPinkney commented Nov 30, 2018

esn89 commented Nov 30, 2018

JPinkney commented Nov 30, 2018

esn89 commented Nov 30, 2018

JPinkney commented Nov 30, 2018

esn89 commented Nov 30, 2018

esn89 commented Nov 30, 2018

JPinkney commented Nov 30, 2018

esn89 commented Nov 30, 2018

JPinkney commented Nov 30, 2018

esn89 commented Nov 30, 2018 •

edited

Loading

JPinkney commented Nov 30, 2018

esn89 commented Nov 30, 2018 •

edited

Loading

JPinkney commented Nov 30, 2018 •

edited

Loading

esn89 commented Nov 30, 2018

JPinkney commented Nov 30, 2018

JPinkney commented Nov 30, 2018

esn89 commented Nov 30, 2018

JPinkney commented Nov 30, 2018

Doesn't like AWS CloudFormation templates #20

Doesn't like AWS CloudFormation templates #20

Comments

ffxsam commented Nov 20, 2017

JPinkney commented Nov 28, 2017

ffxsam commented Nov 29, 2017

richardmaltais commented Feb 14, 2018

esn89 commented Nov 29, 2018

JPinkney commented Nov 29, 2018

esn89 commented Nov 29, 2018 • edited Loading

esn89 commented Nov 29, 2018

JPinkney commented Nov 29, 2018

esn89 commented Nov 30, 2018

JPinkney commented Nov 30, 2018

esn89 commented Nov 30, 2018

JPinkney commented Nov 30, 2018

esn89 commented Nov 30, 2018

JPinkney commented Nov 30, 2018

esn89 commented Nov 30, 2018

esn89 commented Nov 30, 2018

JPinkney commented Nov 30, 2018

esn89 commented Nov 30, 2018

JPinkney commented Nov 30, 2018

esn89 commented Nov 30, 2018 • edited Loading

JPinkney commented Nov 30, 2018

esn89 commented Nov 30, 2018 • edited Loading

JPinkney commented Nov 30, 2018 • edited Loading

esn89 commented Nov 30, 2018

JPinkney commented Nov 30, 2018

JPinkney commented Nov 30, 2018

esn89 commented Nov 30, 2018

JPinkney commented Nov 30, 2018

esn89 commented Nov 29, 2018 •

edited

Loading

esn89 commented Nov 30, 2018 •

edited

Loading

esn89 commented Nov 30, 2018 •

edited

Loading

JPinkney commented Nov 30, 2018 •

edited

Loading