Helm file-types conflict with Gitlab CI component YAML

[nikaro]

Summary

[[language]]
...
file-types = [ { glob = "templates/*.yaml" }, { glob = "templates/*.yml" }, { glob = "templates/_*.tpl"}, { glob = "templates/NOTES.txt" } ]

cf. https://github.com/helix-editor/helix/blob/master/languages.toml#L4045

A GitLab component directory is structured like this:

├── templates/
│   ├── my-component.yml
│   └── my-other-component/
│       ├── template.yml
│       ├── Dockerfile
│       └── test.sh
├── LICENSE.md
├── README.md
└── .gitlab-ci.yml

cf. https://docs.gitlab.com/ci/components/#directory-structure

So Gitlab CI components YAML files are detected as Helm files, thus not highlighted/linted/etc. properly.

Reproduction Steps

I tried this:

1. hx

I expected this to happen:

Instead, this happened:

Helix log

~/.cache/helix/helix.log

please provide a copy of `~/.cache/helix/helix.log` here if possible, you may need to redact some of the lines

Platform

macOS

Terminal Emulator

ghostty

Installation Method

brew

Helix Version

helix 25.07.1 (a05c151)

[kpbaks]

We can solve the problem partly by extending the file-types array with {glob = "templates/*/template.yml"}.

This is the current gitlab-ci language config.

helix/languages.toml

Lines 4812 to 4820 in 109c812

	[[language]]
	name = "gitlab-ci"
	scope = "source.gitlab-ci"
	injection-regex = "^gitlab-ci$"
	file-types = [{ glob = ".gitlab-ci.yml" }]
	grammar = "yaml"
	indent = { tab-width = 2, unit = " " }
	language-servers = ["yaml-language-server", "gitlab-ci-ls"]
	comment-token = "#"

AFAIK we do not have any other mechanism that could be used to resolve this ambiguity. In your case you could create a local .helix/languages.toml with:

[[language]]
name = "gitlab-ci"
file-types = [{ glob = ".gitlab-ci.yml" }, {glob = "templates/*.yml"}, {glob = "templates/*/template.yml"}]

[[language]]
name = "helm"
file-types = [ { glob = "templates/NOTES.txt" } ] # The array need to have at least on element so we keep this one.

We have a roots property, but I am not sure if it affects file-type detection. You could try.

[[language]]
name = "gitlab-ci"
roots = [".gitlab-ci.yml"]
# ...

And see if changes the outcome

[nikaro]

Yeah, I’ve gone with the local config, and it serves me well, but I was wondering if Helix could do something better in this area. But I don't know myself how it could be improved. Probably modelines parsing would help, but I guess in the meantime, the local config is fine.

Thanks.