config

package
v0.4.1 Latest Latest
Warning

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

 Go to latest Published: Aug 6, 2023 License: MIT Imports: 10 Imported by: 0

Documentation

Overview

Example: 

import (
  "fmt"
  "github.com/jvzantvoort/goproj/config"
)

mainconfig := NewMainConfig()
fmt.Printf("home dir: %s", mainconfig.HomeDir)
fmt.Printf("project type config dir: %s", mainconfig.ConfigDir)

Package config provides configuration data globally used

Index

Constants

View Source 
const (
	SettingsFile string = "settings.json"
	RegistryFile string = "registry.json"
)

Variables

This section is empty.

Functions

func DefaultString added in v0.4.0 

func DefaultString(args ...string) string

func UserConfigUI added in v0.4.0 

func UserConfigUI(cfg *MainConfig)

Types

type MainConfig 

type MainConfig struct {
	ForceInit      bool
	HomeDir        string
	ArchiveDir     string
	ConfigDir      string
	TemplatesDir   string
	ConfigDirPerms int
	AppVersion     string     `json:"version"`
	UserConfig     UserConfig `json:"user"`
}

MainConfig configuration for goproj

func NewMainConfig 

func NewMainConfig() *MainConfig

NewMainConfig initialize a MainConfig and initialize it. 

mc := config.NewMainConfig()
fmt.Printf("config dir: %s\n", mc.ConfigDir)

func (MainConfig) ConfigFile added in v0.3.0 

func (m MainConfig) ConfigFile(name string) string

func (MainConfig) CreateDirs added in v0.3.0 

func (m MainConfig) CreateDirs()

CreateDirs create the main config dir

func (MainConfig) Fields added in v0.3.0 

func (m MainConfig) Fields() []string

func (*MainConfig) Get added in v0.3.0 

func (m *MainConfig) Get(name string) (string, error)

func (*MainConfig) GetArchiveDir added in v0.3.0 

func (m *MainConfig) GetArchiveDir() string

func (*MainConfig) GetConfigDir added in v0.3.0 

func (m *MainConfig) GetConfigDir() string

func (*MainConfig) GetHomeDir 

func (m *MainConfig) GetHomeDir() string

GetHomeDir get the user's homedir

func (*MainConfig) GetTemplatesDir added in v0.3.0 

func (m *MainConfig) GetTemplatesDir() string

func (*MainConfig) Init added in v0.3.0 

func (m *MainConfig) Init()

Init initialize the MainConfig struct

func (*MainConfig) Read added in v0.3.0 

func (m *MainConfig) Read(reader io.Reader) error

File handling

Read

func (*MainConfig) ReadFromFile added in v0.3.0 

func (m *MainConfig) ReadFromFile(name string) error

ReadFromFile

func (*MainConfig) ResetConfig added in v0.3.0 

func (m *MainConfig) ResetConfig()

func (MainConfig) Save added in v0.3.0 

func (m MainConfig) Save()

func (MainConfig) Write added in v0.3.0 

func (m MainConfig) Write(writer io.Writer) error

Write

func (MainConfig) WriteToFile added in v0.3.0 

func (m MainConfig) WriteToFile(name string) error

WriteToFile

type UserConfig added in v0.3.0 

type UserConfig struct {
	MailAddress string `json:"mailaddress"`
	Company     string `json:"company"`
	Copyright   string `json:"copyright"`
	License     string `json:"license"`
	User        string `json:"user"`
	Username    string `json:"username"`
}

func (*UserConfig) SetCompany added in v0.4.0 

func (u *UserConfig) SetCompany(args ...string) error

func (*UserConfig) SetCopyright added in v0.4.0 

func (u *UserConfig) SetCopyright(args ...string) error

func (*UserConfig) SetLicense added in v0.4.0 

func (u *UserConfig) SetLicense(args ...string) error

func (*UserConfig) SetMailAddress added in v0.4.0 

func (u *UserConfig) SetMailAddress(args ...string) error

func (*UserConfig) SetUser added in v0.4.0 

func (u *UserConfig) SetUser(args ...string) error

func (*UserConfig) SetUsername added in v0.4.0 

func (u *UserConfig) SetUsername(args ...string) error

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.
JackTT - Gopher 🇻🇳