util

Documentation

Index

• Constants
• Variables
• func DeleteAllPaths(path string) error
• func DeletePath(path string) error
• func GetIcon(unicode, colour string) string
• func Init(config Config)
• func PathExists(filePath string) bool
• func PortAvailable(port string) bool
• func Rel(path string) string
• type Config
• type Status
  • func New(showIcons bool) Status
  • func (s *Status) Clean()
  • func (s *Status) Error(text string)
  • func (s *Status) Errorln(text string)
  • func (s *Status) Executing(text string)
  • func (s *Status) Executingln(text string)
  • func (s *Status) Fatal(text string)
  • func (s *Status) Increment(value int)
  • func (s *Status) Info(text string)
  • func (s *Status) Infoln(text string)
  • func (s *Status) Print()
  • func (s *Status) Reset()
  • func (s *Status) Set(text string)
  • func (s *Status) Success(text string)
  • func (s *Status) Successln(text string)
  • func (s *Status) Suppressed(text string)
  • func (s *Status) Suppressedln(text string)
  • func (s *Status) Update(value int)
  • func (s *Status) Warn(text string)
  • func (s *Status) Warnln(text string)

Constants

const (
	GEAR      = "⚙"
	CHECK     = "✔"
	CANCEL    = "✘"
	INFO      = "ℹ"
	WARN      = "⚠"
	ERROR     = "✖"
	HOURGLASS = "⌛"
)

const (
	Bold   = "\033[1m"
	Reset  = "\033[0m"
	Green  = "\033[32m"
	Blue   = "\033[34m"
	Yellow = "\033[33m"
	Cyan   = "\033[36m"
	Red    = "\033[31m"
	Gray   = "\033[37;2m"
)

Initialize console colours

const (
	API_VERSION = "v1"

	//  initiaze webhook-secret for Hasura Authentication
	WEBHOOK_SECRET = "nhost-webhook-secret"

	//  initiaze admin-secret for Hasura Authentication
	ADMIN_SECRET = "nhost-admin-secret"
)

Variables

var JWT_KEY = "0f987876650b4a085e64594fae9219e7781b17506bec02489ad061fba8cb22db"

 Initiaze JWT key for Hasura Authentication
	JWT_KEY = generateRandomKey(32)

var (
	WORKING_DIR string
)

Functions

func DeleteAllPaths

func DeleteAllPaths(path string) error

deletes all the paths leading to the given file/folder and unlink from filesystem

func DeletePath

func DeletePath(path string) error

deletes the given file/folder path and unlink from filesystem

func GetIcon

func GetIcon(unicode, colour string) string

Returns the icon formatted in the specified color.

func Init

func Init(config Config)

func PathExists

func PathExists(filePath string) bool

validates whether a given folder/file path exists or not

func PortAvailable

func PortAvailable(port string) bool

func Rel

func Rel(path string) string

Returns path relative to Nhost current working directory

Types

type Config

type Config struct {
	WorkingDir string
	Writer     *Status
}

type Status

type Status struct {
	Value int
	Total int
	Text  string
	Icon  string
	// contains filtered or unexported fields
}

Status is an in-line output structure that holds the status text and icon

var (

	//  New base writer for all tasks
	Writer Status
)

func New

func New(showIcons bool) Status

Returns a new Status object

func (*Status) Clean

func (s *Status) Clean()

Delete all text from line, and shift cursor back to beginning of line

func (*Status) Error

func (s *Status) Error(text string)

Change the status icon to error, and set the text

func (*Status) Errorln

func (s *Status) Errorln(text string)

Print the status error in a new line

func (*Status) Executing

func (s *Status) Executing(text string)

Change the status icon to yellow coloured gear, and set the text

func (*Status) Executingln

func (s *Status) Executingln(text string)

Print the execution status in a new line

func (*Status) Fatal

func (s *Status) Fatal(text string)

Set the status error and exit CLI

func (*Status) Increment

func (s *Status) Increment(value int)

Increase the status value

func (*Status) Info

func (s *Status) Info(text string)

Change the status icon to info, and set the text

func (*Status) Infoln

func (s *Status) Infoln(text string)

Print the info status in a new line

func (*Status) Print

func (s *Status) Print()

Print the status text

func (*Status) Reset

func (s *Status) Reset()

Reset total status value

func (*Status) Set

func (s *Status) Set(text string)

Set the status text

func (*Status) Success

func (s *Status) Success(text string)

Change the status icon to success, and set the text

func (*Status) Successln

func (s *Status) Successln(text string)

Print the success status in a new line

func (*Status) Suppressed

func (s *Status) Suppressed(text string)

Change the status icon to gray coloured gear, and set the text

func (*Status) Suppressedln

func (s *Status) Suppressedln(text string)

Print the supressed status in a new line

func (*Status) Update

func (s *Status) Update(value int)

Update total status value

func (*Status) Warn

func (s *Status) Warn(text string)

Change the status icon to warning, and set the text

func (*Status) Warnln

func (s *Status) Warnln(text string)

Print the warning status in a new line