api

package

v1.0.0 Latest Latest Go to latest Published: Jan 3, 2024 License: BSD-3-Clause Imports: 18 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/AiRISTAFlowInc/flow-studio-cli

Documentation ¶

Index ¶

Variables
func BuildProject(project common.AppProject, options common.BuildOptions) error
func CreateLegacyMetadata(path, contribType, contribPkg string) error
func CreateProject(basePath, appName, appCfgPath, coreVersion string) (common.AppProject, error)
func GetAliasRef(contribType string, alias string) (string, bool)
func GetTempDir() (string, error)
func InstallContribBundle(project common.AppProject, path string) error
func InstallLegacySupport(project common.AppProject) error
func InstallPackage(project common.AppProject, pkg string) error
func InstallReplacedPackage(project common.AppProject, replacedPath string, pkg string) error
func ListContribs(project common.AppProject, jsonFormat bool, filter string) error
func ListOrphanedRefs(project common.AppProject, jsonFormat bool) error
func ListProjectImports(project common.AppProject) error
func NewAppProject(appDir string) common.AppProject
func RegisterAlias(contribType string, alias, ref string)
func RenderTemplate(w io.Writer, text string, data interface{})
func ResolveProjectImports(project common.AppProject) error
func SetVerbose(enable bool)
func SyncProjectImports(project common.AppProject) error
func UpdatePkg(project common.AppProject, pkg string) error
func Verbose() bool
type AppBuilder
- func (*AppBuilder) Build(project common.AppProject) error
type ContribSpec
type ListFilter
type ShimBuilder
- func (sb *ShimBuilder) Build(project common.AppProject) error

Constants ¶

This section is empty.

Variables ¶

View Source

var GOOSENV = os.Getenv("GOOS")

Functions ¶

func BuildProject ¶

func BuildProject(project common.AppProject, options common.BuildOptions) error

func CreateLegacyMetadata ¶

func CreateLegacyMetadata(path, contribType, contribPkg string) error

func CreateProject ¶

func CreateProject(basePath, appName, appCfgPath, coreVersion string) (common.AppProject, error)

func GetAliasRef ¶

func GetAliasRef(contribType string, alias string) (string, bool)

func GetTempDir ¶

func GetTempDir() (string, error)

func InstallContribBundle ¶

func InstallContribBundle(project common.AppProject, path string) error

func InstallLegacySupport ¶

func InstallLegacySupport(project common.AppProject) error

func InstallPackage ¶

func InstallPackage(project common.AppProject, pkg string) error

func InstallReplacedPackage ¶

func InstallReplacedPackage(project common.AppProject, replacedPath string, pkg string) error

func ListContribs ¶

func ListContribs(project common.AppProject, jsonFormat bool, filter string) error

func ListOrphanedRefs ¶

func ListOrphanedRefs(project common.AppProject, jsonFormat bool) error

func ListProjectImports ¶

func ListProjectImports(project common.AppProject) error

func NewAppProject ¶

func NewAppProject(appDir string) common.AppProject

func RegisterAlias ¶

func RegisterAlias(contribType string, alias, ref string)

func RenderTemplate ¶

func RenderTemplate(w io.Writer, text string, data interface{})

RenderTemplate renders the specified template

func ResolveProjectImports ¶

func ResolveProjectImports(project common.AppProject) error

func SetVerbose ¶

func SetVerbose(enable bool)

func SyncProjectImports ¶

func SyncProjectImports(project common.AppProject) error

func UpdatePkg ¶

func UpdatePkg(project common.AppProject, pkg string) error

func Verbose ¶

func Verbose() bool

Types ¶

type AppBuilder ¶

type AppBuilder struct {
}

func (*AppBuilder) Build ¶

func (*AppBuilder) Build(project common.AppProject) error

type ContribSpec ¶

type ContribSpec struct {
	Name        string      `json:"name"`
	Type        string      `json:"type"`
	Description string      `json:"description"`
	Homepage    string      `json:"homepage"`
	Ref         string      `json:"ref"`
	Path        string      `json:"path"`
	Descriptor  string      `json:"descriptor"`
	IsLegacy    interface{} `json:"isLegacy,omitempty"`
}

type ListFilter ¶

type ListFilter int

type ShimBuilder ¶

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

func (*ShimBuilder) Build ¶

func (sb *ShimBuilder) Build(project common.AppProject) error

Source Files ¶

View all Source files

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