filesystem

package
v2.932.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 17, 2026 License: AGPL-3.0 Imports: 4 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type File

type File interface {
	fs.File
	io.Writer
}

type FileSystem

type FileSystem interface {
	config.FS
	OpenFile(name string, flag int, perm fs.FileMode) (File, error)
	MkdirAll(path string, perm os.FileMode) error
	ReadDir(name string) ([]fs.DirEntry, error)
	Remove(name string) error

	// ScanForGeneratedIDs scans the output directory for files with @generated-id headers.
	// Returns a map of UUID -> relative file path.
	// This is used to detect when users have moved generated files.
	ScanForGeneratedIDs() (map[string]string, error)
}

FileSystem is the main file system abstraction used throughout the generator. This interface is implemented by the CLI and injected into the Generator. This needs to be located in pkg because it is used by the cli usagegen.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL