config

Documentation

Overview

Package config contains the configuration structs for the GoKi tool.

Index

• Variables
• func ArchSupported(arch string) error
• func OSSupported(os string) error
• type Build
• type Colorgen
• type Config
• type Generate
• type Install
• type Log
• type Platform
  • func ParsePlatform(platform string) (Platform, error)
  • func (p Platform) String() string
• type Release
• type Types
  • func TypesValues() []Types
  • func (i Types) Desc() string
  • func (i Types) Int64() int64
  • func (i Types) IsValid() bool
  • func (i Types) MarshalText() ([]byte, error)
  • func (i *Types) SetInt64(in int64)
  • func (i *Types) SetString(s string) error
  • func (i Types) String() string
  • func (i *Types) UnmarshalText(text []byte) error
  • func (i Types) Values() []enums.Enum

Variables

var SupportedArch = map[string]bool{
	"386":         true,
	"amd64":       true,
	"amd64p32":    true,
	"arm":         true,
	"armbe":       true,
	"arm64":       true,
	"arm64be":     true,
	"loong64":     false,
	"mips":        false,
	"mipsle":      false,
	"mips64":      false,
	"mips64le":    false,
	"mips64p32":   false,
	"mips64p32le": false,
	"ppc":         false,
	"ppc64":       false,
	"ppc64le":     false,
	"riscv":       false,
	"riscv64":     false,
	"s390":        false,
	"s390x":       false,
	"sparc":       false,
	"sparc64":     false,
	"wasm":        false,
}

SupportedArch is a map containing all computer architectures and whether they are supported by GoKi.

var SupportedOS = map[string]bool{
	"aix":       false,
	"android":   true,
	"darwin":    true,
	"dragonfly": false,
	"freebsd":   false,
	"hurd":      false,
	"illumos":   false,
	"ios":       true,
	"js":        false,
	"linux":     true,
	"nacl":      false,
	"netbsd":    false,
	"openbsd":   false,
	"plan9":     false,
	"solaris":   false,
	"wasip1":    false,
	"windows":   true,
	"zos":       false,
}

SupportedOS is a map containing all operating systems and whether they are supported by GoKi.

Functions

func ArchSupported

func ArchSupported(arch string) error

ArchSupported determines whether the given architecture is supported by GoKi. If it is, it returns nil. If it isn't, it also returns an error detailing the issue with the architecture (not found or not supported).

func OSSupported

func OSSupported(os string) error

OSSupported determines whether the given operating system is supported by GoKi. If it is, it returns nil. If it isn't, it returns an error detailing the issue with the operating system (not found or not supported).

Types

type Build

type Build struct {

	// [def: .] the path of the package to build
	Package string `def:"." desc:"the path of the package to build"`

	// the target platforms to build executables for
	Target []Platform `desc:"the target platforms to build executables for"`

	// the output file name; if not specified, it depends on the package being built
	Output string `flag:"o,output" desc:"the output file name; if not specified, it depends on the package being built"`

	// force rebuilding of packages that are already up-to-date
	Rebuild bool `flag:"a,rebuild" desc:"force rebuilding of packages that are already up-to-date"`

	// install the generated executable
	Install bool `flag:"i,install" desc:"install the generated executable"`

	// print the commands but do not run them
	PrintOnly bool `flag:"n,print-only" desc:"print the commands but do not run them"`

	// print the commands
	Print bool `flag:"x,print" desc:"print the commands"`

	// arguments to pass on each go tool compile invocation
	GCFlags []string `desc:"arguments to pass on each go tool compile invocation"`

	// arguments to pass on each go tool link invocation
	LDFlags []string `desc:"arguments to pass on each go tool link invocation"`

	// a comma-separated list of additional build tags to consider satisfied during the build
	Tags []string `desc:"a comma-separated list of additional build tags to consider satisfied during the build"`

	// remove all file system paths from the resulting executable. Instead of absolute file system paths, the recorded file names will begin either a module path@version (when using modules), or a plain import path (when using the standard library, or GOPATH).
	Trimpath bool `` /* 260-byte string literal not displayed */

	// print the name of the temporary work directory and do not delete it when exiting
	Work bool `desc:"print the name of the temporary work directory and do not delete it when exiting"`

	// [def: 13.0] the minimal version of the iOS SDK to compile against
	IOSVersion string `def:"13.0" desc:"the minimal version of the iOS SDK to compile against"`

	// [def: 23] [min: 23] the minimum supported Android SDK (uses-sdk/android:minSdkVersion in AndroidManifest.xml)
	AndroidMinSDK int `def:"23" min:"23" desc:"the minimum supported Android SDK (uses-sdk/android:minSdkVersion in AndroidManifest.xml)"`

	// [def: 29] the target Android SDK version (uses-sdk/android:targetSdkVersion in AndroidManifest.xml)
	AndroidTargetSDK int `def:"29" desc:"the target Android SDK version (uses-sdk/android:targetSdkVersion in AndroidManifest.xml)"`

	// the bundle ID to use with the app (required for target iOS and N/A otherwise)
	BundleID string `desc:"the bundle ID to use with the app (required for target iOS and N/A otherwise)"`
}

type Colorgen

type Colorgen struct {

	// [def: colors.xml] the source file path to generate the color schemes from
	Source string `def:"colors.xml" desc:"the source file path to generate the color schemes from"`

	// [def: colorgen.go] the output file to store the resulting Go file in
	Output string `def:"colorgen.go" desc:"the output file to store the resulting Go file in"`

	// [def: main] the package in which the color schemes will be used
	Package string `def:"main" desc:"the package in which the color schemes will be used"`

	// the comment for the color schemes variable
	Comment string `desc:"the comment for the color schemes variable"`
}

type Config

type Config struct {

	// the name of the project
	Name string `desc:"the name of the project"`

	// the description of the project
	Desc string `desc:"the description of the project"`

	// [def: v0.0.0] the version of the project
	Version string `cmd:"set-version" posarg:"0" def:"v0.0.0" desc:"the version of the project"`

	// the type of the project (app/library)
	Type Types `desc:"the type of the project (app/library)"`

	// [view: add-fields] the configuration options for the build command
	Build Build `cmd:"build" view:"add-fields" desc:"the configuration options for the build command"`

	// [view: add-fields] the configuration options for the colorgen command
	Colorgen Colorgen `cmd:"colorgen" view:"add-fields" desc:"the configuration options for the colorgen command"`

	// [view: add-fields] the configuration options for the install command
	Install Install `cmd:"install" view:"add-fields" desc:"the configuration options for the install command"`

	// [view: add-fields] the configuration options for the log command
	Log Log `cmd:"log" view:"add-fields" desc:"the configuration options for the log command"`

	// [view: add-fields] the configuration options for the release command
	Release Release `cmd:"release" view:"add-fields" desc:"the configuration options for the release command"`

	// [view: add-fields] the configuration options for the generate command
	Generate Generate `cmd:"generate" view:"add-fields" desc:"the configuration options for the generate command"`
}

Config is the main config struct that contains all of the configuration options for the GoKi tool

type Generate

type Generate struct {

	// the enum generation configuration options passed to enumgen
	Enumgen enumgen.Config `desc:"the enum generation configuration options passed to enumgen"`

	// the generation configuration options passed to gtigen
	Gtigen gtigen.Config `desc:"the generation configuration options passed to gtigen"`

	// [def: .] the source directory to run generate on (can be multiple through ./...)
	Dir string `def:"." posarg:"0" required:"-" nest:"-" desc:"the source directory to run generate on (can be multiple through ./...)"`

	// [def: gokigen.go] the output file location relative to the package on which generate is being called
	Output string `def:"gokigen.go" desc:"the output file location relative to the package on which generate is being called"`

	// [def: true] whether to automatically add all types that implement the ki.Ki interface (should be set to false in packages without Ki types)
	AddKiTypes bool `` /* 145-byte string literal not displayed */
}

type Install

type Install struct {

	// [def: .] the name/path of the package to install
	Package string `def:"." desc:"the name/path of the package to install"`

	// the target platforms to install the executables on, as a list of operating systems (this should include no more than the operating system you are on, android, and ios)
	Target []string `` /* 174-byte string literal not displayed */
}

type Log

type Log struct {

	// [def: android] the target platform to view the logs for (ios or android)
	Target string `def:"android" desc:"the target platform to view the logs for (ios or android)"`

	// [def: false] whether to keep the previous log messages or clear them
	Keep bool `def:"false" desc:"whether to keep the previous log messages or clear them"`

	// [def: F] messages not generated from your app equal to or above this log level will be shown
	All string `def:"F" desc:"messages not generated from your app equal to or above this log level will be shown"`
}

type Platform

type Platform struct {
	OS   string
	Arch string
}

Platform is a platform with an operating system and an architecture

func ParsePlatform

func ParsePlatform(platform string) (Platform, error)

ParsePlatform parses the given platform string of format os[/arch]

func (Platform) String

func (p Platform) String() string

String returns the platform as a string in the form "os/arch"

type Release

type Release struct {

	// [def: version.go] the Go file to store version information in
	VersionFile string `def:"version.go" desc:"the Go file to store version information in"`

	// [def: main] the Go package in which the version file will be stored
	Package string `def:"main" desc:"the Go package in which the version file will be stored"`
}

type Types

type Types int //enums:enum -trim-prefix Type

Types is an enum with all of the possible types of packages.

const (
	// TypeApp is an executable app
	TypeApp Types = iota
	// TypeLibrary is an importable library
	TypeLibrary
)

const TypesN Types = 2

TypesN is the highest valid value for type Types, plus one.

func TypesValues

func TypesValues() []Types

TypesValues returns all possible values for the type Types.

func (Types) Desc

func (i Types) Desc() string

Desc returns the description of the Types value.

func (Types) Int64

func (i Types) Int64() int64

Int64 returns the Types value as an int64.

func (Types) IsValid

func (i Types) IsValid() bool

IsValid returns whether the value is a valid option for type Types.

func (Types) MarshalText

func (i Types) MarshalText() ([]byte, error)

MarshalText implements the encoding.TextMarshaler interface.

func (*Types) SetInt64

func (i *Types) SetInt64(in int64)

SetInt64 sets the Types value from an int64.

func (*Types) SetString

func (i *Types) SetString(s string) error

SetString sets the Types value from its string representation, and returns an error if the string is invalid.

func (Types) String

func (i Types) String() string

String returns the string representation of this Types value.

func (*Types) UnmarshalText

func (i *Types) UnmarshalText(text []byte) error

UnmarshalText implements the encoding.TextUnmarshaler interface.

func (Types) Values

func (i Types) Values() []enums.Enum

Values returns all possible values for the type Types.