smithy

package module
v0.2.8 Latest Latest
Warning

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

 Go to latest Published: Mar 5, 2022 License: Apache-2.0 Imports: 12 Imported by: 1

README

smithy

A Go-based tool to work with Smithy API Specifications.

This code is extracted from SADL, and extended to handle more Smithy use cases.

The tool reads multiple files, assembles them, and then outputs the resulting model. The input files can be any mix of Smithy IDL or Smithy AST files in JSON. The default output is the "unparsing" of the assembled model to IDL into a file per namespace. Alternate generators may be specified (see usage line), notably "ast", which just dumps the model as JSON.

This work is an independent implementation of the 1.0 Smithy Specification. For more information about Smithy, its specification, and its supported tooling, see https://awslabs.github.io/smithy/.

Documentation

Overview

Copyright 2021 Lee R. Boynton

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at 

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Copyright 2021 Lee R. Boynton

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at 

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Copyright 2021 Lee R. Boynton

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at 

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Copyright 2021 Lee R. Boynton

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at 

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Copyright 2021 Lee R. Boynton

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at 

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Copyright 2021 Lee R. Boynton

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at 

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Copyright 2021 Lee R. Boynton

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at 

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Copyright 2021 Lee R. Boynton

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at 

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Index

Constants

View Source 
const BLACK = "\033[0;0m"
View Source 
const BLUE = "\033[94m"
View Source 
const GREEN = "\033[92m"
View Source 
const IndentAmount = "    "
View Source 
const RED = "\033[0;31m"
View Source 
const SmithyVersion = "1.0"
View Source 
const UnspecifiedNamespace = "example"
View Source 
const UnspecifiedVersion = "0.0"
View Source 
const YELLOW = "\033[0;33m"

Variables

View Source 
var ToolVersion string = "development version"
View Source 
var Verbose bool

Functions

func Capitalize 

func Capitalize(s string) string

func Debug 

func Debug(args ...interface{})

func FormatComment 

func FormatComment(indent, prefix, comment string, maxcol int, extraPad bool) string

func FormattedAnnotation 

func FormattedAnnotation(filename string, source string, prefix string, msg string, tok *Token, color string, contextSize int) string

func IsDigit 

func IsDigit(ch rune) bool

func IsLetter 

func IsLetter(ch rune) bool

func IsLowercaseLetter 

func IsLowercaseLetter(ch rune) bool

func IsPreludeType 

func IsPreludeType(name string) bool

func IsSymbolChar 

func IsSymbolChar(ch rune, first bool) bool

func IsUppercaseLetter 

func IsUppercaseLetter(ch rune) bool

func IsWhitespace 

func IsWhitespace(ch rune) bool

func StripNamespace 

func StripNamespace(target string) string

func TrimLeftSpace added in v0.1.2 

func TrimLeftSpace(s string) string

func TrimRightSpace added in v0.1.2 

func TrimRightSpace(s string) string

func TrimSpace added in v0.1.2 

func TrimSpace(s string) string

func Uncapitalize 

func Uncapitalize(s string) string

Types

type AST 

type AST struct {
	Smithy   string       `json:"smithy"`
	Metadata *data.Object `json:"metadata,omitempty"`
	Shapes   *Shapes      `json:"shapes,omitempty"`
}

func LoadAST added in v0.2.6 

func LoadAST(path string) (*AST, error)

func Parse added in v0.2.6 

func Parse(path string) (*AST, error)

func (*AST) ExternalRefs 

func (ast *AST) ExternalRefs(ns string) []string

func (*AST) Filter added in v0.2.3 

func (ast *AST) Filter(tags []string)

func (*AST) GetShape 

func (ast *AST) GetShape(id string) *Shape

func (*AST) IDL 

func (ast *AST) IDL(ns string) string

Generate Smithy IDL to describe the Smithy model for a specified namespace

func (*AST) Merge 

func (ast *AST) Merge(src *AST) error

func (*AST) NamespaceAndServiceVersion 

func (ast *AST) NamespaceAndServiceVersion() (string, string, string)

ASTs don't have a preferred namespace, but IDL files do. When going back to IDL, getting the preferred namespace is desirable. The algorithm here is to prefer the first service's namespace, if present, or the first non-smithy, non-aws namespace encountered.

func (*AST) Namespaces added in v0.2.6 

func (ast *AST) Namespaces() []string

func (*AST) PutShape 

func (ast *AST) PutShape(id string, shape *Shape)

func (*AST) RequiresDocumentType added in v0.2.4 

func (ast *AST) RequiresDocumentType() bool

func (*AST) ShapeNames added in v0.2.6 

func (ast *AST) ShapeNames() []string

func (*AST) Validate 

func (ast *AST) Validate() error

type AstGenerator 

type AstGenerator struct {
	BaseGenerator
}

func (*AstGenerator) Generate 

func (gen *AstGenerator) Generate(ast *AST, config *data.Object) error

type BaseGenerator 

type BaseGenerator struct {
	Config         *data.Object
	OutDir         string
	ForceOverwrite bool

	Err error
	// contains filtered or unexported fields
}

func (*BaseGenerator) Configure added in v0.1.2 

func (gen *BaseGenerator) Configure(conf *data.Object) error

func (*BaseGenerator) Emit added in v0.1.2 

func (gen *BaseGenerator) Emit(text string, filename string, separator string) error

func (*BaseGenerator) FileExists 

func (gen *BaseGenerator) FileExists(path string) bool

func (*BaseGenerator) FileName 

func (gen *BaseGenerator) FileName(ns string, suffix string) string

func (*BaseGenerator) WriteFile 

func (gen *BaseGenerator) WriteFile(path string, content string) error

type Generator 

type Generator interface {
	Generate(ast *AST, config *data.Object) error
}

type IdlGenerator 

type IdlGenerator struct {
	BaseGenerator
}

func (*IdlGenerator) Generate 

func (gen *IdlGenerator) Generate(ast *AST, config *data.Object) error

type IdlWriter 

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

func (*IdlWriter) Begin 

func (w *IdlWriter) Begin()

func (*IdlWriter) Emit 

func (w *IdlWriter) Emit(format string, args ...interface{})

func (*IdlWriter) EmitBlobShape 

func (w *IdlWriter) EmitBlobShape(name string, shape *Shape)

func (*IdlWriter) EmitBooleanShape 

func (w *IdlWriter) EmitBooleanShape(name string, shape *Shape)

func (*IdlWriter) EmitBooleanTrait 

func (w *IdlWriter) EmitBooleanTrait(b bool, tname, indent string)

func (*IdlWriter) EmitCollectionShape 

func (w *IdlWriter) EmitCollectionShape(shapeName, name string, shape *Shape)

func (*IdlWriter) EmitCustomTrait 

func (w *IdlWriter) EmitCustomTrait(k string, v interface{}, indent string)

func (*IdlWriter) EmitDeprecatedTrait 

func (w *IdlWriter) EmitDeprecatedTrait(v interface{}, indent string)

func (*IdlWriter) EmitDocumentation 

func (w *IdlWriter) EmitDocumentation(doc, indent string)

func (*IdlWriter) EmitEnumTrait 

func (w *IdlWriter) EmitEnumTrait(v interface{}, indent string)

func (*IdlWriter) EmitExamplesTrait 

func (w *IdlWriter) EmitExamplesTrait(opname string, raw interface{})

func (*IdlWriter) EmitHttpErrorTrait 

func (w *IdlWriter) EmitHttpErrorTrait(rv interface{}, indent string)

func (*IdlWriter) EmitHttpTrait 

func (w *IdlWriter) EmitHttpTrait(rv interface{}, indent string)

func (*IdlWriter) EmitLengthTrait 

func (w *IdlWriter) EmitLengthTrait(v interface{}, indent string)

func (*IdlWriter) EmitMapShape 

func (w *IdlWriter) EmitMapShape(name string, shape *Shape)

func (*IdlWriter) EmitNumericShape 

func (w *IdlWriter) EmitNumericShape(shapeName, name string, shape *Shape)

func (*IdlWriter) EmitOperationShape 

func (w *IdlWriter) EmitOperationShape(name string, shape *Shape)

func (*IdlWriter) EmitPaginatedTrait 

func (w *IdlWriter) EmitPaginatedTrait(d interface{})

func (*IdlWriter) EmitRangeTrait 

func (w *IdlWriter) EmitRangeTrait(v interface{}, indent string)

func (*IdlWriter) EmitResourceShape 

func (w *IdlWriter) EmitResourceShape(name string, shape *Shape)

func (*IdlWriter) EmitServiceShape 

func (w *IdlWriter) EmitServiceShape(name string, shape *Shape)

func (*IdlWriter) EmitShape 

func (w *IdlWriter) EmitShape(name string, shape *Shape)

func (*IdlWriter) EmitSimpleShape 

func (w *IdlWriter) EmitSimpleShape(shapeName, name string)

func (*IdlWriter) EmitStringShape 

func (w *IdlWriter) EmitStringShape(name string, shape *Shape)

func (*IdlWriter) EmitStringTrait 

func (w *IdlWriter) EmitStringTrait(v, tname, indent string)

func (*IdlWriter) EmitStructureShape 

func (w *IdlWriter) EmitStructureShape(name string, shape *Shape)

func (*IdlWriter) EmitTagsTrait 

func (w *IdlWriter) EmitTagsTrait(v interface{}, indent string)

func (*IdlWriter) EmitTimestampShape 

func (w *IdlWriter) EmitTimestampShape(name string, shape *Shape)

func (*IdlWriter) EmitTraitTrait 

func (w *IdlWriter) EmitTraitTrait(v interface{})

func (*IdlWriter) EmitTraits 

func (w *IdlWriter) EmitTraits(traits *data.Object, indent string)

func (*IdlWriter) EmitUnionShape 

func (w *IdlWriter) EmitUnionShape(name string, shape *Shape)

func (*IdlWriter) End 

func (w *IdlWriter) End() string

type Member 

type Member struct {
	Target string       `json:"target"`
	Traits *data.Object `json:"traits,omitempty"`
}

type Members added in v0.2.0 

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

a Members object is a map from string to *Member. It preserves the order of its keys, unlike a Go map

func NewMembers added in v0.2.6 

func NewMembers() *Members

func (*Members) Get added in v0.2.0 

func (m *Members) Get(key string) *Member

func (*Members) Keys added in v0.2.0 

func (m *Members) Keys() []string

func (*Members) Length added in v0.2.0 

func (m *Members) Length() int

func (Members) MarshalJSON added in v0.2.0 

func (m Members) MarshalJSON() ([]byte, error)

func (*Members) Put added in v0.2.0 

func (m *Members) Put(key string, val *Member)

func (*Members) UnmarshalJSON added in v0.2.0 

func (m *Members) UnmarshalJSON(raw []byte) error

type Parser 

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

func (*Parser) EndOfFileError 

func (p *Parser) EndOfFileError() error

func (*Parser) Error 

func (p *Parser) Error(msg string) error

func (*Parser) ExpectIdentifier 

func (p *Parser) ExpectIdentifier() (string, error)

func (*Parser) ExpectIdentifierArray 

func (p *Parser) ExpectIdentifierArray() ([]string, error)

func (*Parser) ExpectIdentifierMap 

func (p *Parser) ExpectIdentifierMap() (map[string]string, error)

func (*Parser) ExpectInt 

func (p *Parser) ExpectInt() (int, error)

func (*Parser) ExpectNumber 

func (p *Parser) ExpectNumber() (*data.Decimal, error)

func (*Parser) ExpectString 

func (p *Parser) ExpectString() (string, error)

func (*Parser) ExpectStringArray 

func (p *Parser) ExpectStringArray() ([]string, error)

func (*Parser) GetToken 

func (p *Parser) GetToken() *Token

func (*Parser) MergeComment 

func (p *Parser) MergeComment(comment1 string, comment2 string) string

func (*Parser) Parse 

func (p *Parser) Parse() error

func (*Parser) SyntaxError 

func (p *Parser) SyntaxError() error

func (*Parser) UngetToken 

func (p *Parser) UngetToken()

type SadlGenerator added in v0.2.0 

type SadlGenerator struct {
	BaseGenerator
}

func (*SadlGenerator) Generate added in v0.2.0 

func (gen *SadlGenerator) Generate(ast *AST, config *data.Object) error

func (*SadlGenerator) ToSadl added in v0.2.0 

func (gen *SadlGenerator) ToSadl(ns string, ast *AST) string

type SadlWriter added in v0.2.0 

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

func (*SadlWriter) Begin added in v0.2.0 

func (w *SadlWriter) Begin()

func (*SadlWriter) Emit added in v0.2.0 

func (w *SadlWriter) Emit(format string, args ...interface{})

func (*SadlWriter) EmitBlobShape added in v0.2.0 

func (w *SadlWriter) EmitBlobShape(name string, shape *Shape)

func (*SadlWriter) EmitBooleanShape added in v0.2.0 

func (w *SadlWriter) EmitBooleanShape(name string, shape *Shape)

func (*SadlWriter) EmitCollectionShape added in v0.2.0 

func (w *SadlWriter) EmitCollectionShape(shapeName, name string, shape *Shape)

func (*SadlWriter) EmitEnum added in v0.2.0 

func (w *SadlWriter) EmitEnum(name string, shape *Shape, lst []interface{})

func (*SadlWriter) EmitMapShape added in v0.2.0 

func (w *SadlWriter) EmitMapShape(name string, shape *Shape)

func (*SadlWriter) EmitNumericShape added in v0.2.0 

func (w *SadlWriter) EmitNumericShape(shapeName, name string, shape *Shape)

func (*SadlWriter) EmitOperationShape added in v0.2.0 

func (w *SadlWriter) EmitOperationShape(name string, shape *Shape, opts []string)

func (*SadlWriter) EmitShape added in v0.2.0 

func (w *SadlWriter) EmitShape(name string, shape *Shape)

func (*SadlWriter) EmitShapeComment added in v0.2.0 

func (w *SadlWriter) EmitShapeComment(shape *Shape)

func (*SadlWriter) EmitStringShape added in v0.2.0 

func (w *SadlWriter) EmitStringShape(name string, shape *Shape)

func (*SadlWriter) EmitStructureShape added in v0.2.0 

func (w *SadlWriter) EmitStructureShape(name string, shape *Shape, opts []string)

func (*SadlWriter) EmitTimestampShape added in v0.2.0 

func (w *SadlWriter) EmitTimestampShape(name string, shape *Shape)

func (*SadlWriter) EmitUnionShape added in v0.2.0 

func (w *SadlWriter) EmitUnionShape(name string, shape *Shape)

func (*SadlWriter) End added in v0.2.0 

func (w *SadlWriter) End() string

type Scanner 

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

func NewScanner 

func NewScanner(r io.Reader) *Scanner

func (*Scanner) Scan 

func (s *Scanner) Scan() Token

type Shape 

type Shape struct {
	Type   string       `json:"type"`
	Traits *data.Object `json:"traits,omitempty"` //service, resource, operation, apply

	//List and Set
	Member *Member `json:"member,omitempty"`

	//Map
	Key   *Member `json:"key,omitempty"`
	Value *Member `json:"value,omitempty"`

	//Structure and Union
	Members *Members `json:"members,omitempty"` //keys must be case-insensitively unique. For union, len(Members) > 0,

	//Resource
	Identifiers map[string]*ShapeRef `json:"identifiers,omitempty"`
	//FIXME preserve resource identifier order?
	Create               *ShapeRef   `json:"create,omitempty"`
	Put                  *ShapeRef   `json:"put,omitempty"`
	Read                 *ShapeRef   `json:"read,omitempty"`
	Update               *ShapeRef   `json:"update,omitempty"`
	Delete               *ShapeRef   `json:"delete,omitempty"`
	List                 *ShapeRef   `json:"list,omitempty"`
	CollectionOperations []*ShapeRef `json:"collectionOperations,omitempty"`

	//Resource and Service
	Operations []*ShapeRef `json:"operations,omitempty"`
	Resources  []*ShapeRef `json:"resources,omitempty"`

	//Operation
	Input  *ShapeRef   `json:"input,omitempty"`
	Output *ShapeRef   `json:"output,omitempty"`
	Errors []*ShapeRef `json:"errors,omitempty"`

	//Service
	Version string `json:"version,omitempty"`
}

type ShapeRef 

type ShapeRef struct {
	Target string `json:"target"`
}

type Shapes 

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

a Shapes object is a map from Shape ID to *Shape. It preserves the order of its keys, unlike a Go map

func NewShapes added in v0.2.6 

func NewShapes() *Shapes

func (*Shapes) Get 

func (s *Shapes) Get(key string) *Shape

func (*Shapes) Keys 

func (s *Shapes) Keys() []string

func (*Shapes) Length 

func (s *Shapes) Length() int

func (Shapes) MarshalJSON 

func (s Shapes) MarshalJSON() ([]byte, error)

func (*Shapes) Put 

func (s *Shapes) Put(key string, val *Shape)

func (*Shapes) UnmarshalJSON 

func (s *Shapes) UnmarshalJSON(raw []byte) error

type Token 

type Token struct {
	Type  TokenType
	Text  string
	Line  int
	Start int
}

func (Token) IsNumeric 

func (tok Token) IsNumeric() bool

func (Token) IsText 

func (tok Token) IsText() bool

func (Token) String 

func (tok Token) String() string

type TokenType 

type TokenType int
const (
	UNDEFINED TokenType = iota
	EOF
	LINE_COMMENT
	BLOCK_COMMENT
	SYMBOL
	NUMBER
	STRING
	COLON
	SEMICOLON
	COMMA
	AT
	DOT
	EQUALS
	DOLLAR
	QUOTE
	SLASH
	QUESTION
	OPEN_BRACE
	CLOSE_BRACE
	OPEN_BRACKET
	CLOSE_BRACKET
	OPEN_PAREN
	CLOSE_PAREN
	OPEN_ANGLE
	CLOSE_ANGLE
	NEWLINE
	HASH
	AMPERSAND
	STAR
	BACKQUOTE
	TILDE
	BANG
)

func (TokenType) String 

func (tokenType TokenType) String() string

Source Files

View all Source files

Directories

Path Synopsis
cmd
smithy command

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.