integration

Documentation

Overview

Package integration defines interfaces and helpers for writing integrations with Serulian.

Index

• Constants
• func DescribeIntegration(integrationID string) bool
• func InstallIntegration(repoURL string, debug bool) bool
• func ListIntegrations() bool
• func UninstallIntegration(integrationID string, skipPrompt bool) bool
• func UpgradeIntegration(integrationID string, skipPrompt bool, debug bool) bool
• type BundlerIntegration
• type Implementation
• type Integration
  • func LoadIntegrations() ([]Integration, error)
• type IntegrationInformation
  • func LoadIntegrationsAndInfo() ([]IntegrationInformation, error)
  • func (ii IntegrationInformation) ID() string
  • func (ii IntegrationInformation) Integration() Integration
• type LanguageIntegration
  • func GetLanguageIntegrations(integration Integration, graph compilergraph.SerulianGraph) []LanguageIntegration
• type PathHandler

Constants

const IntegrationConstName = "SerulianIntegration"

IntegrationConstName defines the name of the root-level const that holds the Integration.

Functions

func DescribeIntegration

func DescribeIntegration(integrationID string) bool

DescribeIntegration describes a particular integration.

func InstallIntegration

func InstallIntegration(repoURL string, debug bool) bool

InstallIntegration installs a particular integration.

func ListIntegrations

func ListIntegrations() bool

ListIntegrations lists all installed integrations on the command line.

func UninstallIntegration

func UninstallIntegration(integrationID string, skipPrompt bool) bool

UninstallIntegration uninstalls a particular integration by deleting its binary.

func UpgradeIntegration

func UpgradeIntegration(integrationID string, skipPrompt bool, debug bool) bool

UpgradeIntegration upgrades a particular integration by downloading a new version.

Types

type BundlerIntegration

type BundlerIntegration interface {
	LanguageIntegration

	// PopulateFilesToBundle is invoked by the builder to have the integration populate the file bundle produced
	// by the builder with any files necessary. Note that this method is invoked *before* the source is
	// added to the file bundle, which means it will be overridden if added by this integration
	// (which, in any case, it shouldn't do).
	PopulateFilesToBundle(bundler bundle.Bundler)
}

BundlerIntegration defines an integration that adds files to the bundle produced by the builder.

type Implementation

type Implementation interface{}

Implementation defines an integration for the Serulian toolkit. Implementation will typically match one of the integration interfaces:

• LanguageIntegration

type Integration

type Integration interface {
	// SerulianIntegrations returns all integrations defined by the provider.
	IntegrationImplementations() []Implementation
}

Integration defines an interface for returing all integration implementations.

func LoadIntegrations

func LoadIntegrations() ([]Integration, error)

LoadIntegrations loads all the integrations found for the current toolkit.

type IntegrationInformation

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

func LoadIntegrationsAndInfo

func LoadIntegrationsAndInfo() ([]IntegrationInformation, error)

LoadIntegrationsAndInfo loads all the integration found for the current toolkit.

func (IntegrationInformation) ID

func (ii IntegrationInformation) ID() string

func (IntegrationInformation) Integration

func (ii IntegrationInformation) Integration() Integration

type LanguageIntegration

type LanguageIntegration interface {
	// SourceHandler returns the source handler used to load, parse and validate the input
	// source file(s) for the integrated language or system. Note that calling this method
	// will typically start a modifier, so it should only be called if the full handler
	// lifecycle will be used.
	SourceHandler() packageloader.SourceHandler

	// TypeConstructor returns the type constructor used to construct the types and members that
	// should be added to the type system by the integrated language or system.
	TypeConstructor() typegraph.TypeGraphConstructor

	// PathHandler returns a handler for translating generated paths to those provided by the integration.
	// If the integration returns nil, then no translation is done.
	PathHandler() PathHandler
}

LanguageIntegration defines an integration of an external language or system into Serulian.

func GetLanguageIntegrations

func GetLanguageIntegrations(integration Integration, graph compilergraph.SerulianGraph) []LanguageIntegration

GetLanguageIntegrations returns all language integrations provided by the given integration.

type PathHandler

type PathHandler interface {
	// GetStaticMemberPath returns the global path for the given statically defined type member. If the handler
	// returns empty string, the default path will be used.
	GetStaticMemberPath(member typegraph.TGMember, referenceType typegraph.TypeReference) string

	// GetModulePath returns the global path for the given module. If the handler
	// returns empty string, the default path will be used.
	GetModulePath(module typegraph.TGModule) string
}

PathHandler translates various paths encountered during code generation into those provided by the integration, if any.