project

Documentation

Overview

////////////////////////////////////////////////////////////////////////////// //////// Maintains a list of projects visited by the user. /////////////////// //////// Author: drellem Date: 2022-10-15 /////////////////// //////////////////////////////////////////////////////////////////////////////

Index

• Variables
• func Add(p *Project)
• func AddAll(ps []Project)
• func Init()
• func RemoveSaveFile()
• func SaveProjects()
• func Visit(req VisitRequest) (*VisitResponse, *ErrorResponse)
• type ErrorResponse
• type Project
  • func Projects() []Project
• type ProjectsSave
• type VisitRequest
• type VisitResponse

Variables

var ProjectFileName string

Functions

func Add

func Add(p *Project)

func AddAll

func AddAll(ps []Project)

func Init

func Init()

func RemoveSaveFile

func RemoveSaveFile()

func SaveProjects

func SaveProjects()

func Visit

func Visit(req VisitRequest) (*VisitResponse, *ErrorResponse)

If the path is within an existing project, returns the project. Otherwise traverses parent directories and creates a project if one is found.

Types

type ErrorResponse

type ErrorResponse struct {
	Code    int
	Message string `json:"errorString"`
}

type Project

type Project struct {
	Id   int    `json:"id"`
	Path string `json:"path"`
}

func Projects

func Projects() []Project

type ProjectsSave

type ProjectsSave struct {
	Projects []Project `json:"projects"`
}

type VisitRequest

type VisitRequest struct {
	Path string `json:"path"`
}

type VisitResponse

type VisitResponse struct {
	ParentProject Project `json:"project"`
}