tspec

package

v0.0.0-...-face69f Latest Latest Go to latest Published: Jan 3, 2019 License: MIT Imports: 13 Imported by: 2

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

View Source

const (
	// DefaultRefPrefix defines the default value of ref prefix
	DefaultRefPrefix = "#/definitions/"
)

View Source

var DefaultParserOptions = ParserOptions{
	IgnoreJSONTag: false,
	RefPrefix:     DefaultRefPrefix,
}

DefaultParserOptions defines default tspec parser options

func ParsePkgWithDecorator(pkg *ast.Package, decorator string) (objs map[string]*ast.Object, err error)

ParsePkgWithDecorator parses package and returns all types with the gaven decorator

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

Parser defines tspec parser

func NewParser() (parser *Parser)

NewParser returns a new tspec parser

func (t *Parser) Definitions() (defs spec.Definitions)

Definitions returns all related definitions

func (t *Parser) Import(pkgPath string) (pkg *ast.Package, err error)

Import imports package dir and returns related package

func (t *Parser) Options(opts ...ParserOptions) ParserOptions

Options gets or sets parser options

func (t *Parser) Parse(oPkg *ast.Package, typeStr string) (
	schema *spec.Schema, err error)

Parse parses type expr and returns related json schema

func (t *Parser) ParseDir(dirPath string, pkgName string, opts ...bool) (pkg *ast.Package, cached bool, err error)

ParseDir parses the dir and cache it

func (t *Parser) ParsePkg(pkg *ast.Package) (objs map[string]*ast.Object, err error)

ParsePkg collects all objs and cache them

func (t *Parser) Reset()

Reset cleans all definitions

type ParserOptions struct {
	IgnoreJSONTag bool
	RefPrefix     string
}

ParserOptions defines tspec parser options