flags

Documentation

Index

• Variables
• type Build
• type Common
• type Dev
• type GenerateBindingsOptions
  • func (options *GenerateBindingsOptions) BuildFlags() (flags []string, err error)
• type Init
• type Package
• type ServiceInit

Variables

var ErrUnmatchedQuote = errors.New("build flags contain an unmatched quote")

Types

type Build

type Build struct {
	Common
}

type Common

type Common struct {
	NoColour bool `description:"Disable colour in output"`
}

type Dev

type Dev struct {
	Common
}

type GenerateBindingsOptions

type GenerateBindingsOptions struct {
	BuildFlagsString  string `` /* 160-byte string literal not displayed */
	OutputDirectory   string `name:"d" description:"The output directory" default:"frontend/bindings"`
	ModelsFilename    string `name:"models" description:"File name for exported JS/TS models (excluding the extension)" default:"models"`
	InternalFilename  string `name:"internal" description:"File name for unexported JS/TS models (excluding the extension)" default:"internal"`
	IndexFilename     string `name:"index" description:"File name for JS/TS package indexes (excluding the extension)" default:"index"`
	TS                bool   `name:"ts" description:"Generate Typescript bindings"`
	UseInterfaces     bool   `name:"i" description:"Generate Typescript interfaces instead of classes"`
	UseBundledRuntime bool   `name:"b" description:"Use the bundled runtime instead of importing the npm package"`
	UseNames          bool   `name:"names" description:"Use names instead of IDs for the binding calls"`
	NoIndex           bool   `name:"noindex" description:"Do not generate JS/TS index files"`
	DryRun            bool   `name:"dry" description:"Do not write output files"`
	Silent            bool   `name:"silent" description:"Silent mode"`
	Verbose           bool   `name:"v" description:"Enable debug output"`
}

func (*GenerateBindingsOptions) BuildFlags

func (options *GenerateBindingsOptions) BuildFlags() (flags []string, err error)

type Init

type Init struct {
	Common

	PackageName        string `name:"p" description:"Package name" default:"main"`
	TemplateName       string `name:"t" description:"Name of built-in template to use, path to template or template url" default:"vanilla"`
	ProjectName        string `name:"n" description:"Name of project" default:""`
	ProjectDir         string `name:"d" description:"Project directory" default:"."`
	Quiet              bool   `name:"q" description:"Suppress output to console"`
	List               bool   `name:"l" description:"List templates"`
	ProductName        string `description:"The name of the product" default:"My Product"`
	ProductDescription string `description:"The description of the product" default:"My Product Description"`
	ProductVersion     string `description:"The version of the product" default:"0.1.0"`
	ProductCompany     string `description:"The company of the product" default:"My Company"`
	ProductCopyright   string `description:"The copyright notice" default:"\u00a9 now, My Company"`
	ProductComments    string `description:"Comments to add to the generated files" default:"This is a comment"`
	ProductIdentifier  string `description:"The product identifier, e.g com.mycompany.myproduct"`
}

type Package

type Package struct {
	Common
}

type ServiceInit

type ServiceInit struct {
	Name        string `name:"n" description:"Name of plugin" default:"example_plugin"`
	Description string `name:"d" description:"Description of plugin" default:"Example plugin"`
	PackageName string `name:"p" description:"Package name for plugin" default:""`
	OutputDir   string `name:"o" description:"Output directory" default:"."`
	Quiet       bool   `name:"q" description:"Suppress output to console"`
	Author      string `name:"a" description:"Author of plugin" default:""`
	Version     string `name:"v" description:"Version of plugin" default:""`
	Website     string `name:"w" description:"Website of plugin" default:""`
	Repository  string `name:"r" description:"Repository of plugin" default:""`
	License     string `name:"l" description:"License of plugin" default:""`
}