utils

Documentation

Overview

Package utils ...

Package utils ...

Package utils ...

Package utils ...

Package utils ...

Index

• func CheckIfError(err error)
• func CurrentYear() string
• func GetInstalledNPMClientList() []npmc.NPMClient
• func GetNPMClientInfo(name string) (bool, string)
• func GetNPMClientNames(items []npmc.NPMClient) []string
• func GetSelectedNPMClient(in []npmc.NPMClient, name string) npmc.NPMClient
• func GitClone(sveltinTemplate *config.AppTemplate, inpath string) error
• func PlusOne(x int) int
• func RetrievePackageManagerFromPkgJson(appFS afero.Fs, pathToPkgJson string) (npmc.NPMClient, error)
• func Sum(x int, y int) int
• func ToBasePath(fullpath string, replace string) string
• func ToLibFilename(txt string) string
• func ToMDFile(text string) string
• func ToPageVariableName(txt string) string
• func ToTitle(txt string) string
• func ToURL(txt string) string
• func ToValidName(txt string) string
• func Today() string
• func Trimmed(txt string) string
• type ListWriter
  • func NewListWriter() ListWriter
  • func (lw ListWriter) AppendItem(message string)
  • func (lw ListWriter) Indent()
  • func (lw ListWriter) Render() string
  • func (lw ListWriter) Reset()
  • func (lw ListWriter) SetBulletTriangleStyle()
  • func (lw ListWriter) SetStyle(style list.Style)
  • func (lw ListWriter) UnIndent()
• type Logger
• type Printer
• type PrinterBuffer
  • func PrettyPrinter(tl *TextLogger) PrinterBuffer
  • func (pb PrinterBuffer) Print()
  • func (pb PrinterBuffer) ToString() string
• type ProgressBar
  • func NewProgressBar(total int) *ProgressBar
  • func (pb *ProgressBar) Increment()
  • func (pb *ProgressBar) Wait()
• type TextLogger
  • func NewTextLogger() *TextLogger
  • func (tl *TextLogger) GetContent() string
  • func (tl *TextLogger) GetTitle() string
  • func (tl *TextLogger) Reset()
  • func (tl *TextLogger) SetContent(content string)
  • func (tl *TextLogger) SetTitle(title string)

Functions

func CheckIfError

func CheckIfError(err error)

CheckIfError panics on os.Exit(1) if error

func CurrentYear

func CurrentYear() string

CurrentYear returns the current calendar year as a string.

func GetInstalledNPMClientList

func GetInstalledNPMClientList() []npmc.NPMClient

GetInstalledNPMClientList returns the list of installed npmClient as slice of NPMClient.

func GetNPMClientInfo

func GetNPMClientInfo(name string) (bool, string)

GetNPMClientInfo returns true and npm client version as string.

func GetNPMClientNames

func GetNPMClientNames(items []npmc.NPMClient) []string

GetNPMClientNames returns the list of installed npmClient as slice of strings.

func GetSelectedNPMClient

func GetSelectedNPMClient(in []npmc.NPMClient, name string) npmc.NPMClient

GetSelectedNPMClient returns the selected NPMClient struct out of the available ones.

func GitClone

func GitClone(sveltinTemplate *config.AppTemplate, inpath string) error

GitClone clones the git repo to the specified path.

func PlusOne

func PlusOne(x int) int

PlusOne adds one to the integer parameter.

func RetrievePackageManagerFromPkgJson

func RetrievePackageManagerFromPkgJson(appFS afero.Fs, pathToPkgJson string) (npmc.NPMClient, error)

RetrievePackageManagerFromPkgJson returns NPMClient struct parsing the package.json file.

func Sum

func Sum(x int, y int) int

Sum adds two integer values.

func ToBasePath

func ToBasePath(fullpath string, replace string) string

ToBasePath returns a copy of string replacing all occurrences for a string with trailing slash.

func ToLibFilename

func ToLibFilename(txt string) string

ToLibFilename returns a string a valid lib filename example: ToLibFilename("category") returns 'getCategory.js'.

func ToMDFile

func ToMDFile(text string) string

ToMDFile returns a string with .md suffix example: ToMDFile("welcome") returns 'welcome.md'.

func ToPageVariableName

func ToPageVariableName(txt string) string

ToPageVariableName returns a human readable string replacing '-' with white space and capitalizing first letters of each word.

func ToTitle

func ToTitle(txt string) string

ToTitle replace all '-' char with a white space and returns a copy of string s with all letters of string whose begin words mapped to their title case.

func ToURL

func ToURL(txt string) string

ToURL returns a trimmed string with '/' as prefix.

func ToValidName

func ToValidName(txt string) string

ToValidName returns a copy of string replacing '_' with '-' example: ToValidName("getting_started") returns 'getting-started'.

func Today

func Today() string

Today returns the current date as formatted string "DD-ShortMonth-YYYY".

func Trimmed

func Trimmed(txt string) string

Trimmed strips away '"' from a string.

Types

type ListWriter

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

ListWriter is the struct wrapping the list.Writer.

func NewListWriter

func NewListWriter() ListWriter

NewListWriter creates a new ListWriter.

func (ListWriter) AppendItem

func (lw ListWriter) AppendItem(message string)

AppendItem addend an item to the ListWriter.

func (ListWriter) Indent

func (lw ListWriter) Indent()

Indent applies indent the output.

func (ListWriter) Render

func (lw ListWriter) Render() string

Render printout the ListWriter to the stadout.

func (ListWriter) Reset

func (lw ListWriter) Reset()

Reset the ListWriter.

func (ListWriter) SetBulletTriangleStyle

func (lw ListWriter) SetBulletTriangleStyle()

SetBulletTriangleStyle sets BulletTriangle as style to the ListWriter.

func (ListWriter) SetStyle

func (lw ListWriter) SetStyle(style list.Style)

SetStyle sets the list style to be applied on the ListWriter.

func (ListWriter) UnIndent

func (lw ListWriter) UnIndent()

UnIndent applies unindent to the outout.

type Logger

type Logger interface {
	SetTitle(text string)
	GetTitle() string
	SetContent(text string)
	GetContent() string
	Reset()
}

Logger interface declares the methods to set the loggers props.

type Printer

type Printer interface {
	Print()
}

Printer interface declares just the single method for printing the buffer content.

type PrinterBuffer

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

PrinterBuffer is the struct representing the buffer.

func PrettyPrinter

func PrettyPrinter(tl *TextLogger) PrinterBuffer

PrettyPrinter returns a PrinterBuffer as formatted content ready to be printout to stdout.

func (PrinterBuffer) Print

func (pb PrinterBuffer) Print()

Print prints out the buffer content to the stdout.

func (PrinterBuffer) ToString

func (pb PrinterBuffer) ToString() string

ToString returns the buffer content as string.

type ProgressBar

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

ProgressBar is the struct representing a progressbar instance.

func NewProgressBar

func NewProgressBar(total int) *ProgressBar

NewProgressBar returns a pointer to a ProgressBar struct.

func (*ProgressBar) Increment

func (pb *ProgressBar) Increment()

Increment increments progress by amount of n.

func (*ProgressBar) Wait

func (pb *ProgressBar) Wait()

Wait blocks until bar is completed or aborted.

type TextLogger

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

TextLogger is the struct used to write on the stdout as plain text.

func NewTextLogger

func NewTextLogger() *TextLogger

NewTextLogger returns a pointer to a TextLogger.

func (*TextLogger) GetContent

func (tl *TextLogger) GetContent() string

GetContent returns the TextLogger content as string.

func (*TextLogger) GetTitle

func (tl *TextLogger) GetTitle() string

GetTitle returns the TextLogger title as string.

func (*TextLogger) Reset

func (tl *TextLogger) Reset()

Reset the TextLogger.

func (*TextLogger) SetContent

func (tl *TextLogger) SetContent(content string)

SetContent sets the content for the TextLogger.

func (*TextLogger) SetTitle

func (tl *TextLogger) SetTitle(title string)

SetTitle sets the title for the TextLogger.