generate

Documentation

Index

• Variables
• func FmtFieldName(s string) string
• func Generate(oscalSchema []byte, pkgName string, tags []string) (typeBytes []byte, err error)
• type BaseFlags
• type GeneratorConfig
  • func NewGeneratorConfig(tags []string, pkgName string) GeneratorConfig
• type RefQueue
  • func NewRefQueue() RefQueue
  • func (r *RefQueue) Add(ref string)
  • func (r *RefQueue) History() []string
  • func (r *RefQueue) Len() int
  • func (r *RefQueue) Pop() string

Variables

var Aliases map[string][]string = map[string][]string{
	"OscalCompleteSchema": {"OscalModels"},
}

var ComplexTypes map[string]string = map[string]string{
	"array": "[]",
}

var GoPrimitive map[string]bool = map[string]bool{
	"string":  true,
	"bool":    true,
	"float64": true,
	"int":     true,
}

var Imports []string = []string{"time"}

var KeysToIgnore map[string]bool = map[string]bool{
	"$schema": true,
}

var PrimitiveAndCustomTypes map[string]string = map[string]string{
	"string":    "string",
	"boolean":   "bool",
	"number":    "float64",
	"integer":   "int",
	"date-time": "time.Time",
}

var RefsToIgnore map[string]bool = map[string]bool{
	"#json-schema-directive": true,
}

Functions

func FmtFieldName

func FmtFieldName(s string) string

FmtFieldName formats a string as a struct key

Example:

FmtFieldName("foo_id")

Output: FooID

func Generate

func Generate(oscalSchema []byte, pkgName string, tags []string) (typeBytes []byte, err error)

Generate a struct definition given a JSON string representation of an object.

Types

type BaseFlags

type BaseFlags struct {
	InputFile  string // -f / --input-file
	OutputFile string // -o / --output-file
	Pkg        string // -p / --pkg
	Tags       string // -t / --tags
}

BaseFlags represents command-line flags for the base go-oscal command.

type GeneratorConfig

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

func NewGeneratorConfig

func NewGeneratorConfig(tags []string, pkgName string) GeneratorConfig

type RefQueue

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

func NewRefQueue

func NewRefQueue() RefQueue

func (*RefQueue) Add

func (r *RefQueue) Add(ref string)

func (*RefQueue) History

func (r *RefQueue) History() []string

func (*RefQueue) Len

func (r *RefQueue) Len() int

func (*RefQueue) Pop

func (r *RefQueue) Pop() string