https://github.com/tim-koehler/Helm-Intellisense

Extension for Visual Studio Code - Intellisense in helm-templates from the values.yaml
https://github.com/tim-koehler/Helm-Intellisense

autocomplete helm helm-intellisense helm-templates intellisense kubernetes vscode vscode-extension

Last synced: 3 months ago
JSON representation

Extension for Visual Studio Code - Intellisense in helm-templates from the values.yaml

• Host: GitHub
• URL: https://github.com/tim-koehler/Helm-Intellisense
• Owner: tim-koehler
• License: mit
• Created: 2020-05-30T21:31:32.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2024-05-27T15:27:07.000Z (6 months ago)
• Last Synced: 2024-06-12T07:18:45.415Z (5 months ago)
• Topics: autocomplete, helm, helm-intellisense, helm-templates, intellisense, kubernetes, vscode, vscode-extension
• Language: TypeScript
• Homepage: https://marketplace.visualstudio.com/items?itemName=Tim-Koehler.helm-intellisense&ssr=false#overview
• Size: 2.76 MB
• Stars: 1,487
• Watchers: 3
• Forks: 23
• Open Issues: 11
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
Helm-Intellisense



![Visual Studio Marketplace Installs](https://img.shields.io/visual-studio-marketplace/i/Tim-Koehler.helm-intellisense?style=flat-square)

![Visual Studio Marketplace Rating (Stars)](https://img.shields.io/visual-studio-marketplace/stars/Tim-Koehler.helm-intellisense?style=flat-square)

![GitHub Repo stars](https://img.shields.io/github/stars/tim-koehler/Helm-Intellisense?label=GitHub%20Stars&style=flat-square)

![GitHub issues](https://img.shields.io/github/issues-raw/tim-koehler/Helm-Intellisense?style=flat-square)

### Extension to help writing Helm-Templates by providing intellisense

![Demo Gif](https://imgur.com/pC2vuoN.gif) 



## Features

- The `values.yaml` file of the chart will be read and evaluated automatically to provide intellisense.

- Autocomplete will also work for all `Named Templates` defined in the any `.tpl` file.

- Autocomplete for defined helm variables.

- Compatible with Windows and Linux/Unix.

- Support for custom named value files is provided (see settings section below).

- Lint command to validate correct values templating and usage of NamedTemplates.

- Support and autocomplete for `yaml` anchors and labels

- The extension is compatible with the `Kubernetes` extension.

- Working with language type `yaml` and `helm-template`.

## Commands

* `Helm-Intellisense: Lint` :       This command parses the currently active document and validates that all paths(like `.Values.foo.bar`) point to valid values.

* `Helm-Intellisense: Lint Chart` : Equivalent to `Lint` command but for all files in the chart of the file that is currently active.

## Settings

| Setting                                   | Description

|:------------------------------------------|:----------------------------------------------------------------------------------------

| `helm-intellisense.customValueFileNames`  | Defines list of possible files containing values
(default: `values.yaml`)

| `helm-intellisense.lintFileOnSave`        | If set to `true` the `Helm-Intellisense: Lint` command will be executed on save (default: `true`)

| `helm-intellisense.excludeFromLinting`    | Define a list of filenames which should be excluded from linting.
 Wildcards are also possible (Example: `*.gotmpl`)

## Multiple value files (overriding)

When mulitple value files are defined they are parsed from the bottom up:

```json

"helm-intellisense.customValueFileNames": [

    "prod-values.yaml",

    "dev-values.yaml",

    "values.yaml"

]

```

In this case values will be overwritten/merged by dev and dev by prod. This also means that the linter will only throw an error if a certain key is not found in any of the specified files.