null-ls believes my .gitlab-ci.yml file is a CloudFormation Template

[jorge-ramirezs]

Hello,

First of all I want to say that I'm loving this plugin, thank you!

When I open my .gitlab-ci.yml file the plugin gives me errors and warnings because it "thinks" the file is a CloudFormation Template.

I'd love to have the gitlab-ci file evaluated as a YAML file only not as CFN.

I'm using cfn-lint, NeoVim 0.7

Thanks,
Jorge.

[fitrh]

Did your yaml file contains "Resources" or "AWSTemplateFormatVersion" ?

[jose-elias-alvarez]

@DeanGaffney What do you think of this? Is there any way we can narrow the pattern to avoid false positives?

[DeanGaffney]

@jose-elias-alvarez yes we should definitely narrow the pattern to avoid these kinds of false positives.

If you want to leave this with me I can work on improving the pattern and open a PR. It might be a couple of days before I get time to work on it, but I have no issues working on it.

[jorge-ramirezs]

If it's just matter of adding the colon in the condition, do you think this is something I can fix?
I'd love to learn how to do PRs and of course to contribute to the project.

[jose-elias-alvarez]

The suggested solution makes sense for this case, but we'll still run into the issue in any JSON or YAML file that contains the word Resources. I think the most robust solution will be to update the pattern so that it's (ideally) unique to CloudFormation templates, since maintaining a blacklist will be cumbersome. Happy to review a PR either way.

[DeanGaffney]

From looking at the cfn-lint repository there is a list of editors, extensions, etc, that support cfn-lint. Some of the implementations require both "Resources" and "AWSTemplateFormatVersion" to be present for the file to be considered a cloudformation template.

I don't suggest we go the route of requiring both attributes as the only key that is actually required is "Resources". If we require both we may cause issues to be opened by users who do not use the "AWSTemplateFormatVersion" key claiming the diagnostics aren't working.

The approach I suggest we take is something like this https://github.com/awslabs/aws-cfn-lint-visual-studio-code/blob/master/server/src/server.ts#L144

It has stricter pattern matching and also looks for "Type" alongside the "Resources" key. This should reduce the number of false positives.