projectid

Documentation

Index

• Constants
• Variables
• func Pwd() string
• type FlutterProject
  • func (p *FlutterProject) GetVersion() (*version.Version, error)
  • func (p *FlutterProject) ID() ProjectID
  • func (p *FlutterProject) IsMe(workdir string) bool
  • func (p *FlutterProject) SetVersion(v *version.Version) error
  • func (p *FlutterProject) WorkDir() string
• type GoProject
  • func (p *GoProject) GetVersion() (*version.Version, error)
  • func (p *GoProject) ID() ProjectID
  • func (p *GoProject) IsMe(workdir string) bool
  • func (p *GoProject) SetVersion(v *version.Version) error
  • func (p *GoProject) WorkDir() string
• type MixProject
  • func (p *MixProject) GetVersion() (*version.Version, error)
  • func (p *MixProject) ID() ProjectID
  • func (p *MixProject) IsMe(workdir string) bool
  • func (p *MixProject) SetVersion(v *version.Version) error
  • func (p *MixProject) WorkDir() string
• type NodeProject
  • func (p *NodeProject) GetVersion() (*version.Version, error)
  • func (p *NodeProject) ID() ProjectID
  • func (p *NodeProject) IsMe(workdir string) bool
  • func (p *NodeProject) SetVersion(v *version.Version) error
  • func (p *NodeProject) WorkDir() string
• type Project
• type ProjectID
  • func ParseProjectID(s string) ProjectID
  • func Which(workdir string) ProjectID
  • func (p ProjectID) Project(workdir string) Project
  • func (p ProjectID) String() string
• type PythonProject
  • func (p *PythonProject) GetVersion() (*version.Version, error)
  • func (p *PythonProject) ID() ProjectID
  • func (p *PythonProject) IsMe(workdir string) bool
  • func (p *PythonProject) SetVersion(v *version.Version) error
  • func (p *PythonProject) WorkDir() string
• type RustProject
  • func (p *RustProject) GetVersion() (*version.Version, error)
  • func (p *RustProject) ID() ProjectID
  • func (p *RustProject) IsMe(workdir string) bool
  • func (p *RustProject) SetVersion(v *version.Version) error
  • func (p *RustProject) WorkDir() string

Constants

const (
	Mix = ProjectID(iota + 10)
	Python
	Go
	Node
	Flutter
	Rust
	MaxProjectID
)

Variables

var RustVersionRE = regexp.MustCompile(`(?m)^\s*version\s*=\s*"(.+)"`)

Functions

func Pwd

func Pwd() string

Pwd returns the current working directory

Types

type FlutterProject

type FlutterProject struct {
	// contains filtered or unexported fields
}

func (*FlutterProject) GetVersion

func (p *FlutterProject) GetVersion() (*version.Version, error)

func (*FlutterProject) ID

func (p *FlutterProject) ID() ProjectID

func (*FlutterProject) IsMe

func (p *FlutterProject) IsMe(workdir string) bool

func (*FlutterProject) SetVersion

func (p *FlutterProject) SetVersion(v *version.Version) error

func (*FlutterProject) WorkDir

func (p *FlutterProject) WorkDir() string

type GoProject

type GoProject struct {
	// contains filtered or unexported fields
}

GoProject represents a Go project with versioning capabilities Because Go projects do not have a standard version file, we flow the rules below:

• lookup the project by checking the existence of "version.txt"
• this file can be embedded to a go variable use `go:embed` directive
• the file content should be like `x.y.z`

func (*GoProject) GetVersion

func (p *GoProject) GetVersion() (*version.Version, error)

func (*GoProject) ID

func (p *GoProject) ID() ProjectID

func (*GoProject) IsMe

func (p *GoProject) IsMe(workdir string) bool

func (*GoProject) SetVersion

func (p *GoProject) SetVersion(v *version.Version) error

func (*GoProject) WorkDir

func (p *GoProject) WorkDir() string

type MixProject

type MixProject struct {
	// contains filtered or unexported fields
}

func (*MixProject) GetVersion

func (p *MixProject) GetVersion() (*version.Version, error)

func (*MixProject) ID

func (p *MixProject) ID() ProjectID

func (*MixProject) IsMe

func (p *MixProject) IsMe(workdir string) bool

func (*MixProject) SetVersion

func (p *MixProject) SetVersion(v *version.Version) error

func (*MixProject) WorkDir

func (p *MixProject) WorkDir() string

type NodeProject

type NodeProject struct {
	// contains filtered or unexported fields
}

func (*NodeProject) GetVersion

func (p *NodeProject) GetVersion() (*version.Version, error)

func (*NodeProject) ID

func (p *NodeProject) ID() ProjectID

func (*NodeProject) IsMe

func (p *NodeProject) IsMe(workdir string) bool

func (*NodeProject) SetVersion

func (p *NodeProject) SetVersion(v *version.Version) error

func (*NodeProject) WorkDir

func (p *NodeProject) WorkDir() string

type Project

type Project interface {
	// Test if the project is of the specified type
	IsMe(workdir string) bool
	// Get the project ID
	ID() ProjectID
	// Get the working directory of the project
	WorkDir() string
	// Get the current version of the project
	GetVersion() (*version.Version, error)
	// Set a new version for the project
	SetVersion(v *version.Version) error
}

Project represents a generic project with versioning capabilities

type ProjectID

type ProjectID int

func ParseProjectID

func ParseProjectID(s string) ProjectID

func Which

func Which(workdir string) ProjectID

Which returns the type of project in current directory

func (ProjectID) Project

func (p ProjectID) Project(workdir string) Project

func (ProjectID) String

func (p ProjectID) String() string

type PythonProject

type PythonProject struct {
	// contains filtered or unexported fields
}

func (*PythonProject) GetVersion

func (p *PythonProject) GetVersion() (*version.Version, error)

func (*PythonProject) ID

func (p *PythonProject) ID() ProjectID

func (*PythonProject) IsMe

func (p *PythonProject) IsMe(workdir string) bool

func (*PythonProject) SetVersion

func (p *PythonProject) SetVersion(v *version.Version) error

func (*PythonProject) WorkDir

func (p *PythonProject) WorkDir() string

type RustProject

type RustProject struct {
	// contains filtered or unexported fields
}

func (*RustProject) GetVersion

func (p *RustProject) GetVersion() (*version.Version, error)

func (*RustProject) ID

func (p *RustProject) ID() ProjectID

func (*RustProject) IsMe

func (p *RustProject) IsMe(workdir string) bool

func (*RustProject) SetVersion

func (p *RustProject) SetVersion(v *version.Version) error

func (*RustProject) WorkDir

func (p *RustProject) WorkDir() string