boilr

package

v0.0.0-...-bc2bdbf Latest Latest Go to latest Published: Oct 2, 2021 License: Apache-2.0 Imports: 8 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/6uhrmittag/boilr

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
Variables
func IsTemplateDirInitialized() (bool, error)
func TemplatePath(name string) (string, error)
func TemplateTempPath(name string) (string, error)

Constants ¶

View Source

const (
	// AppName of the application
	AppName = "boilr"

	// Version of the application
	Version = "958a5f4"

	// ConfigDirPath is the configuration directory of the application
	ConfigDirPath = ".config/boilr"

	// ConfigFileName is the configuration file name of the application
	ConfigFileName = "config.json"

	// TemplateDir is the directory that contains the template registry
	TemplateDir = "templates"

	// TemplateTempDir is the directory that is used for temporary storage
	TemplateTempDir = "../tmp"

	// ContextFileName is the name of the file that contains the context values for the template
	ContextFileName = "project.json"

	// TemplateDirName is the name of the directory that contains the template files in a boilr template
	TemplateDirName = "template"

	// TemplateMetadataName is the name of the file that contains the metadata about the template saved in registry
	TemplateMetadataName = "__metadata.json"

	// GithubOwner is the owner of the github repository
	GithubOwner = "6uhrmittag"

	// GithubRepo is the name of the github repository
	GithubRepo = "6uhrmittag"
)

Variables ¶

View Source

var Configuration = struct {
	FilePath        string
	ConfigDirPath   string
	TemplateDirPath string
}{}

Configuration contains the values for needed for boilr to operate. These values can be overridden by the inclusion of a boilr.json file in the configuration directory.

View Source

var (
	// ErrTemplateAlreadyExists indicates that a template is already present in the local registry.
	ErrTemplateAlreadyExists = errors.New("boilr: project template already exists")
)

Functions ¶

func IsTemplateDirInitialized ¶

func IsTemplateDirInitialized() (bool, error)

IsTemplateDirInitialized Checks if template directory is initialized

func TemplatePath ¶

func TemplatePath(name string) (string, error)

TemplatePath returns the absolute path of a template given the name of the template.

func TemplateTempPath ¶

func TemplateTempPath(name string) (string, error)

TemplateTempPath returns absolute path of template temporary directory given name of template.

Types ¶

This section is empty.

Source Files ¶

View all Source files

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