Skip to content

docs: add installation and configuration instructions #24

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
tzabbi wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: add installation and configuration instructions #24

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 30 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,18 @@ Syntax highlighting for Helm templates using tree-sitter and integration of [hel

## Installation

The extension relies on the PATH environment variable and first looks for 'helm_ls', then 'helm-ls'. If neither is available, an error is shown.
Before the extension is working properly, you have to install the [helm-ls](https://github.com/mrjosh/helm-ls#installation-with-a-package-manager)
and [yaml-languages-server](https://github.com/redhat-developer/yaml-language-server) with your preferred package manager.

Install this extension via the [Zed extension store](https://zed.dev/extensions/helm).

The extension relies on the PATH environment variable and first looks for 'helm_ls', then 'helm-ls'.
If neither is available, an error is shown.

## Configuration

This is an example of providing configuration for the language server via Zed's `settings.json`. For full reference of possible values, refer to [helm-ls configuration section](https://github.com/mrjosh/helm-ls/?tab=readme-ov-file#configuration-options).
This is an example of providing configuration for the language server via Zed's `settings.json`.
For full reference of possible values, refer to [helm-ls configuration section](https://github.com/mrjosh/helm-ls/?tab=readme-ov-file#configuration-options).

```json
{
Expand All @@ -24,22 +31,38 @@ This is an example of providing configuration for the language server via Zed's
}
}
}
}
},
"file_types": {
"Helm": [
"helmfile.yaml",
"helmfile.yml",
"Chart.yaml",
"Chart.yml",
"Chart.lock",
"requirements.yaml",
"requirements.yml",
"**/templates/**/*.tpl",
"**/templates/**/*.yaml",
"**/templates/**/*.yml",
"**/helmfile.d/**/*.yaml",
"**/helmfile.d/**/*.yml",
],
},
}
```

## Credits

https://github.com/ngalaiko/tree-sitter-go-template
[https://github.com/ngalaiko/tree-sitter-go-template]

## Release Process

Every time the extension is released:

1. **Bump the Version:**
1. **Bump the Version:**
Update the version number in Cargo.toml and extension.toml.

2. **Update Extension Index:**
2. **Update Extension Index:**
After releasing, update the extension entry in [zed-industries/extensions](http://github.com/zed-industries/extensions/) to reflect the new version.

This ensures users always have access to the latest
This ensures users always have access to the newest version.