The highest tagged major version is v6.

compiler

package

v5.11.0 Latest Latest Go to latest Published: Jan 23, 2024 License: Apache-2.0 Imports: 17 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

This section is empty.

func ResourceSpecFiles(rcConfig *config.ResourceSet) ([]string, error)

ResourceSpecFiles returns all matching spec files for a config.Resource.

type Compiler struct {
	// contains filtered or unexported fields
}

A Compiler checks and builds versioned API resource inputs into aggregated OpenAPI versioned outputs, as determined by an API project configuration.

func New(ctx context.Context, proj *config.Project, lint bool, options ...CompilerOption) (*Compiler, error)

New returns a new Compiler for a given project configuration.

func (c *Compiler) Build(ctx context.Context, apiName string) error

Build builds an aggregate versioned OpenAPI spec for a specific API by name in the project.

func (c *Compiler) BuildAll(ctx context.Context) error

BuildAll builds all APIs in the project.

func (c *Compiler) LintOutput(ctx context.Context, apiName string) error

LintOutput applies configured linting rules to the build output.

func (c *Compiler) LintResources(ctx context.Context, apiName string) error

LintResources checks the inputs of an API's resources with the configured linter.

type CompilerOption func(*Compiler) error

CompilerOption applies a configuration option to a Compiler.

func LinterFactory(f func(ctx context.Context, lc *config.Linter) (linter.Linter, error)) CompilerOption

LinterFactory configures a Compiler to use a custom factory function for instantiating Linters.