Documentation
¶
Index ¶
- type ProjectStruct
- func ChooseProject() (project *ProjectStruct, err error)
- func CreateProject(dir string, url string, numSpaces int) (project *ProjectStruct, err error)
- func GetProject() (*ProjectStruct, error)
- func GetProjectFromPath(path string) (*ProjectStruct, error)
- func NewProject(path string) (project *ProjectStruct)
- type SpaceStruct
- func CreateSpaceFromUrl(project *ProjectStruct, url string, path string) (space *SpaceStruct, err error)
- func GetSpace() (*SpaceStruct, error)
- func GetSpaceFromPath(path string) (*SpaceStruct, error)
- func NewSpace(project *ProjectStruct, path string) *SpaceStruct
- func SwitchSpace() (space *SpaceStruct, err error)
- func (space *SpaceStruct) Duplicate() (newSpace *SpaceStruct, err error)
- func (space *SpaceStruct) GetProject() *ProjectStruct
- func (space *SpaceStruct) OpenVSCode() error
- func (space *SpaceStruct) Rename(arguments ...string) error
- func (space *SpaceStruct) Sleep() (err error)
- func (space *SpaceStruct) Wakeup() (err error)
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type ProjectStruct ¶
func ChooseProject ¶
func ChooseProject() (project *ProjectStruct, err error)
func CreateProject ¶
func CreateProject(dir string, url string, numSpaces int) (project *ProjectStruct, err error)
Create creates the Project directory, dotfile, sleeping clones, and the default clone in the spaces' working directory named after the repo's default branch. It returns a pointer to the Project object or an error
func GetProject ¶
func GetProject() (*ProjectStruct, error)
func GetProjectFromPath ¶
func GetProjectFromPath(path string) (*ProjectStruct, error)
func NewProject ¶
func NewProject(path string) (project *ProjectStruct)
func (*ProjectStruct) ChooseSpace ¶
func (project *ProjectStruct) ChooseSpace() (space *SpaceStruct, err error)
func (*ProjectStruct) WakeupSpace ¶
func (project *ProjectStruct) WakeupSpace() (space *SpaceStruct, err error)
type SpaceStruct ¶
Gitspace is a struct that represents a git repository
func CreateSpaceFromUrl ¶
func CreateSpaceFromUrl(project *ProjectStruct, url string, path string) (space *SpaceStruct, err error)
func GetSpace ¶
func GetSpace() (*SpaceStruct, error)
func GetSpaceFromPath ¶
func GetSpaceFromPath(path string) (*SpaceStruct, error)
func NewSpace ¶
func NewSpace(project *ProjectStruct, path string) *SpaceStruct
NewSpace creates a new Space struct
func SwitchSpace ¶
func SwitchSpace() (space *SpaceStruct, err error)
func (*SpaceStruct) Duplicate ¶
func (space *SpaceStruct) Duplicate() (newSpace *SpaceStruct, err error)
func (*SpaceStruct) GetProject ¶
func (space *SpaceStruct) GetProject() *ProjectStruct
func (*SpaceStruct) OpenVSCode ¶
func (space *SpaceStruct) OpenVSCode() error
func (*SpaceStruct) Rename ¶
func (space *SpaceStruct) Rename(arguments ...string) error
Rename renames the space. It takes a variadic parameter of type string, which represents the optional new name for the space. If successful, it returns nil. Otherwise, it returns an error.
func (*SpaceStruct) Sleep ¶
func (space *SpaceStruct) Sleep() (err error)
func (*SpaceStruct) Wakeup ¶
func (space *SpaceStruct) Wakeup() (err error)
Source Files
Click to show internal directories.
Click to hide internal directories.