artifact

package

v1.0.18 Latest Latest Go to latest Published: Jun 16, 2024 License: Apache-2.0 Imports: 24 Imported by: 0

Details

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

Repository

github.com/kcmvp/gob

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
func GoPath() string
func HookScripts() map[string]string
func InGit() bool
func LatestVersion(log bool, modules ...string) []lo.Tuple2[string, string]
func NewProgress() *progressbar.ProgressBar
func PtyCmdOutput(cmd *exec.Cmd, task string, file bool, formatter consoleFormatter) error
func Version() string
func Windows() bool
type Execution
type GitHook
type Plugin
- func NewPlugin(url string) (Plugin, error)
type Project
- func CurProject() *Project

Constants ¶

View Source

const (

	//hook script name
	CommitMsg = "commit-msg"
	PreCommit = "pre-commit"
	PrePush   = "pre-push"
)

Variables ¶

This section is empty.

Functions ¶

func GoPath ¶

func GoPath() string

func HookScripts ¶

func HookScripts() map[string]string

func InGit ¶

func InGit() bool

func LatestVersion ¶ added in v1.0.16

func LatestVersion(log bool, modules ...string) []lo.Tuple2[string, string]

func NewProgress ¶

func NewProgress() *progressbar.ProgressBar

func PtyCmdOutput ¶ added in v1.0.18

func PtyCmdOutput(cmd *exec.Cmd, task string, file bool, formatter consoleFormatter) error

func Version ¶

func Version() string

func Windows ¶

func Windows() bool

Windows return true when current os is Windows

Types ¶

type Execution ¶

type Execution struct {
	CmdKey  string
	Actions []string
}

type GitHook ¶

type GitHook struct {
	CommitMsg string   `mapstructure:"commit-msg"`
	PreCommit []string `mapstructure:"pre-commit"`
	PrePush   []string `mapstructure:"pre-push"`
}

type Plugin ¶

type Plugin struct {
	Alias       string `json:"alias" mapstructure:"alias"`
	Args        string `json:"args" mapstructure:"args"`
	Url         string `json:"url" mapstructure:"url"` //nolint
	Config      string `json:"load" mapstructure:"load"`
	Description string `json:"description" mapstructure:"description"`
	// contains filtered or unexported fields
}

func NewPlugin ¶

func NewPlugin(url string) (Plugin, error)

func (Plugin) Binary ¶

func (plugin Plugin) Binary() string

func (Plugin) Execute ¶

func (plugin Plugin) Execute() error

func (Plugin) Module ¶

func (plugin Plugin) Module() string

func (Plugin) Name ¶

func (plugin Plugin) Name() string

func (*Plugin) UnmarshalJSON ¶

func (plugin *Plugin) UnmarshalJSON(data []byte) error

func (Plugin) Version ¶

func (plugin Plugin) Version() string

type Project ¶

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

func CurProject ¶

func CurProject() *Project

CurProject return Project struct

func (*Project) CacheDir ¶ added in v1.0.18

func (project *Project) CacheDir() string

func (*Project) Dependencies ¶ added in v1.0.15

func (project *Project) Dependencies() []*modfile.Require

func (*Project) Executions ¶

func (project *Project) Executions() []Execution

func (*Project) GitHook ¶

func (project *Project) GitHook() GitHook

func (*Project) HookDir ¶

func (project *Project) HookDir() string

func (*Project) InstallDependency ¶ added in v1.0.15

func (project *Project) InstallDependency(dep string) error

func (*Project) InstallPlugin ¶ added in v1.0.15

func (project *Project) InstallPlugin(plugin Plugin) error

func (*Project) MainFiles ¶

func (project *Project) MainFiles() []string

func (*Project) Module ¶

func (project *Project) Module() string

Module return current project module name

func (*Project) Plugins ¶

func (project *Project) Plugins() []Plugin

func (*Project) Root ¶

func (project *Project) Root() string

Root return root dir of the project

func (*Project) SetupHooks ¶

func (project *Project) SetupHooks(force bool) error

SetupHooks setup git local hooks for project. force means always update gob.yaml

func (*Project) Target ¶

func (project *Project) Target() string

func (*Project) Validate ¶

func (project *Project) Validate() error

Source Files ¶

View all Source files

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