schema

Documentation

Index

• Variables
• type NativeNames
• type Result
  • func Extract(moduleDir string) (Result, error)

Variables

var Extractors = [][]*analysis.Analyzer{
	{
		initialize.Analyzer,
		inspect.Analyzer,
	},
	{
		metadata.Extractor,
	},
	{

		typeenum.Extractor,
	},
	{
		configsecret.Extractor,
		data.Extractor,
		database.Extractor,
		fsm.Extractor,
		topic.Extractor,
		typealias.Extractor,
		typeenumvariant.Extractor,
		valueenumvariant.Extractor,
		verb.Extractor,
	},
	{
		call.Extractor,

		enum.Extractor,
		subscription.Extractor,
	},
	{
		transitive.Extractor,
	},
	{
		finalize.Analyzer,
	},
}

Extractors contains all schema extractors that will run.

It is a list of lists, where each list is a round of tasks dependent on the prior round's execution (e.g. an analyzer in Extractors[1] will only execute once all analyzers in Extractors[0] complete). Elements of the same list should be considered unordered and may run in parallel.

Types

type NativeNames

type NativeNames map[schema.Node]string

NativeNames is a map of top-level declarations to their native Go names.

type Result

type Result struct {
	// Module is the extracted module schema.
	Module *schema.Module
	// NativeNames maps schema nodes to their native Go names.
	NativeNames NativeNames
	// Errors is a list of errors encountered during schema extraction.
	Errors []*schema.Error
}

Result contains the final schema extraction result.

func Extract

func Extract(moduleDir string) (Result, error)

Extract statically parses Go FTL module source into a schema.Module