fsutils

Documentation

Index

• Constants
• func AllRelativePathModes() []string
• func EvalSymlinks(path string) (string, error)
• func GetBasePath(ctx context.Context, mode, cfgDir string) (string, error)
• func Getwd() (string, error)
• func IsDir(filename string) bool
• func NormalizePathInRegex(path string) string
• func PrettifyBytesCount(n int64) string
• func ShortestRelPath(path, wd string) (string, error)
• func UseWdCache(use bool)
• type FileCache
  • func NewFileCache() *FileCache
  • func (fc *FileCache) GetFileBytes(filePath string) ([]byte, error)
  • func (fc *FileCache) PrintStats(log logutils.Log)
• type LineCache
  • func NewLineCache(fc *FileCache) *LineCache
  • func (lc *LineCache) GetLine(filePath string, index1 int) (string, error)

Constants

const (
	RelativePathModeGoMod   = "gomod"
	RelativePathModeGitRoot = "gitroot"
	RelativePathModeCfg     = "cfg"
	RelativePathModeWd      = "wd"
)

Relative path modes.

const OutputPathModeAbsolute = "abs"

OutputPathModeAbsolute path mode used to show absolute paths in output reports (user-facing).

Functions

func AllRelativePathModes

func AllRelativePathModes() []string

func EvalSymlinks

func EvalSymlinks(path string) (string, error)

func GetBasePath

func GetBasePath(ctx context.Context, mode, cfgDir string) (string, error)

func Getwd

func Getwd() (string, error)

func IsDir

func IsDir(filename string) bool

func NormalizePathInRegex

func NormalizePathInRegex(path string) string

NormalizePathInRegex it's a noop function on Unix.

func PrettifyBytesCount

func PrettifyBytesCount(n int64) string

func ShortestRelPath

func ShortestRelPath(path, wd string) (string, error)

func UseWdCache

func UseWdCache(use bool)

Types

type FileCache

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

func NewFileCache

func NewFileCache() *FileCache

func (*FileCache) GetFileBytes

func (fc *FileCache) GetFileBytes(filePath string) ([]byte, error)

func (*FileCache) PrintStats

func (fc *FileCache) PrintStats(log logutils.Log)

type LineCache

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

func NewLineCache

func NewLineCache(fc *FileCache) *LineCache

func (*LineCache) GetLine

func (lc *LineCache) GetLine(filePath string, index1 int) (string, error)

GetLine returns the index1-th (1-based index) line from the file on filePath