# Functions
DirFromPath returns a Dir for the given path whether it exists or not.
ExistingDir returns a Dir object that represents an existing directory on disk.
ExistingFile returns a File object that represents an existing file on disk.
FileFromPath returns a File for the given path whether it exists or not.
FromDir returns a Project object from the given directory, whether it exists or not.
FSNodeFromFileInfo returns an FSNode for the given fs.FileInfo object in the parent directory.
NewDir returns a Dir object that represents a directory that does not exist yet.
NewFile returns a File object that represents a file that does not exist yet.
No description provided by the author
No description provided by the author
# Variables
ErrFailedToCreateDir is returned when we were unable to create a directory.
ErrFailedToCreateFile is returned when we were unable to create a file.
ErrFailedToMarshalManifest is returned when we were unable to marshal the manifest to JSON.
No description provided by the author
ErrFailedToReadPath is returned when we encountered a filesystem error while reading a path.
ErrFailedToUnmarshalManifest is returned when we were unable to unmarshal the manifest from JSON.
ErrInvalidIdentifier is returned when an identifier does not satisfy some constraint.
ErrRuleDirAlreadyExists is returned when a rule already exists.
No description provided by the author
ErrUnexpectedType is returned when we expected a directory and found a file or vice versa.
# Structs
Dir represents a directory on disk.
File represents a file on disk.
Manifest contains metadata about the custom rules project.
ManifestPush contains metadata about where this rule bundle should be pushed to.
Project represents a custom rules project directory.
RuleMetadata contains all of the rule metadata fields that are supported for custom rules.
RuleSpec represents an input file or directory and an expected output file.
# Interfaces
FSNode defines the base set of operations for both files and directories.