scaffold

package

v0.0.0-...-4de5188 Latest Latest Go to latest Published: Oct 14, 2022 License: MIT Imports: 5 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/jesseobrien/torque-cli

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
Variables
type ProjectFile
- func (p *ProjectFile) ScaffoldCustomTemplate(fs afero.Fs, customPath string, data any) error
- func (p *ProjectFile) ScaffoldTemplate(fs afero.Fs, data any) error
type ScaffoldConfig
type Scaffolder
- func NewScaffolder(config ScaffoldConfig) *Scaffolder
- func (s *Scaffolder) ScaffoldNewProject() error

Constants ¶

View Source

const (
	GITKEEP   = ".gitkeep"
	GITIGNORE = ".gitignore"

	ENVFILE        = ".env"
	DOCKERFILE     = "dockerfile"
	DOCKER_COMPOSE = "docker-compose"
	TORQUE_CONFIG  = "torque-config"
	MODD_CONFIG    = "modd-config"

	MAIN_FILE    = "main-file"
	HTTP_SERVICE = "http-service"
	CONTROLLER   = "controller"
)

Variables ¶

View Source

var ProjectFiles = map[string]ProjectFile{

	GITIGNORE: {".gitignore", ".gitignore"},
	GITKEEP:   {".gitkeep", "dist/.gitkeep"},

	ENVFILE:        {"config/env.example.go.tmpl", ".env.example"},
	DOCKERFILE:     {"config/Dockerfile.tmpl", "Dockerfile"},
	DOCKER_COMPOSE: {"config/docker-compose.yml.tmpl", "docker-compose.yml"},
	TORQUE_CONFIG:  {"config/torque.yml.tmpl", "torque.yml"},
	MODD_CONFIG:    {"config/modd.conf.tmpl", "modd.conf"},

	MAIN_FILE:    {"main/main.go.tmpl", "cmd/main/main.go"},
	HTTP_SERVICE: {"http/http.go.tmpl", "internal/http/http.go"},
	CONTROLLER:   {"http/controller.go.tmpl", "internal/http/app_controller.go"},
}

Functions ¶

This section is empty.

Types ¶

type ProjectFile ¶

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

func (*ProjectFile) ScaffoldCustomTemplate ¶

func (p *ProjectFile) ScaffoldCustomTemplate(fs afero.Fs, customPath string, data any) error

func (*ProjectFile) ScaffoldTemplate ¶

func (p *ProjectFile) ScaffoldTemplate(fs afero.Fs, data any) error

type ScaffoldConfig ¶

type ScaffoldConfig struct {
	// The filesystem to use
	FS afero.Fs

	// Application Name
	AppName string
	ModName string

	// Default controller name
	ControllerName string

	// Custom specified directory for the project files
	Path string

	ORM   bool
	AWS   bool
	Redis bool
}

type Scaffolder ¶

type Scaffolder struct {
	Config ScaffoldConfig
}

func NewScaffolder ¶

func NewScaffolder(config ScaffoldConfig) *Scaffolder

func (*Scaffolder) ScaffoldNewProject ¶

func (s *Scaffolder) ScaffoldNewProject() error

Source Files ¶

View all Source files

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