util

Documentation

Index

• Variables
• func AfterStrings(value string, a string) string
• func BetweenStrings(value string, a string, b string) string
• func FormatToYAML(field reflect.Value, fieldName string) string
• func GetBoolType(value interface{}) string
• func GetNodeForPosition(node *yamlv3.Node, position lsp.Position) *yamlv3.Node
• func GetPositionOfNode(node *yamlv3.Node, query []string) (lsp.Position, error)
• func GetSubValuesForSelector(values chartutil.Values, selector []string) (map[string]any, error)
• func GetTableOrValueForSelector(values chartutil.Values, selector []string) (string, error)
• func GetValueCompletion(values chartutil.Values, splittedVar []string) []lsp.CompletionItem
• func IndexToPosition(index int, content []byte) protocol.Position
• func PointToPosition(point sitter.Point) lsp.Position
• func PositionToIndex(pos protocol.Position, content []byte) int
• func PositionToPoint(position lsp.Position) sitter.Point
• func RangeContainsRange(surrounding, including sitter.Range) bool
• func RangeToLocation(URI uri.URI, range_ sitter.Range) lsp.Location
• func RangesToLocations(URI uri.URI, ranges []sitter.Range) (locations []lsp.Location)
• func ReadYamlToNode(data []byte) (node yamlv3.Node, err error)
• func RemoveQuotes(s string) string
• func WordAt(str string, index int) string
• type ErrEmpytArray
  • func (e ErrEmpytArray) Error() string
• type ErrEmpytMapping
  • func (e ErrEmpytMapping) Error() string
• type HelmLintConfig
• type HelmlsConfiguration
• type ValuesFilesConfig
• type YamllsConfiguration
  • func (y *YamllsConfiguration) CompileEnabledForFilesGlobObject()
• type YamllsSchemaStoreSettings
• type YamllsSettings

Variables

var DefaultConfig = HelmlsConfiguration{
	LogLevel: "info",
	ValuesFilesConfig: ValuesFilesConfig{
		MainValuesFileName:               "values.yaml",
		LintOverlayValuesFileName:        "values.lint.yaml",
		AdditionalValuesFilesGlobPattern: "values*.yaml",
	},
	HelmLintConfig: HelmLintConfig{
		Enabled:         true,
		IgnoredMessages: []string{},
	},
	YamllsConfiguration: YamllsConfiguration{
		Enabled:                   true,
		EnabledForFilesGlob:       "*.{yaml,yml}",
		EnabledForFilesGlobObject: glob.MustCompile("*.{yaml,yml}"),
		Path:                      "yaml-language-server",
		InitTimeoutSeconds:        3,
		DiagnosticsEnabled:        true,
		DiagnosticsLimit:          50,
		ShowDiagnosticsDirectly:   false,
		YamllsSettings:            DefaultYamllsSettings,
	},
}

var DefaultYamllsSettings = YamllsSettings{
	Schemas:    map[string]string{"kubernetes": "templates/**"},
	Completion: true,
	Hover:      true,
	YamllsSchemaStoreSettings: YamllsSchemaStoreSettings{
		Enable: true,
		URL:    "https://www.schemastore.org/api/json/catalog.json",
	},
}

Functions

func AfterStrings

func AfterStrings(value string, a string) string

AfterStrings gets the substring after a string.

func BetweenStrings

func BetweenStrings(value string, a string, b string) string

BetweenStrings gets the substring between two strings.

func FormatToYAML

func FormatToYAML(field reflect.Value, fieldName string) string

func GetBoolType

func GetBoolType(value interface{}) string

func GetNodeForPosition

func GetNodeForPosition(node *yamlv3.Node, position lsp.Position) *yamlv3.Node

func GetPositionOfNode

func GetPositionOfNode(node *yamlv3.Node, query []string) (lsp.Position, error)

func GetSubValuesForSelector

func GetSubValuesForSelector(values chartutil.Values, selector []string) (map[string]any, error)

func GetTableOrValueForSelector

func GetTableOrValueForSelector(values chartutil.Values, selector []string) (string, error)

func GetValueCompletion

func GetValueCompletion(values chartutil.Values, splittedVar []string) []lsp.CompletionItem

func IndexToPosition

func IndexToPosition(index int, content []byte) protocol.Position

func PointToPosition

func PointToPosition(point sitter.Point) lsp.Position

func PositionToIndex

func PositionToIndex(pos protocol.Position, content []byte) int

func PositionToPoint

func PositionToPoint(position lsp.Position) sitter.Point

func RangeContainsRange

func RangeContainsRange(surrounding, including sitter.Range) bool

func RangeToLocation

func RangeToLocation(URI uri.URI, range_ sitter.Range) lsp.Location

func RangesToLocations

func RangesToLocations(URI uri.URI, ranges []sitter.Range) (locations []lsp.Location)

func ReadYamlToNode

func ReadYamlToNode(data []byte) (node yamlv3.Node, err error)

ReadYamlToNode will parse a YAML file into a yaml Node.

func RemoveQuotes

func RemoveQuotes(s string) string

func WordAt

func WordAt(str string, index int) string

WordAt returns the word found at the given character position. Credit https://github.com/aca/neuron-language-server/blob/450a7cff71c14e291ee85ff8a0614fa9d4dd5145/utils.go#L13

Types

type ErrEmpytArray

type ErrEmpytArray struct {
	Key string
}

func (ErrEmpytArray) Error

func (e ErrEmpytArray) Error() string

type ErrEmpytMapping

type ErrEmpytMapping struct {
	Key string
}

func (ErrEmpytMapping) Error

func (e ErrEmpytMapping) Error() string

type HelmLintConfig

type HelmLintConfig struct {
	Enabled         bool     `json:"enabled,omitempty"`
	IgnoredMessages []string `json:"ignoredMessages,omitempty"`
}

type HelmlsConfiguration

type HelmlsConfiguration struct {
	YamllsConfiguration YamllsConfiguration `json:"yamlls,omitempty"`
	ValuesFilesConfig   ValuesFilesConfig   `json:"valuesFiles,omitempty"`
	HelmLintConfig      HelmLintConfig      `json:"helmLint,omitempty"`
	LogLevel            string              `json:"logLevel,omitempty"`
}

type ValuesFilesConfig

type ValuesFilesConfig struct {
	MainValuesFileName               string `json:"mainValuesFile,omitempty"`
	LintOverlayValuesFileName        string `json:"lintOverlayValuesFile,omitempty"`
	AdditionalValuesFilesGlobPattern string `json:"additionalValuesFilesGlobPattern,omitempty"`
}

type YamllsConfiguration

type YamllsConfiguration struct {
	Enabled                   bool   `json:"enabled,omitempty"`
	EnabledForFilesGlob       string `json:"enabledForFilesGlob,omitempty"`
	EnabledForFilesGlobObject glob.Glob
	Path                      string `json:"path,omitempty"`
	InitTimeoutSeconds        int    `json:"initTimeoutSeconds,omitempty"`
	DiagnosticsEnabled        bool   `json:"diagnosticsEnabled,omitempty"`
	// max diagnostics from yamlls that are shown for a single file
	DiagnosticsLimit int `json:"diagnosticsLimit,omitempty"`
	// if set to false diagnostics will only be shown after saving the file
	// otherwise writing a template will cause a lot of diagnostics to be shown because
	// the structure of the document is broken during typing
	ShowDiagnosticsDirectly bool `json:"showDiagnosticsDirectly,omitempty"`
	YamllsSettings          any  `json:"config,omitempty"`
}

func (*YamllsConfiguration) CompileEnabledForFilesGlobObject

func (y *YamllsConfiguration) CompileEnabledForFilesGlobObject()

type YamllsSchemaStoreSettings

type YamllsSchemaStoreSettings struct {
	Enable bool   `json:"enable"`
	URL    string `json:"url"`
}

type YamllsSettings

type YamllsSettings struct {
	Schemas                   map[string]string         `json:"schemas"`
	Completion                bool                      `json:"completion"`
	Hover                     bool                      `json:"hover"`
	YamllsSchemaStoreSettings YamllsSchemaStoreSettings `json:"schemaStore"`
}