cmdstate

Documentation

Index

• Constants
• func TestingHome(t *testing.T) string
• type File
  • func (f File[T]) Path() (string, error)
  • func (f File[T]) Read() (v T, err error)
  • func (f File[T]) Write(t T) error

Constants

const DefaultDir = "~/.atlas"

DefaultDir is the directory where CLI state is stored.

Functions

func TestingHome

func TestingHome(t *testing.T) string

TestingHome is a helper function for testing that sets the HOME directory to a temporary directory.

Types

type File

type File[T any] struct {
	// Dir where the file is stored. If empty, DefaultDir is used.
	Dir string
	// Name of the file. Suffixed with .json.
	Name string
}

File is a state file for the given type.

func (File[T]) Path

func (f File[T]) Path() (string, error)

Path returns the path to the file.

func (File[T]) Read

func (f File[T]) Read() (v T, err error)

Read reads the value from the file system.

func (File[T]) Write

func (f File[T]) Write(t T) error

Write writes the value to the file system.