config

package

v0.0.1 Latest Latest Go to latest Published: Jun 28, 2019 License: Apache-2.0 Imports: 6 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/hinshun/kit

Links

Open Source Insights

Documentation ¶

Index ¶

Variables
type Arg
type Config
- func New(path string) (*Config, error)
type Flag
type Manifest
type ManifestType
type Namespace
type Platform
type Plugin
- func (p Plugin) FindParent(commandPath []string) Plugin
type Plugins

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	InitConfig = Config{
		Plugins: Plugins{
			{
				Name:     "init",
				Manifest: "/kit/init",
			},
		},
	}

	BootstrapConfig = Config{
		Plugins: Plugins{
			{
				Name:     "plugin",
				Manifest: "/kit/plugin",
			},
		},
	}
)

Functions ¶

This section is empty.

Types ¶

type Arg ¶

type Arg struct {
	Type  string `json:"type"`
	Usage string `json:"usage"`
}

type Config ¶

type Config struct {
	Manifest string  `json:"manifest,omitempty"`
	Plugins  Plugins `json:"plugins,omitempty"`
}

Config

func New ¶

func New(path string) (*Config, error)

type Flag ¶

type Flag struct {
	Name  string `json:"name"`
	Type  string `json:"type"`
	Usage string `json:"usage"`
}

type Manifest ¶

type Manifest struct {
	Revision string       `json:"revision"`
	Usage    string       `json:"usage"`
	Type     ManifestType `json:"type"`

	// Namespace only fields.
	Plugins Plugins `json:"plugins,omitempty"`

	// Command only fields.
	Platforms []Platform `json:"platforms,omitempty"`
	Args      []Arg      `json:"args,omitempty"`
	Flags     []Flag     `json:"flags,omitempty"`
}

type ManifestType ¶

type ManifestType string

var (
	CommandManifest   ManifestType = "command"
	NamespaceManifest ManifestType = "namespace"
)

type Namespace ¶

type Namespace struct {
	Plugins Plugins `json:"plugins,omitempty"`
}

type Platform ¶

type Platform struct {
	OS           string `json:"os"`
	Architecture string `json:"architecture"`
	Digest       string `json:"digest"`
}

type Plugin ¶

type Plugin struct {
	Name     string  `json:"name"`
	Usage    string  `json:"usage,omitempty"`
	Manifest string  `json:"manifest,omitempty"`
	Plugins  Plugins `json:"plugins,omitempty"`
}

func (Plugin) FindParent ¶

func (p Plugin) FindParent(commandPath []string) Plugin

type Plugins ¶

type Plugins []Plugin

func (Plugins) Merge ¶

func (p Plugins) Merge(plugins Plugins) Plugins

func (Plugins) Print ¶

func (p Plugins) Print()

func (Plugins) Sort ¶

func (p Plugins) Sort()

Sort lexicographically sort plugins by name to produce a deterministic config.

Source Files ¶

View all Source files

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