schema

package

v0.385.0 Latest Latest Go to latest Published: Apr 24, 2024 License: AGPL-3.0 Imports: 16 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.

View Source

var ErrNoSchemaFiles = errors.New("no schema files found")

This section is empty.

type Builder struct {
	Config *config.ProjectConfig
	// contains filtered or unexported fields
}

A Builder knows how to produce a (validated) proto.Schema, from a given Keel Builder. Construct one, then call the Make method.

func (scm *Builder) ASTs() []*parser.AST

func (scm *Builder) MakeFromDirectory(directory string) (*proto.Schema, error)

MakeFromDirectory constructs a proto.Schema from the .keel files present in the given directory.

func (scm *Builder) MakeFromInputs(inputs *reader.Inputs) (*proto.Schema, error)

MakeFromFile constructs a proto.Schema from the given inputs

func (scm *Builder) MakeFromString(schemaString string, configString string) (*proto.Schema, error)

func (scm *Builder) PrepareAst(allInputFiles *reader.Inputs) ([]*parser.AST, errorhandling.ValidationErrors, error)

PrepareAst will parse the ASTs and will add built-in models, fields, and other bits.

func (scm *Builder) SchemaFiles() []*reader.SchemaFile