Prometheus Rules File Match Rules Too Broad - Conflicting With Other Tools

[ekkohdev]

Area with issue?

JSON Schema

✔️ Expected Behavior

I created a new stack called test in my Pulumi project, which results in a Pulumi.test.yaml stack config file. I am using VS Code with the RedHat YAML extension. Normally, no JSON Schema is automatically used for stack config files.

This is expected and allows authoring of the stack config as needed.

❌ Actual Behavior

The JSON Schema for prometheus.rules.test.json is being automatically used for my Pulumi.test.yaml file which results in validation errors and an interrupted editor experience. It appears, having any JSON/YAML file in a project with a name ending in .test.json or .test.yaml automatically uses the prometheus.rules.test.json schema.

This is too broad of a file match pattern, as it is very common to have this suffix in other tools. The issue with Pulumi I described above bought this to my attention but the same has been reported in other tools, such as Docker...

• Renamed docker-compose YAML files use incorrect schema despite file association redhat-developer/vscode-yaml#947
• docker-compose.test.yaml file is using prometheus.rules.test.json first redhat-developer/vscode-yaml#949

I'm not that familiar with prometheus rules to comment on how to make the pattern(s) more selective but the current patterns conflict with multiple other uses of .test.json/yaml.

The use of the schema store could be disabled entirely in the VS Code YAML extension but this is very inconvenient and a significant loss of functionality.

YAML or JSON file that does not work.

It looks like the issue was introduced in this PR: #3003

IDE or code editor.

Visual Studio Code

Are you making a PR for this?

No, someone else must create the PR.

[aureq]

@MichaelSnowden and @madskristensen I'd like to point out that changes in #3006 (which tries to address #3003) is still too broad. At Pulumi we have Pulumi.<somename>.yaml which gets caught by *.tests.yaml file match rule quite often for our users.

[madskristensen]

@aureq @MichaelSnowden @hyperupcall I agree. This should be fixed such that the prometheus file match is less generic.