config

Documentation

Index

• Constants
• func BaseDir() string
• func LinkManPages() []error
• func ManDir() string
• func NewCoreManifest() (*model.Manifest, error)
• func NewManifest(name string) *model.Manifest
• func Parse(path string) (*model.Manifest, error)
• func SaveManifest(manifest *model.Manifest, backup bool) error
• func SaveSpaceport(s *model.Spaceport) error
• func SetVersion(v *version.Info)
• func UnlinkManPages() []error
• func WriteCompletion(sh, s string) error
• type Config
  • func LoadConfig() (*Config, error)
  • func NewConfig() (*Config, error)
  • func (c *Config) DeleteManifest(name string) error
  • func (c *Config) Exists() bool
  • func (c *Config) Get(key string) string
  • func (c *Config) Save() error
  • func (c *Config) Set(key, value string) error
  • func (c *Config) Spaceport() *model.Spaceport
  • func (c *Config) Sync(force, keep bool, sources []string) ([]*model.Manifest, error)

Constants

const (
	SystemPrefixDir       = "/usr/local"
	DefaultBaseDir        = "~/.nostromo"
	DefaultConfigFile     = "%s.yaml"
	DefaultManifestsDir   = "ships"
	DefaultBackupsDir     = "cargo"
	DefaultDownloadsDir   = "downloads"
	DefaultCompletionsDir = "completions"
	DefaultManDir         = "man"
)

Path for standard nostromo config

const (
	FileURLScheme = "file://"
)

URL scheme constants

Functions

func BaseDir

func BaseDir() string

BaseDir returns the base directory for nostromo files

func LinkManPages

func LinkManPages() []error

LinkManPages creates a symlink for man pages

func ManDir

func ManDir() string

ManDir returns the nostromo man dir

func NewCoreManifest

func NewCoreManifest() (*model.Manifest, error)

NewCoreManifest creates a new core manifest

func NewManifest

func NewManifest(name string) *model.Manifest

NewManifest creates a new manifest with provided name

func Parse

func Parse(path string) (*model.Manifest, error)

Parse nostromo config at path into a `Manifest` object

func SaveManifest

func SaveManifest(manifest *model.Manifest, backup bool) error

SaveManifest to nostromo config folder and backup optionally

func SaveSpaceport

func SaveSpaceport(s *model.Spaceport) error

SaveSpaceport to nostromo config folder

func SetVersion

func SetVersion(v *version.Info)

SetVersion should be called before any task to ensure manifest is updated

func UnlinkManPages

func UnlinkManPages() []error

UnlinkManPages from system man dir

func WriteCompletion

func WriteCompletion(sh, s string) error

WriteCompletion writes a file to the completions folder

Types

type Config

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

Config manages working with nostromo configuration files The file format is YAML this just provides convenience around converting to a manifest

func LoadConfig

func LoadConfig() (*Config, error)

func NewConfig

func NewConfig() (*Config, error)

NewConfig returns a new nostromo config

func (*Config) DeleteManifest

func (c *Config) DeleteManifest(name string) error

DeleteManifest from nostromo manfiests folder

func (*Config) Exists

func (c *Config) Exists() bool

Exists checks if nostromo config file exists

func (*Config) Get

func (c *Config) Get(key string) string

Get setting value from config

func (*Config) Save

func (c *Config) Save() error

Save nostromo config to file

func (*Config) Set

func (c *Config) Set(key, value string) error

Set setting value for key

func (*Config) Spaceport

func (c *Config) Spaceport() *model.Spaceport

Spaceport associated with this config

func (*Config) Sync

func (c *Config) Sync(force, keep bool, sources []string) ([]*model.Manifest, error)

Sync adds a new manifest from provided sources