fs

package

v0.0.0-...-c692de5 Latest Latest Go to latest Published: Apr 8, 2021 License: MIT Imports: 6 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

This section is empty.

This section is empty.

type KitFs struct {
	Fs afero.Fs
}

KitFs wraps an afero.Fs

func Get() *KitFs

Get returns a new KitFs if it was not initiated before or it returns the existing defaultFs if it is initiated.

func NewDefaultFs(dir string) *KitFs

NewDefaultFs creates a KitFs with `dir` as root.

func (f *KitFs) Exists(path string) (bool, error)

Exists returns true,nil if the dir/file exists or false,nil if the dir/file does not exist, it will return an error if something went wrong.

func (f *KitFs) Mkdir(dir string) error

Mkdir creates a directory.

func (f *KitFs) MkdirAll(path string) error

MkdirAll creates a directory and its parents if they don't exist.

func (f *KitFs) ReadFile(path string) (string, error)

ReadFile reads the file from `path` and returns the content in string format or returns an error if it occurs.

func (f *KitFs) WriteFile(path string, data string, force bool) error

WriteFile writs a file to the `path` with `data` as content, if `force` is set to true it will override the file if it already exists.