cuegen

package
v4.4.4 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 19, 2022 License: MIT Imports: 6 Imported by: 0

README

CUE AST tips

Adding optional fields to structs

Code:

requiredField := &ast.Field {
  Label: ast.NewIdent("username"),
  Value: ast.NewIdent("string"),
}
optionalField := &ast.Field {
  Label: ast.NewIdent("age"),
  Value: ast.NewIdent("uint"),
}

ast.NewStruct(
  requiredField,

  optionalField.Label,
  token.OPTION,
  optionalField.Value,
)

Given a struct, create a disjunction

In other words, given:

#AllInputs: {
  http_client: {url: string}
  generate: {mapping: string}
  file: {paths: [...string]}
}

Generate a type #Input that conforms to:

#Input: {http_client: {url: string}} | {generate: {mapping: string}} | {file: {paths: [...string]}}

This can be done using the or built-in function in Cue and field comprehension:

#Input: or([for name, config in #AllInputs {(name): config}])

Expressing that using the ast package looks like this:

Code:

collectionIdent := ast.NewIdent("#AllInputs")
disjunctionIdent := ast.NewIdent("#Input")

&ast.Field{
  Label: disjunctionIdent,
  Value: ast.NewCall(ast.NewIdent("or"), ast.NewList(&ast.Comprehension{
    Clauses: []ast.Clause{
      &ast.ForClause{
        Key:    ast.NewIdent("name"),
        Value:  ast.NewIdent("config"),
        Source: collectionIdent,
      },
    },
    Value: ast.NewStruct(&ast.Field{
      Label: interpolateIdent(ast.NewIdent("name")),
      Value: ast.NewIdent("config"),
    }),
  })),
},

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func GenerateSchema

func GenerateSchema(sch schema.Full) ([]byte, error)

GenerateSchema generates a Cue schema which includes definitions for the configuration file structure and component configs.

Types

This section is empty.

Jump to

Keyboard shortcuts

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