model

Documentation

Index

• type Changelog
  • func (c Changelog) HasBreakingChanges() bool
  • func (c Changelog) String() string
  • func (c Changelog) ToCompactMarkdown() string
  • func (c Changelog) ToMarkdown() string
• type Metadata
  • func NewMetadataFrom(reader io.Reader) (Metadata, error)
• type Option
  • func NewArgument(value string) Option
  • func NewFlagOption(flag string) Option
  • func NewKeyValueOption(key, value string) Option
• type Options
  • func NewOptionsFrom(reader io.Reader) (Options, error)

Types

type Changelog

type Changelog struct {
	// NewPackage is true if this package does not exist in the old version
	NewPackage bool
	// RemovedPackage is true if this package does not exist in the new version
	RemovedPackage bool
	// Modified contains the details of a modified package. This is nil when either NewPackage or RemovedPackage is true
	Modified *report.Package
}

Changelog describes the changelog generated for a package.

func (Changelog) HasBreakingChanges

func (c Changelog) HasBreakingChanges() bool

HasBreakingChanges returns if this report of changelog contains breaking changes

func (Changelog) String

func (c Changelog) String() string

String ...

func (Changelog) ToCompactMarkdown

func (c Changelog) ToCompactMarkdown() string

ToCompactMarkdown returns the markdown string of this changelog but more compact

func (Changelog) ToMarkdown

func (c Changelog) ToMarkdown() string

ToMarkdown returns the markdown string of this changelog

type Metadata

type Metadata interface {
	// SwaggerFiles returns the related swagger files in this tag
	SwaggerFiles() []string
	// PackagePath returns the output package path of this tag
	PackagePath() string
}

Metadata ...

func NewMetadataFrom

func NewMetadataFrom(reader io.Reader) (Metadata, error)

NewMetadataFrom reads a new Metadata from a io.Reader

type Option

type Option interface {
	// Format returns the actual option in string
	Format() string
}

Option describes an option of a autorest command line

func NewArgument

func NewArgument(value string) Option

NewArgument returns a new argument option (without "--")

func NewFlagOption

func NewFlagOption(flag string) Option

NewFlagOption returns a flag option (with "--", without value)

func NewKeyValueOption

func NewKeyValueOption(key, value string) Option

NewKeyValueOption returns a key-value option like "--tag=something"

type Options

type Options interface {
	// Arguments returns the argument defined in this options
	Arguments() []string
	// CodeGeneratorVersion returns the code generator version defined in this options
	CodeGeneratorVersion() string
}

Options ...

func NewOptionsFrom

func NewOptionsFrom(reader io.Reader) (Options, error)

NewOptionsFrom returns a new instance of Options from the given io.Reader