api

package

v0.2.0-rc11 Latest Latest Go to latest Published: May 15, 2026 License: Apache-2.0 Imports: 4 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/crossplane-contrib/function-hcl

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
func Analyze(files ...File) hcl.Diagnostics
func FormatHCL(code string) string
type FS
type File
type XRD
- func LoadModule(fs FS, dir string, ignoreMetadataErrors bool) (*XRD, []string, error)

Constants ¶

View Source

const ConfigFile = composition.ConfigFile

ConfigFile is the well-named file that contains XRD metadata and library file paths.

Variables ¶

This section is empty.

Functions ¶

func Analyze ¶

func Analyze(files ...File) hcl.Diagnostics

Analyze analyzes the supplied files for correctness.

func FormatHCL ¶

func FormatHCL(code string) string

FormatHCL formats the supplied code.

Types ¶

type FS ¶

type FS = composition.FS

FS is a minimal filesystem implementation that the caller can implement.

type File ¶

type File = evaluator.RawFile

File is a named syntax tree.

type XRD ¶

type XRD = composition.XRD

XRD provides the XRD information if available as metadata.

func LoadModule ¶

func LoadModule(fs FS, dir string, ignoreMetadataErrors bool) (*XRD, []string, error)

LoadModule loads metadata and HCL files from the supplied directory and returns the results. File paths are relative to the directory that was processed.

Source Files ¶

View all Source files

api.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL