owl

package module

v0.1.4 Latest Latest Go to latest Published: Jul 31, 2022 License: MIT Imports: 14 Imported by: 1

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

README ¶

Owl

Owl is a Go library to create project generators for any framework or language. This is a personal project that you can use. There is no warranty if you have an error or bug publish an issue or make a pull request to improve this library.

Features

Owl is a template based library, what it means? It copy a template and then run init scripts that resides in that template.

Config file can be writed in json, yaml, toml thanks to Viper
Copy a local template
Run preconfigured template scripts
Copy a remote template
Ignore specific files with .owlignore file

Installation

go get -u github.com/4strodev/owl@latest

Visit docs

owl-docs

Thanks to

@spf13

Documentation ¶

Index ¶

Constants
type Project
- func NewProject(projectConfig ProjectConfig, templateConfig template.TemplateConfig) *Project
type ProjectConfig

Constants ¶

View Source

const (
	// Permission MODES
	DIR_MODE  int = 0755
	FILE_MODE int = 0755

	// FS errors
	DIR_EXISTS          string = "Directory exists"
	TEMPLATE_NOT_PASSED string = "No template passed"
	TEMPLATE_NOT_FOUND  string = "No template found"

	CONFIG_FILE_NAME string = "owl_config"
)

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Project ¶

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

Contains the config the fs api and template info

func NewProject ¶

func NewProject(projectConfig ProjectConfig, templateConfig template.TemplateConfig) *Project

Generates a new projects giving the project config and and a template config

func (*Project) Create ¶

func (self *Project) Create() error

Create the instantiated project

func (*Project) CreateRootFolder ¶

func (self *Project) CreateRootFolder(path string) error

Create the root folder of the project

func (Project) MountTemplate ¶ added in v0.1.4

func (self Project) MountTemplate()

type ProjectConfig ¶

type ProjectConfig struct {
	Name               string
	TemplateName       string
	LocalTemplatesDirs []string
	VerboseOutput      bool
	TempDir            string
	// contains filtered or unexported fields
}

Contains the project's config

Source Files ¶

View all Source files

project_creator.go

Directories ¶

Path	Synopsis
example_template
go-cli
git
internal
fs
template

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