fs

Documentation

Index

• Variables
• type Fs
  • func NewFs(projectDirPath string) (*Fs, error)

Variables

var MockFs afero.Fs

MockFs is a mock, memory-based file system used during unit testing

Types

type Fs

type Fs struct {
	// Read-only view of working directory for Kosher (where the executable is)
	WorkingDir *afero.BasePathFs

	// Read-only view of project directory for Kosher
	ProjectDir *afero.BasePathFs

	// Config directory
	ConfigDir *afero.BasePathFs

	// Features directory
	FeaturesDir *afero.BasePathFs

	// Results directory
	ResultsDir *afero.BasePathFs

	// Macros directory
	MacrosDir *afero.BasePathFs

	// Resources directory
	ResourcesDir *afero.BasePathFs
}

Fs abstracts away the file system from the actual OS, and allows the file system to be mocked for testing.

func NewFs

func NewFs(projectDirPath string) (*Fs, error)

NewFs creates a new Fs with the OS file system as the Project directory