app

Documentation

Overview

Command, OptionInfo and command execution pattern derived from github.com/constabulary/gb, released under MIT license https://github.com/constabulary/gb/blob/master/LICENSE

Index

• Variables
• func BuildApp(env env.Project, options *BuildOptions) error
• func CopyDir(src string, dst string) (err error)
• func CopyFile(src, dst string) (err error)
• func CreateApp(env env.Project, appJson, appDir, appName, vendorDir, constraints string) error
• func Ensure(depManager *dep.DepManager, args ...string) error
• func InstallDependency(environ env.Project, path string, version string) error
• func InstallPalette(env env.Project, path string) error
• func ListDependencies(env env.Project, cType config.ContribType) ([]*config.Dependency, error)
• func MigrateOldApp(env env.Project, depManager dep.DepManager) error
• func ParseAppDescriptor(appJson string) (*config.FlogoAppDescriptor, error)
• func ParseDescriptor(descJson string) (*config.Descriptor, error)
• func ParseTriggerMetadata(metadataJson string) (*config.TriggerMetadata, error)
• func PrepareApp(env env.Project, options *PrepareOptions) error
• func SetupExistingProjectEnv(rootDir string) env.Project
• func SetupExistingProjectEnvWithOrWithoutExitOnFailure(rootDir string, exitOnFailure bool) (env.Project, error)
• func SetupNewProjectEnv() env.Project
• func UninstallDependency(environ env.Project, path string) error
• func Usage()
• type BuildOptions
• type BuildPreProcessor
• type PrepareOptions

Variables

var (
	CommandRegistry = cli.NewCommandRegistry()
)

Functions

func BuildApp

func BuildApp(env env.Project, options *BuildOptions) error

BuildApp build the flogo application

func CopyDir

func CopyDir(src string, dst string) (err error)

CopyDir recursively copies a directory tree, attempting to preserve permissions. Source directory must exist, destination directory must *not* exist. Symlinks are ignored and skipped.

func CopyFile

func CopyFile(src, dst string) (err error)

CopyFile copies the contents of the file named src to the file named by dst. The file will be created if it does not already exist. If the destination file exists, all it's contents will be replaced by the contents of the source file. The file mode will be copied from the source and the copied data is synced/flushed to stable storage.

func CreateApp

func CreateApp(env env.Project, appJson, appDir, appName, vendorDir, constraints string) error

CreateApp creates an application from the specified json application descriptor

func Ensure

func Ensure(depManager *dep.DepManager, args ...string) error

Ensure is a wrapper for dep ensure command

func InstallDependency

func InstallDependency(environ env.Project, path string, version string) error

InstallDependency install a dependency

func InstallPalette

func InstallPalette(env env.Project, path string) error

InstallPalette install a palette

func ListDependencies

func ListDependencies(env env.Project, cType config.ContribType) ([]*config.Dependency, error)

func MigrateOldApp

func MigrateOldApp(env env.Project, depManager dep.DepManager) error

func ParseAppDescriptor

func ParseAppDescriptor(appJson string) (*config.FlogoAppDescriptor, error)

ParseAppDescriptor parse the application descriptor

func ParseDescriptor

func ParseDescriptor(descJson string) (*config.Descriptor, error)

ParseDescriptor parse a descriptor

func ParseTriggerMetadata

func ParseTriggerMetadata(metadataJson string) (*config.TriggerMetadata, error)

ParseTriggerMetadata parse the trigger metadata

func PrepareApp

func PrepareApp(env env.Project, options *PrepareOptions) error

PrepareApp do all pre-build setup and pre-processing

func SetupExistingProjectEnv

func SetupExistingProjectEnv(rootDir string) env.Project

func SetupExistingProjectEnvWithOrWithoutExitOnFailure

func SetupExistingProjectEnvWithOrWithoutExitOnFailure(rootDir string, exitOnFailure bool) (env.Project, error)

func SetupNewProjectEnv

func SetupNewProjectEnv() env.Project

func UninstallDependency

func UninstallDependency(environ env.Project, path string) error

UninstallDependency uninstall a dependency

func Usage

func Usage()

Types

type BuildOptions

type BuildOptions struct {
	*PrepareOptions

	NoGeneration   bool
	GenerationOnly bool
	SkipPrepare    bool
	BuildDocker    string
}

type BuildPreProcessor

type BuildPreProcessor interface {
	PrepareForBuild(env env.Project) error
}

BuildPreProcessor interface for build pre-processors

type PrepareOptions

type PrepareOptions struct {
	PreProcessor    BuildPreProcessor
	OptimizeImports bool
	EmbedConfig     bool
	Shim            string
}