rule

type Rule ¶

type Rule struct {

	// Match is a CEL expression to match file paths.
	Match string `json:"match" jsonschema:"title=Match Expression"`
	// Profile is the name of the profile to use when this rule matches.
	Profile string `json:"profile" jsonschema:"title=Profile Name"`
	// contains filtered or unexported fields
}

Rule uses a CEL matcher to determine if its profile should be applied.

CEL expressions have access to variables:

• `files` (list<string>): All file paths in directory
• `dir` (string): The directory path being processed

CEL expressions must return a boolean value:

• files.exists(f, pathExt(f) in [".yaml", ".yml"]) - true if any YAML files exist
• files.exists(f, pathBase(f) in ["Chart.yaml", "values.yaml"]) - true if Chart or values files exist
• files.exists(f, pathBase(f) == "Chart.yaml") - true if Chart.yaml exists
• files.exists(f, !pathBase(f).matches(".*test.*")) - true if non-test files exist
• files.exists(f, pathBase(f) == "Chart.yaml" && yamlPath(f, "$.apiVersion") == "v2") - true if Helm v2 charts exist
• false - rule doesn't match

CEL path functions available:

• pathBase(string): Returns the last element of the path (filename)
• pathDir(string): Returns all but the last element of the path (directory)
• pathExt(string): Returns the file extension including the dot
• yamlPath(file, path): Reads a YAML file and extracts value at path (returns null if not found)

CEL also provides standard functions like `endsWith`, `contains`, `startsWith`, `matches`, along with list functions like `filter`, `exists`, `in`, and logical operators like `&&`, `||`, and `!`.

Use the `in` operator to check membership in lists, e.g.: pathBase(f) in ["Chart.yaml"].

func MustNew(profileName, match string) *Rule

func New(profileName, match string) (*Rule, error)

func (r *Rule) CompileMatch() error

func (r *Rule) MatchFiles(dirPath string, files []string) bool