os

Documentation

Index

• Variables
• func Checksum(content string) (string, error)
• func Chmod(file string, perm fs.FileMode) error
• func Chown(file string, user int, group int) error
• func Copy(origin string, destination string) error
• func Delete(file string) error
• func Dir(path string) string
• func EnsureDirectory(file string) error
• func Exec(cmd string, args ...string) (string, error)
• func Exist(path string) bool
• func Extension(file string) string
• func File(path string) string
• func Info(file string) (string, string, fs.FileMode)
• func List(root string) ([]string, error)
• func Name(path string) string
• func NoColor() bool
• func NodeRequire(command string, pkg string) error
• func Permissions(path string) (fs.FileMode, error)
• func Printf(color string, format string, args ...interface{})
• func RandomString(n int) string
• func Read(file string) (string, error)
• func Relative(path string, root string) string
• func Rename(origin string, destination string) error
• func Replace(file string, search string, replace string) error
• func Resolve(file string, extensions []string, path string) string
• func Server(root string, port string, onRequest RequestCallback) error
• func TemporaryFile(file string) string
• func Watch(root string, onChange WatchCallback) error
• func WatchCheckFile(file string, onChange WatchCallback) error
• func Write(file string, content string, perm fs.FileMode) error
• type RequestCallback
• type WatchCallback

Variables

var (
	Reset   = "\033[0m"
	Red     = "\033[31m"
	Green   = "\033[32m"
	Yellow  = "\033[33m"
	Blue    = "\033[34m"
	Purple  = "\033[35m"
	Cyan    = "\033[36m"
	Gray    = "\033[37m"
	White   = "\033[97m"
	Notice  = Cyan
	Warn    = Yellow
	Fatal   = Red
	Success = Green
)

Colors

Functions

func Checksum

func Checksum(content string) (string, error)

Checksum retrieve the checksum for given content

func Chmod

func Chmod(file string, perm fs.FileMode) error

Chmod apply permissions to file

func Chown

func Chown(file string, user int, group int) error

Chown apply user and group ownership to file

func Copy

func Copy(origin string, destination string) error

Copy the origin file into destination

func Delete

func Delete(file string) error

Delete remove a file

func Dir

func Dir(path string) string

Dir return the clean directory path for file

func EnsureDirectory

func EnsureDirectory(file string) error

EnsureDirectory makes sure directory exists from file path

func Exec

func Exec(cmd string, args ...string) (string, error)

Exec run command with given arguments

func Exist

func Exist(path string) bool

Exist check if file or directory exists

func Extension

func Extension(file string) string

Extension return the clean file extension, with dot

func File

func File(path string) string

File return the clean file name for path, with extension

func Info

func Info(file string) (string, string, fs.FileMode)

Info read and return file information: content, checksum and permissions

func List

func List(root string) ([]string, error)

List walks on path and return every found file

func Name

func Name(path string) string

Name return the clean file name for path, without extension

func NoColor

func NoColor() bool

NoColor check if should avoid color output on console

func NodeRequire

func NodeRequire(command string, pkg string) error

NodeRequire check if node package command exists, otherwise, try to install the package

func Permissions

func Permissions(path string) (fs.FileMode, error)

Permissions retrieve permissions for file or directory

func Printf

func Printf(color string, format string, args ...interface{})

Printf displays a info to standard output

func RandomString

func RandomString(n int) string

RandomString generates a random string from give size

func Read

func Read(file string) (string, error)

Read retrieve content from file

func Relative

func Relative(path string, root string) string

Relative return the relative path from root

func Rename

func Rename(origin string, destination string) error

Rename a file path. Overwrite if already exists

func Replace

func Replace(file string, search string, replace string) error

Replace content inside file

func Resolve

func Resolve(file string, extensions []string, path string) string

Resolve will check paths with possible extensions until file is detected

func Server

func Server(root string, port string, onRequest RequestCallback) error

Server start a file server with given path and port

func TemporaryFile

func TemporaryFile(file string) string

TemporaryFile return a temporary file path

func Watch

func Watch(root string, onChange WatchCallback) error

Watch will check if there is any change in the files inside path

func WatchCheckFile

func WatchCheckFile(file string, onChange WatchCallback) error

WatchCheckFile will check if file has been changed and run callback once necessary

func Write

func Write(file string, content string, perm fs.FileMode) error

Write content on file

Types

type RequestCallback

type RequestCallback func(uri string) error

RequestCallback type

type WatchCallback

type WatchCallback func(path string, action string) error

WatchCallback type