utils

Documentation

Overview

Package utils ...

Package utils ...

Package utils ...

Package utils ...

Package utils ...

Index

• func CurrentYear() string
• func ExitIfError(err error)
• 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 IsError(err error, showMessage bool) bool
• func IsValidURL(input string) bool
• func PlusOne(x int) int
• func RetrievePackageManagerFromPkgJSON(appFS afero.Fs, pathToPkgJSON string) (npmc.NPMClient, error)
• func RetrieveProjectName(appFS afero.Fs, pathToPkgJSON string) (string, error)
• func Sum(x int, y int) int
• func ToBasePath(fullpath string, replace string) string
• func ToLibFile(txt string) string
• func ToMDFile(txt string, uppercase bool) string
• func ToSlug(txt string) string
• func ToSnakeCase(txt string) string
• func ToTitle(txt string) string
• func ToURL(txt string) string
• func ToVariableName(txt string) string
• func Today() string
• func Trimmed(txt string) string
• func Underline(txt string) string
• type GitHubRepo
  • func NewGitHubURLParser(input string) (*GitHubRepo, error)
  • func (gh *GitHubRepo) GetHost() string
  • func (gh *GitHubRepo) GetRepo() string
  • func (gh *GitHubRepo) GetUser() string
• type ProgressBar
  • func NewProgressBar(total int) *ProgressBar
  • func (pb *ProgressBar) Increment()
  • func (pb *ProgressBar) Wait()

Functions

func CurrentYear

func CurrentYear() string

CurrentYear returns the current calendar year as a string.

func ExitIfError

func ExitIfError(err error)

ExitIfError panics on os.Exit(1) if error.

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 IsError

func IsError(err error, showMessage bool) bool

IsError returns true if error is not nil. If showMessage is true it prints out a warning with the error message.

func IsValidURL

func IsValidURL(input string) bool

IsValidURL returns true if the input string is a well-structured url

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 RetrieveProjectName

func RetrieveProjectName(appFS afero.Fs, pathToPkgJSON string) (string, error)

RetrieveProjectName returns the project name as string 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 ToLibFile

func ToLibFile(txt string) string

ToLibFile returns a string a valid lib filename example: ToLibFile("category") returns 'apiCategory.ts'.

func ToMDFile

func ToMDFile(txt string, uppercase bool) string

ToMDFile returns a string with .md extension example: ToMDFile("getting started", false) returns 'getting-started.md'. example: ToMDFile("getting started", true) returns 'GETTING-STARTED.md'.

func ToSlug

func ToSlug(txt string) string

ToSlug returns a copy of string with lowercase replacing "_" and whitespaces with "-" example: ToSlug("New Resource") returns new-resource.

func ToSnakeCase

func ToSnakeCase(txt string) string

ToSnakeCase returns a copy of string with lowercase replacing "_" and whitespaces with "_" example: ToSnakeCase("New Resource") returns new_resource.

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 ToVariableName

func ToVariableName(txt string) string

ToVariableName returns a copy of string to be used as variable name.

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.

func Underline

func Underline(txt string) string

Underline returns a string underlined

Types

type GitHubRepo

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

GitHubRepo is the struct representing a GitHub repository

func NewGitHubURLParser

func NewGitHubURLParser(input string) (*GitHubRepo, error)

NewGitHubURLParser takes a github url and returns the repository info as GitHubRepo struct

func (*GitHubRepo) GetHost

func (gh *GitHubRepo) GetHost() string

GetHost returns the host as string

func (*GitHubRepo) GetRepo

func (gh *GitHubRepo) GetRepo() string

GetRepo returns the repo name as string

func (*GitHubRepo) GetUser

func (gh *GitHubRepo) GetUser() string

GetUser returns the repo's owner 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.