versioning

package
v0.0.9 Latest Latest
Warning

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

Go to latest
Published: Feb 25, 2026 License: MIT Imports: 7 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type PackageJSONVersionStore added in v0.0.5

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

PackageJSONVersionStore reads/writes the version field in package.json.

func NewPackageJSONVersionStore added in v0.0.5

func NewPackageJSONVersionStore(fs filesystem.FileSystem) *PackageJSONVersionStore

NewPackageJSONVersionStore creates a new store for Node projects.

func (*PackageJSONVersionStore) IsEnabled added in v0.0.5

func (p *PackageJSONVersionStore) IsEnabled(string) bool

IsEnabled always returns true for Node projects (no disable flag).

func (*PackageJSONVersionStore) Read added in v0.0.5

func (p *PackageJSONVersionStore) Read(projectRoot string) (*models.Version, error)

Read reads the version from package.json; missing or empty defaults to 0.0.0.

func (*PackageJSONVersionStore) Write added in v0.0.5

func (p *PackageJSONVersionStore) Write(projectRoot string, version *models.Version) error

Write writes the version to the version field in package.json without reformatting the file.

type VersionFile

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

VersionFile handles reading and writing version.txt files

func NewVersionFile

func NewVersionFile(fs filesystem.FileSystem) *VersionFile

NewVersionFile creates a new VersionFile instance

func (*VersionFile) IsEnabled

func (vf *VersionFile) IsEnabled(projectRoot string) bool

IsEnabled checks if a project is enabled for versioning Returns false if version.txt contains "false" (case-insensitive) Returns true if version.txt doesn't exist or contains a valid version

func (*VersionFile) Read

func (vf *VersionFile) Read(projectRoot string) (*models.Version, error)

Read reads the version from version.txt in the project root

func (*VersionFile) Write

func (vf *VersionFile) Write(projectRoot string, version *models.Version) error

Write writes the version to version.txt in the project root

type VersionStore

type VersionStore interface {
	Read(projectRoot string) (*models.Version, error)
	Write(projectRoot string, version *models.Version) error
	IsEnabled(projectRoot string) bool
}

VersionStore abstracts reading/writing project versions across project types.

func NewVersionStore

func NewVersionStore(fs filesystem.FileSystem, projectType models.ProjectType) VersionStore

NewVersionStore returns the appropriate store for the project type.

Jump to

Keyboard shortcuts

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