util

Documentation

Index

• func CombineOutputPath(outputPath, ns string) string
• func DownloadFile(remotePath, localPath string) error
• func Exists(path string) bool
• func FormatCode(code []byte) ([]byte, error)
• func GetGOPATH() (string, error)
• func IDLName(filename string) string
• func JoinPath(elem ...string) string
• func LowerFirst(s string) string
• func NotPtr(s string) string
• func PrintlImports(imports []Import) string
• func ReadInput() ([]byte, error)
• func ReplaceString(s, old, new string, n int) string
• func RunGitCommand(gitLink string) (string, string, error)
• func SearchGoMod(cwd string) (moduleName, path string, found bool)
• func SnakeString(s string) string
• func ToString(val interface{}) string
• func UpperFirst(s string) string
• type Import
  • func SortImports(imps map[string]string, localPrefix string) (ret []Import)
  • func (i Import) PackageName() string
• type StringSlice
  • func (ss *StringSlice) Set(value string) error
  • func (ss *StringSlice) String() string

Functions

func CombineOutputPath

func CombineOutputPath(outputPath, ns string) string

CombineOutputPath read the output and path variables and render them into the final path

func DownloadFile

func DownloadFile(remotePath, localPath string) error

DownloadFile Download file to local

func Exists

func Exists(path string) bool

Exists reports whether a file exists.

func FormatCode

func FormatCode(code []byte) ([]byte, error)

FormatCode formats go source codes.

func GetGOPATH

func GetGOPATH() (string, error)

GetGOPATH retrieves the GOPATH from environment variables or the `go env` command.

func IDLName

func IDLName(filename string) string

IDLName returns the name of the IDL file.

func JoinPath

func JoinPath(elem ...string) string

JoinPath joins dirs as golang import format, such as xx/xx/xx

func LowerFirst

func LowerFirst(s string) string

LowerFirst converts the first letter to upper case for the given string.

func NotPtr

func NotPtr(s string) string

NotPtr converts a pointer type into non-pointer type.

func PrintlImports

func PrintlImports(imports []Import) string

func ReadInput

func ReadInput() ([]byte, error)

ReadInput defaults to read from stdin. If `KITEX_TOOL_STDIN_LOAD_FILE` is a valid path, it reads from the specified file; If `KITEX_TOOL_STDIN_DUMP_FILE` is a valid path, it dumps what it read to the file; This feature makes it easier to debug kitex tool.

func ReplaceString

func ReplaceString(s, old, new string, n int) string

ReplaceString be used in string substitution.

func RunGitCommand

func RunGitCommand(gitLink string) (string, string, error)

func SearchGoMod

func SearchGoMod(cwd string) (moduleName, path string, found bool)

SearchGoMod searches go.mod from the given directory (which must be an absolute path) to the root directory. When the go.mod is found, its module name and path will be returned.

func SnakeString

func SnakeString(s string) string

SnakeString converts the string 's' to a snake string

func ToString

func ToString(val interface{}) string

func UpperFirst

func UpperFirst(s string) string

UpperFirst converts the first letter to upper case for the given string.

Types

type Import

type Import struct {
	Alias string
	Path  string
}

func SortImports

func SortImports(imps map[string]string, localPrefix string) (ret []Import)

func (Import) PackageName

func (i Import) PackageName() string

type StringSlice

type StringSlice []string

StringSlice implements the flag.Value interface on string slices to allow a flag to be set multiple times.

func (*StringSlice) Set

func (ss *StringSlice) Set(value string) error

Set implements the flag.Value interface.

func (*StringSlice) String

func (ss *StringSlice) String() string