typreadme

package

v0.8.20 Latest Latest Go to latest Published: Feb 27, 2020 License: MIT Imports: 8 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/typical-go/typical-rest-server

Links

Open Source Insights

Documentation ¶

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type ConfigInfo ¶ added in v0.8.15

type ConfigInfo struct {
	Name     string
	Type     string
	Default  string
	Required string
}

ConfigInfo is configuration information

type Object ¶ added in v0.8.20

type Object struct {
	TemplateFile string
	Title        string
	Description  string
	Usages       []UsageInfo
	BuildUsages  []UsageInfo
	Configs      []ConfigInfo
}

Object represent readme documentation

type Readme ¶ added in v0.8.20

type Readme struct {
	// NOTE: required to be public to be access by template
	TargetFile   string
	TemplateFile string
	// contains filtered or unexported fields
}

Readme module

func New ¶ added in v0.8.15

func New() *Readme

New readme module

func (*Readme) BuildUsages ¶ added in v0.8.20

func (m *Readme) BuildUsages(c *typbuildtool.Context) (infos []UsageInfo)

BuildUsages of readme

func (*Readme) Commands ¶ added in v0.8.20

func (m *Readme) Commands(c *typbuildtool.Context) []*cli.Command

Commands of readme

func (*Readme) Configs ¶ added in v0.8.20

func (m *Readme) Configs(c *typbuildtool.Context) (infos []ConfigInfo)

Configs of readme

func (*Readme) Description ¶ added in v0.8.20

func (m *Readme) Description(c *typbuildtool.Context) string

Description of readme

func (*Readme) Title ¶ added in v0.8.20

func (m *Readme) Title(c *typbuildtool.Context) string

Title of readme

func (*Readme) Usages ¶ added in v0.8.20

func (m *Readme) Usages(c *typbuildtool.Context) (infos []UsageInfo)

Usages of readme

func (*Readme) WithBuildUsages ¶ added in v0.8.20

func (m *Readme) WithBuildUsages(buildUsages []UsageInfo) *Readme

WithBuildUsages return module with new build usages

func (*Readme) WithConfigs ¶ added in v0.8.20

func (m *Readme) WithConfigs(configs []ConfigInfo) *Readme

WithConfigs return odule with new configs

func (*Readme) WithDescription ¶ added in v0.8.20

func (m *Readme) WithDescription(description string) *Readme

WithDescription return module with new description

func (*Readme) WithTargetFile ¶ added in v0.8.20

func (m *Readme) WithTargetFile(targetFile string) *Readme

WithTargetFile return module with new target file

func (*Readme) WithTemplateFile ¶ added in v0.8.20

func (m *Readme) WithTemplateFile(templateFile string) *Readme

WithTemplateFile return module with new template file

func (*Readme) WithTitle ¶ added in v0.8.20

func (m *Readme) WithTitle(title string) *Readme

WithTitle return module with new title

func (*Readme) WithUsages ¶ added in v0.8.20

func (m *Readme) WithUsages(usages []UsageInfo) *Readme

WithUsages return module with new usages

type UsageInfo ¶ added in v0.8.20

type UsageInfo struct {
	Usage       string
	Description string
}

UsageInfo is command information

Source Files ¶

View all Source files

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