utility

README

utility

Documentation

Index

• Constants
• func CreateMarkdownHeading(text string, level int) string
• func CreateMarkdownHeadings(text []string, level int) string
• func CreateMarkdownList(items []string) string
• func GetInput(question string) string
• func RequestDecisionInput(question string, preferTrue bool) bool
• func RequestValueInput(requestedValue string, defaultValue interface{}) string
• func RequestValueListInput(requestedValue string) []string
• type Readme
  • func (readme Readme) Render() ([]byte, error)
  • func (r Readme) ToMap() map[string]interface{}

Constants

const README_TEMPLATE = `` /* 524-byte string literal not displayed */

Functions

func CreateMarkdownHeading

func CreateMarkdownHeading(text string, level int) string

func CreateMarkdownHeadings

func CreateMarkdownHeadings(text []string, level int) string

func CreateMarkdownList

func CreateMarkdownList(items []string) string

func GetInput

func GetInput(question string) string

print the question and wait for a user-input

func RequestDecisionInput

func RequestDecisionInput(question string, preferTrue bool) bool

print the question and wait for a "y/n" answer from the user

func RequestValueInput

func RequestValueInput(requestedValue string, defaultValue interface{}) string

ask for the requestedValue and return either the user-input or the default value

func RequestValueListInput

func RequestValueListInput(requestedValue string) []string

ask for the requestedValue and gather the list items from the input

Types

type Readme

type Readme struct {
	Title            string   `json:"title"`
	Description      string   `json:"description"`
	RepositoryURL    string   `json:"repository-url"`
	Headings         []string `json:"headings"`
	Requirements     []string `json:"requirements"`
	ShowContributors bool     `json:"show-contributors"`
	ShowShields      bool     `json:"show-shields"`
	Watermark        bool     `json:"watermark"`
}

func (Readme) Render

func (readme Readme) Render() ([]byte, error)

func (Readme) ToMap

func (r Readme) ToMap() map[string]interface{}