models

Documentation

Index

• Constants
• type Document
  • func NewDocument(name, filename, templatePath string, constructor any, isTemplate bool, ...) *Document
  • func (t *Document) FullDocPath() string
  • func (t *Document) FullFilePath() string
• type Folder
  • func NewFolder(name string, perm ...uint32) *Folder
• type GlobalConfig
  • func NewGlobalConfig(author, prefix string, skip []string, initGit, initVSCode bool) *GlobalConfig
  • func (g *GlobalConfig) Show()
  • func (g *GlobalConfig) ShowString() string
  • func (g *GlobalConfig) ValidatePrefix()
• type ProjectInfo
  • func NewProjectInfo(setup *Setup) *ProjectInfo
  • func (p *ProjectInfo) AddDocuments(templates ...*Document)
  • func (p *ProjectInfo) AddFolders(folders ...*Folder)
  • func (p *ProjectInfo) GetMainFolder() *Folder
• type Setup
  • func NewSetup(packageName, author, description string, skip []string, ...) *Setup
  • func NewSetupFromConfig(conf *GlobalConfig) *Setup
  • func (s *Setup) FilesToSkip() []string
  • func (s *Setup) FoldersToSkip() []string
  • func (s *Setup) Show()
  • func (s *Setup) ShowString() string
  • func (s *Setup) Update(from *Setup)
  • func (s *Setup) ValidatePackageName(prefix string)
• type Survey
  • func (s *Survey) ToGlobalConfig() *GlobalConfig
  • func (s *Survey) ToSetup() *Setup

Examples

• GlobalConfig.Show
• Setup.Show

Constants

const (
	TEMPLATE_PATH        = "./templates"
	FILE_TO_MOVE_PATH    = "./templates/files"
	LOCALRUN_RESULT_PATH = "./tests/tempFiles"

	GITIGNORE_FILE    = ".gitignore"
	DOCKERIGNORE_FILE = ".dockerignore"
	MAIN_GO_FILE      = "main.go"
	MAKEFILE          = "Makefile"
	ENVFILE           = ".env"
)

const (
	FromCli = iota + 1
	FromConfig
	FromSurvey
)

const FILEMODE fs.FileMode = 0755

Types

type Document

type Document struct {
	DataToAdd    []string
	Constructor  any
	Data         any
	Name         string
	TemplatePath string
	Filename     string
	Filepath     string
	IsTemplate   bool
}

func NewDocument

func NewDocument(name, filename, templatePath string, constructor any, isTemplate bool, dataToAdd []string) *Document

func (*Document) FullDocPath

func (t *Document) FullDocPath() string

FullDocPath return the full path with the document name.

func (*Document) FullFilePath

func (t *Document) FullFilePath() string

FullFilePath returns the full path with the result file name.

type Folder

type Folder struct {
	Name        string
	Permissions fs.FileMode
}

func NewFolder

func NewFolder(name string, perm ...uint32) *Folder

type GlobalConfig

type GlobalConfig struct {
	Skip       []string `yaml:"skip" json:"skip" toml:"skip"`
	Author     string   `yaml:"author" json:"author" toml:"author"`
	Prefix     string   `yaml:"prefix" json:"prefix" toml:"prefix"`
	InitGit    bool     `yaml:"git" json:"git" toml:"git"`
	InitVSCode bool     `yaml:"vscode" json:"vscode" toml:"vscode"`
}

func NewGlobalConfig

func NewGlobalConfig(author, prefix string, skip []string, initGit, initVSCode bool) *GlobalConfig

func (*GlobalConfig) Show

func (g *GlobalConfig) Show()

Show writes GlobalConfig info to standart output.

Example

conf := getTestGlobalConfig()
conf.Show()

func (*GlobalConfig) ShowString

func (g *GlobalConfig) ShowString() string

ShowString returns output string for GlobalConfig.

func (*GlobalConfig) ValidatePrefix

func (g *GlobalConfig) ValidatePrefix()

type ProjectInfo

type ProjectInfo struct {
	EmbedFiles        embed.FS
	Documents         []*Document
	Folders           []*Folder
	FilesToGenerate   map[string]*Document
	FilesToSkip       []string
	FoldersToSkip     []string
	PackageName       string
	MainFolder        string
	Author            string
	Description       string
	Path              string
	InitGit           bool
	InitVSCode        bool
	GenerateNewFolder bool
}

ProjectInfo contains all information about the new project to create.

func NewProjectInfo

func NewProjectInfo(setup *Setup) *ProjectInfo

NewProjectInfo constructs a ProjectInfo

func (*ProjectInfo) AddDocuments

func (p *ProjectInfo) AddDocuments(templates ...*Document)

AddDocuments appneds Documents to ProjectInfo Documents field.

func (*ProjectInfo) AddFolders

func (p *ProjectInfo) AddFolders(folders ...*Folder)

AddFolders appneds Folder to ProjectInfo Folders field.

func (*ProjectInfo) GetMainFolder

func (p *ProjectInfo) GetMainFolder() *Folder

type Setup

type Setup struct {
	Skip              []string
	PackageName       string
	MainFolder        string
	Author            string
	Description       string
	From              int
	InitGit           bool
	InitVSCode        bool
	IsSetInitGit      bool
	IsSetInitVSCode   bool
	GenerateNewFolder bool
}

func NewSetup

func NewSetup(
	packageName,
	author,
	description string,
	skip []string,
	initGit,
	initVSCode,
	isSetInitGit,
	isSetInitVSCode bool,
	from int,
	generateInFolder bool,
) *Setup

NewSetup constructs Setup by fields.

func NewSetupFromConfig

func NewSetupFromConfig(conf *GlobalConfig) *Setup

NewSetupFromConfig costructs Setup from ConfigFromFile.

func (*Setup) FilesToSkip

func (s *Setup) FilesToSkip() []string

FilesToSkip gets files from skip objects.

func (*Setup) FoldersToSkip

func (s *Setup) FoldersToSkip() []string

FoldersToSkip gets folders from skip objects.

func (*Setup) Show

func (s *Setup) Show()

Show writes Setup info to standart output.

Example

setup := getTestSetup(true)
setup.Show()

func (*Setup) ShowString

func (s *Setup) ShowString() string

ShowString returns output string for Setup.

func (*Setup) Update

func (s *Setup) Update(from *Setup)

Update updates Setup fields by another Setup

func (*Setup) ValidatePackageName

func (s *Setup) ValidatePackageName(prefix string)

ValidatePackageName adds prefix from global config

type Survey

type Survey struct {
	Skip        []string
	PackageName string
	Author      string
	Description string
	Prefix      string
	InitGit     bool
	InitVSCode  bool
}

func (*Survey) ToGlobalConfig

func (s *Survey) ToGlobalConfig() *GlobalConfig

func (*Survey) ToSetup

func (s *Survey) ToSetup() *Setup