Add Helm extension #746

cabrinha · 2024-05-17T22:54:20Z

I've got this extension to a point now where all highlights seem to be working properly, but there are still a couple issues I need some help with:

Files aren't automatically detected as "Helm", but instead as "YAML", need to find a way to detect helm if the *.yaml file is located in a directory named templates: templates/*.yaml, is this possible?
Some errors are being displayed as YAML errors, but really its valid Helm syntax

aohoyd · 2024-06-03T12:24:30Z

Files aren't automatically detected as "Helm", but instead as "YAML", need to find a way to detect helm if the .yaml file is located in a directory named templates: templates/.yaml, is this possible?

I don't think templates/*.yaml is enough. Personally I use templates directory for my projects as a base directory for templates not related to helm. Imo it should check for a file Chart.yaml in the parent directory of templates/ and only then recognise templates/**/*.(yaml|yml|tpl) files as go templates. I'm not sure how to do it in Zed, trying to figure out

Some errors are being displayed as YAML errors, but really its valid Helm syntax

These errors come from original YAML language server. You can disable it and errors will be gone.

yodatak · 2024-06-20T13:06:47Z

Any news on this would love to use it ^^ for more kubernetes with rust

cabrinha · 2024-06-21T15:42:45Z

Any news on this would love to use it ^^ for more kubernetes with rust

Need some help on getting this to "work". First up, the CI tests are failing, but this extension mostly works. Second...

@yodatak do you know how to get .yaml files recognized as Helm? Either the existence of a Chart.yaml file or the files exist inside of a templates directory? Maybe the existence of {{ }} in a .yaml is enough to switch the syntax from YAML to Helm?

selfisch · 2024-07-12T20:19:32Z

Any news on this would love to use it ^^ for more kubernetes with rust

Need some help on getting this to "work". First up, the CI tests are failing, but this extension mostly works. Second...

@yodatak do you know how to get .yaml files recognized as Helm? Either the existence of a Chart.yaml file or the files exist inside of a templates directory? Maybe the existence of {{ }} in a .yaml is enough to switch the syntax from YAML to Helm?

Hey there, thanks for working on this, great work so far. Unfortunately I cannot support you.

But just said, {{ }} is not automatically Helm. I am using a tool which has Jinja2 templating, so I can template my kubernetes manifests with it. I have also this issue of bracket space with Zed not only, but also for Helm.

runitmisra · 2024-07-13T12:05:13Z

@cabrinha What I have generally seen from neovim autocmds to load helm-ls as language server automatically, is that it looks for the following:

The yaml or tpl file should be in a templates folder
There should be a Chart.yaml in the project root directory (same level as templates folder)

If both are true, it is pretty safe to assume user is working with Helm. Hope this helps.

cabrinha · 2024-07-14T19:37:22Z

@cabrinha What I have generally seen from neovim autocmds to load helm-ls as language server automatically, is that it looks for the following:

The yaml or tpl file should be in a templates folder

There should be a Chart.yaml in the project root directory (same level as templates folder)

If both are true, it is pretty safe to assume user is working with Helm. Hope this helps.

Thanks for those ideas, but how does that implementation look in Zed?

gnikishin · 2024-07-15T09:54:06Z

a bit of nuance, sometimes Chart.yaml isn't located in project root.
e.g /project_root/dir/.helm/Chart.yaml and /project_root/dir/.helm/templates/

UPD. also there is related issue, which will make working with helm kinda painful
#12122

yodatak · 2024-07-17T18:09:01Z

I know in vscode it use the json shema for help https://json.schemastore.org/kustomization.json
https://marketplace.visualstudio.com/items?itemName=redhat.vscode-yaml

Via the yaml language server

https://github.com/redhat-developer/vscode-yaml

and helm chart is supported by
https://github.com/vscode-kubernetes-tools/vscode-kubernetes-tools

like redhat-developer/vscode-yaml#464

the textmate language of vscode
https://github.com/vscode-kubernetes-tools/vscode-kubernetes-tools/blob/master/syntaxes/helm.tmLanguage.json

and some https://github.com/vscode-kubernetes-tools/vscode-kubernetes-tools/blob/master/docs/extending/README.md

mikeymop · 2024-07-18T23:34:31Z

@yodatak
Have you gotten that to work?
I actually asked for help about that in 14528

I believe this is correct according to both documentations

{
  "lsp": {
    "yaml-language-server": {
      "initialization_options": {
        "yaml.schemas": {
          "http://json.schemastore.org/chart.json": "templates/*.yaml"
        }
      }
    }
  }
}

{
  "lsp": {
    "yaml-language-server": {
      "initialization_options": {
        "yaml": {
          "schemas": {
            "http://json.schemastore.org/chart.json": "templates/*.yaml"
          }
        }
      }
    }
  }
}

However I could only apply a schema with inline comments

# yaml-language-server: $schema=https://json.schemastore.org/chart.json

yodatak · 2024-07-31T09:34:32Z

I think we need to fix zed-industries/zed#7636 before merging ? i would love to have more kubernetes autocompletion with flux2 and so one but

yodatak · 2024-07-31T09:35:33Z

@yodatak Have you gotten that to work? I actually asked for help about that in 14528

I believe this is correct according to both documentations

{
  "lsp": {
    "yaml-language-server": {
      "initialization_options": {
        "yaml.schemas": {
          "http://json.schemastore.org/chart.json": "templates/*.yaml"
        }
      }
    }
  }
}

{
  "lsp": {
    "yaml-language-server": {
      "initialization_options": {
        "yaml": {
          "schemas": {
            "http://json.schemastore.org/chart.json": "templates/*.yaml"
          }
        }
      }
    }
  }
}

However I could only apply a schema with inline comments

# yaml-language-server: $schema=https://json.schemastore.org/chart.json

I don't find any way seem to be a bug from yaml lsp i think

for me for flux2 i need to do

# yaml-language-server: $schema=https://raw.githubusercontent.com/fluxcd-community/flux2-schemas/main/helmrelease-helm-v2.json
---
apiVersion: helm.toolkit.fluxcd.io/v2

or for kustomisation

# yaml-language-server: $schema=https://json.schemastore.org/kustomization.json
apiVersion: kustomize.config.k8s.io/v1beta1

or for namespace

# yaml-language-server: $schema=https://kubernetesjsonschema.dev/v1.14.0/Namespace-v1.json
---
apiVersion: v1
kind: Namespace

aohoyd · 2024-08-06T12:16:43Z

I think that LanguageMatcher should be extended with something like path_globs to match not only file suffixes but also subpaths

notpeter · 2024-08-06T14:37:53Z

I think that LanguageMatcher should be extended with something like path_globs to match not only file suffixes but also subpaths

I think you should be able to use ** which will match 0 or more segments across directories. So maybe something like: templates/**/*.yaml?

cabrinha · 2024-08-09T05:52:57Z

I think that LanguageMatcher should be extended with something like path_globs to match not only file suffixes but also subpaths

I think you should be able to use ** which will match 0 or more segments across directories. So maybe something like: templates/**/*.yaml?

Tried to do this here: cabrinha/helm.zed@6f2ac46 ... Still not working.

nabiltntn · 2024-08-19T16:43:17Z

Files aren't automatically detected as "Helm", but instead as "YAML", need to find a way to detect helm if the .yaml file is located in a directory named templates: templates/.yaml, is this possible?

I don't think templates/*.yaml is enough. Personally I use templates directory for my projects as a base directory for templates not related to helm. Imo it should check for a file Chart.yaml in the parent directory of templates/ and only then recognise templates/**/*.(yaml|yml|tpl) files as go templates. I'm not sure how to do it in Zed, trying to figure out

Some errors are being displayed as YAML errors, but really its valid Helm syntax

These errors come from original YAML language server. You can disable it and errors will be gone.

I think also that some charts also create sub-charts under the charts folder, so I think this should also be include in the pattern

cabrinha · 2024-08-22T01:23:43Z

I think also that some charts also create sub-charts under the charts folder, so I think this should also be include in the pattern

Those charts are tar'd up, so they don't really need to be opened and rendered.

selfisch · 2024-08-22T05:19:17Z

Hey,
discussing what files need to be edited and which not is not purposeful in this case.

Like mentioned many posts above, this is no explicit helm issue, but more like a templating include issue in the yaml lsp.
I am using jinja2 templating in yaml files and have almost the same issue, no matter which ide using.
There needs to be a way to include templating definitions like go/sprig for helm, but also jinja2 for example, into the yaml lsp definition. And that makes the whole topic more komplicated in general :-/

gnikishin · 2024-08-22T07:15:37Z

Those charts are tar'd up, so they don't really need to be opened and rendered.

not always, it can be custom sub chart which written in plain yaml files.

This directory "multipurpose", subcharts can be in form of tar.gz, and in form of directory

cabrinha · 2024-08-22T17:08:16Z

Those charts are tar'd up, so they don't really need to be opened and rendered.

not always, it can be custom sub chart which written in plain yaml files.

This directory "multipurpose", subcharts can be in form of tar.gz, and in form of directory

This is all valid, but how do we get closer to getting Zed to support helm syntax?

mikeymop · 2024-08-22T17:28:55Z

Those charts are tar'd up, so they don't really need to be opened and rendered.

not always, it can be custom sub chart which written in plain yaml files.

This directory "multipurpose", subcharts can be in form of tar.gz, and in form of directory

This is all valid, but how do we get closer to getting Zed to support helm syntax?

I would argue that properly supporting jsonschema overrides in yaml-language-server is the best place to divert focus towards.

It is working with an inline comment today, if it can be made to work in settings.json, and with glob patterns, it would be comparable what VsCode offers.

cabrinha · 2024-08-23T15:28:50Z

Those charts are tar'd up, so they don't really need to be opened and rendered.

not always, it can be custom sub chart which written in plain yaml files.
This directory "multipurpose", subcharts can be in form of tar.gz, and in form of directory

This is all valid, but how do we get closer to getting Zed to support helm syntax?

I would argue that properly supporting jsonschema overrides in yaml-language-server is the best place to divert focus towards.

It is working with an inline comment today, if it can be made to work in settings.json, and with glob patterns, it would be comparable what VsCode offers.

Not sure I have much to offer there... Should we close this PR?

aohoyd · 2024-09-17T12:22:25Z

It is working with an inline comment today, if it can be made to work in settings.json, and with glob patterns, it would be comparable what VsCode offers.

@mikeymop I didn't get what did you mean on what VsCode offers. VsCode offers separated extension which supports Helm syntax and it's features. The same is proposed here.

Moreover jsonschema provided above by @yodatak is a schema of Chart.yaml file, it doesn't automagically adds support of gotemplates syntax used by helm.

@cabrinha Here is what we need to do to get Helm support in Zed (from my point of view). We need some option, that would tell Zed to use Helm language for files stored in templates/** directories. I've seen this PR, but it doesn't support file path, so it should be somehow extended to also support full paths. I'll try to take a look there

aohoyd · 2024-10-08T19:24:39Z

@cabrinha I figured it out. By some reason path_suffixes option in config.toml doesn't accept globs. You can specify

  "file_types": {
    "Helm": [
      "**/templates/**/*.tpl",
      "**/templates/**/*.yaml",
      "**/templates/**/*.yml"
    ]
  }

in your local .zed/settings.json config and get Helm language auto detected in projects. It works perfectly for me now, thank you!

cabrinha · 2024-10-09T00:49:03Z

@cabrinha I figured it out. By some reason path_suffixes option in config.toml doesn't accept globs. You can specify
  "file_types": {
    "Helm": [
      "**/templates/**/*.tpl",
      "**/templates/**/*.yaml",
      "**/templates/**/*.yml"
    ]
  }
in your local .zed/settings.json config and get Helm language auto detected in projects. It works perfectly for me now, thank you!

@aohoyd nice find, but why is the CI still failing?

What needs to happen in this PR to get this extension merged in and natively supported in Zed?

notpeter · 2024-10-09T15:09:23Z

@cabrinha I figured it out. By some reason path_suffixes option in config.toml doesn't accept globs.
What needs to happen in this PR to get this extension merged in and natively supported in Zed?

Since those globs are not supported can you remove them from here:
languages/helm/config.toml and update the submodule commit?

We should also add a helm to the official languages docs including the suggested file_types configuration for Helm.

I fixed the sort order so tests should pass now.

hedgieinsocks · 2024-10-10T07:28:59Z

Thank you, it does work! But I encourage everyone who's waiting for this to be merged, in the meantime, to also visit the upstream issue ngalaiko/tree-sitter-go-template#23 and motivate the dev to review and fix it. Since it's likely that your helm charts use dash (-) to combine 2 templates into a single value.

hedgieinsocks · 2024-10-10T07:48:27Z

@cabrinha you might want to add "**/helmfile.d/**/*.yaml" to the common patterns when adding commit to the docs as suggested above

cabrinha · 2024-10-11T20:02:28Z

@cabrinha I figured it out. By some reason path_suffixes option in config.toml doesn't accept globs.
What needs to happen in this PR to get this extension merged in and natively supported in Zed?

Since those globs are not supported can you remove them from here: languages/helm/config.toml and update the submodule commit?

We should also add a helm to the official languages docs including the suggested file_types configuration for Helm.

I fixed the sort order so tests should pass now.

I'm sure I will be flamed for "doing it wrong" but, here you go: zed-industries/zed#19095

qvalentin · 2024-10-12T15:18:29Z

@cabrinha nice work :D.
I'm the current maintainer of helm-ls and also contributor to tree-sitter-go-template and would love to see them being used in zed.

Here are some of my viewpoints for the discussed topics:

Like mentioned many posts above, this is no explicit helm issue, but more like a templating include issue in the yaml lsp.

@selfisch yaml-language-server will probably never implement support for templating languages, it would be better to use a specific lsp for the template language like helm-ls.

I would argue that properly supporting jsonschema overrides in yaml-language-server is the best place to divert focus towards.

@mikeymop this PR may be interesting for you: redhat-developer/yaml-language-server#962

Thank you, it does work! But I encourage everyone who's waiting for this to be merged, in the meantime, to also visit the upstream issue ngalaiko/tree-sitter-go-template#23 and motivate the dev to review and fix it. Since it's likely that your helm charts use dash (-) to combine 2 templates into a single value.

@hedgieinsocks I just opened tree-sitter-grammars/tree-sitter-yaml#12 for this, as its a problem with the yaml tree-sitter grammar. If anyone has some tree-sitter and/or C knowledge you could help there.

maxdeviant

Thank you for your work on this! Glad to see it finally land 😄

Merge after this: - zed-industries/extensions#746 Release Notes: - N/A --------- Co-authored-by: Peter Tripp <[email protected]> Co-authored-by: Marshall Bowers <[email protected]>

Helm: use dialect

19af38b

cla-bot bot added the cla-signed label May 17, 2024

cabrinha changed the title ~~Helm: use tree-sitter-go-template dialect~~ Adding Helm: use tree-sitter-go-template "helm" dialect May 17, 2024

cabrinha mentioned this pull request May 17, 2024

Helm #186

Open

1 task

maxdeviant changed the title ~~Adding Helm: use tree-sitter-go-template "helm" dialect~~ Add Helm extension May 23, 2024

malikbenkirane mentioned this pull request Jun 24, 2024

Yaml Syntax Highlighting not working for Helm templates zed-industries/zed#8487

Open

1 task

aohoyd mentioned this pull request Aug 6, 2024

Add path globs to LanguageMatcher zed-industries/zed#15847

Closed

1 task

cabrinha force-pushed the helm-ext branch 2 times, most recently from 5e2e32f to b685047 Compare August 9, 2024 05:44

update globs/grammar

d356288

cabrinha force-pushed the helm-ext branch from b685047 to d356288 Compare August 9, 2024 05:46

ordering

00adb59

new commits to helm submodule

d1ee70f

cabrinha force-pushed the helm-ext branch from b4c9940 to d1ee70f Compare October 10, 2024 19:27

Merge branch 'main' into helm-ext

44620df

cabrinha mentioned this pull request Oct 11, 2024

docs: Add Helm extension docs zed-industries/zed#19095

Merged

Merge branch 'main' into helm-ext

351c79d

notpeter self-assigned this Oct 11, 2024

Sort .gitmodules

925c655

maxdeviant added 3 commits October 15, 2024 10:20

Merge branch 'main' into pr/746

5695fe7

Remove old submodule

cb7ea7c

Re-add submodule

49d0bdc

maxdeviant approved these changes Oct 15, 2024

View reviewed changes

maxdeviant merged commit 4ebc242 into zed-industries:main Oct 15, 2024
2 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add Helm extension #746

Add Helm extension #746

cabrinha commented May 17, 2024 •

edited

Loading

aohoyd commented Jun 3, 2024

yodatak commented Jun 20, 2024

cabrinha commented Jun 21, 2024

selfisch commented Jul 12, 2024

runitmisra commented Jul 13, 2024

cabrinha commented Jul 14, 2024

gnikishin commented Jul 15, 2024 •

edited

Loading

yodatak commented Jul 17, 2024

mikeymop commented Jul 18, 2024 •

edited

Loading

yodatak commented Jul 31, 2024

yodatak commented Jul 31, 2024 •

edited

Loading

aohoyd commented Aug 6, 2024

notpeter commented Aug 6, 2024

cabrinha commented Aug 9, 2024 •

edited

Loading

nabiltntn commented Aug 19, 2024

cabrinha commented Aug 22, 2024

selfisch commented Aug 22, 2024

gnikishin commented Aug 22, 2024

cabrinha commented Aug 22, 2024

mikeymop commented Aug 22, 2024 •

edited

Loading

cabrinha commented Aug 23, 2024

aohoyd commented Sep 17, 2024

aohoyd commented Oct 8, 2024 •

edited

Loading

cabrinha commented Oct 9, 2024 •

edited

Loading

notpeter commented Oct 9, 2024 •

edited

Loading

hedgieinsocks commented Oct 10, 2024

hedgieinsocks commented Oct 10, 2024

cabrinha commented Oct 11, 2024

qvalentin commented Oct 12, 2024

maxdeviant left a comment

Add Helm extension #746

Add Helm extension #746

Conversation

cabrinha commented May 17, 2024 • edited Loading

aohoyd commented Jun 3, 2024

yodatak commented Jun 20, 2024

cabrinha commented Jun 21, 2024

selfisch commented Jul 12, 2024

runitmisra commented Jul 13, 2024

cabrinha commented Jul 14, 2024

gnikishin commented Jul 15, 2024 • edited Loading

yodatak commented Jul 17, 2024

mikeymop commented Jul 18, 2024 • edited Loading

yodatak commented Jul 31, 2024

yodatak commented Jul 31, 2024 • edited Loading

aohoyd commented Aug 6, 2024

notpeter commented Aug 6, 2024

cabrinha commented Aug 9, 2024 • edited Loading

nabiltntn commented Aug 19, 2024

cabrinha commented Aug 22, 2024

selfisch commented Aug 22, 2024

gnikishin commented Aug 22, 2024

cabrinha commented Aug 22, 2024

mikeymop commented Aug 22, 2024 • edited Loading

cabrinha commented Aug 23, 2024

aohoyd commented Sep 17, 2024

aohoyd commented Oct 8, 2024 • edited Loading

cabrinha commented Oct 9, 2024 • edited Loading

notpeter commented Oct 9, 2024 • edited Loading

hedgieinsocks commented Oct 10, 2024

hedgieinsocks commented Oct 10, 2024

cabrinha commented Oct 11, 2024

qvalentin commented Oct 12, 2024

maxdeviant left a comment

Choose a reason for hiding this comment

cabrinha commented May 17, 2024 •

edited

Loading

gnikishin commented Jul 15, 2024 •

edited

Loading

mikeymop commented Jul 18, 2024 •

edited

Loading

yodatak commented Jul 31, 2024 •

edited

Loading

cabrinha commented Aug 9, 2024 •

edited

Loading

mikeymop commented Aug 22, 2024 •

edited

Loading

aohoyd commented Oct 8, 2024 •

edited

Loading

cabrinha commented Oct 9, 2024 •

edited

Loading

notpeter commented Oct 9, 2024 •

edited

Loading