skeleton

package

v2.2.2 Latest Latest Go to latest Published: Jun 9, 2022 License: MIT Imports: 16 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/gostaticanalysis/skeleton

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
Variables
func Main(version string, args []string) int
type Checker
- func (ch *Checker) Set(s string) error
- func (ch Checker) String() string
type Generator
- func (g *Generator) Run(info *Info) (fs.FS, error)
type Info
type Kind
- func (k *Kind) Set(s string) error
- func (k Kind) String() string
type Prompt
type Skeleton
- func (s *Skeleton) Run(version string, args []string) int

Constants ¶

View Source

const (
	ExitSuccess = 0
	ExitError   = 1
)

Variables ¶

View Source

var DefaultFuncMap = skeletonkit.DefaultFuncMap

DefaultFuncMap is default FuncMap for a template. Deprecated: should use skeletonkit.TemplateWithFuncs

View Source

var DefaultPrompt = &Prompt{
	Input:     os.Stdin,
	Output:    os.Stdout,
	ErrOutput: os.Stderr,
}

DefaultPrompt is default Prompt.

View Source

var DefaultTemplate *template.Template

DefaultTemplate is default template for skeleton. Deprecated: should use skeletonkit.

Functions ¶

func Main ¶

func Main(version string, args []string) int

Types ¶

type Checker ¶

type Checker string

const (
	CheckerUnit   Checker = "unit"
	CheckerSingle Checker = "single"
	CheckerMulti  Checker = "multi"
)

func (*Checker) Set ¶

func (ch *Checker) Set(s string) error

func (Checker) String ¶

func (ch Checker) String() string

String returns "single", "multi" or "unit".

type Generator ¶

type Generator struct {
	Template *template.Template
}

func (*Generator) Run ¶

func (g *Generator) Run(info *Info) (fs.FS, error)

type Info ¶

type Info struct {
	Kind      Kind
	Checker   Checker
	Pkg       string
	Path      string
	Cmd       bool
	Plugin    bool
	GoMod     bool
	GoVersion string
}

type Kind ¶

type Kind string

Kind represents kind of skeleton codes. Kind implements flag.Value.

const (
	KindInspect  Kind = "inspect"
	KindSSA      Kind = "ssa"
	KindCodegen  Kind = "codegen"
	KindPackages Kind = "packages"
)

func (*Kind) Set ¶

func (k *Kind) Set(s string) error

"ssa" -> KindSSA, "codegen" -> KindCodegen, "packages" -> KindPackages otherwise KindInspect.

func (Kind) String ¶

func (k Kind) String() string

type Prompt ¶

type Prompt = skeletonkit.Prompt

Prompt receive input from a user.

type Skeleton ¶

type Skeleton struct {
	Dir       string
	Output    io.Writer
	ErrOutput io.Writer
	Input     io.Reader
	GoVersion string
}

func (*Skeleton) Run ¶

func (s *Skeleton) Run(version string, args []string) int

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
_template
packages/internal
internal
gomod

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