splits

Documentation

Index

• type DataSplit
• type DataSplits

Types

type DataSplit

type DataSplit struct {
	// Name of the split
	Name string
	// Set of the paths of all files that are directly included in the split relative to the source
	// module's root. This does not include files that are part of any residuals of the split.
	Files map[string]bool
	// Residual Go packages for this split. These are packages imported by the Go packages
	// explicitly included in the split via its Includes and Excludes but are not explicitly
	// included themselves in any split. Residual packages are not allowed to be referenced as part
	// of any exported symbol of the split's packages.
	Residuals map[string]bool
	// Set of the paths of all files that are part of any residuals of the split.
	ResidualFiles map[string]bool
	// New virtual root relative to the root of the source module for packages part of the split's module.
	Root string
	// New virtual root relative to the root of the source module for residual packages of the split's module.
	ResidualsRoot string
	// Names of splits of which this split directly imports Go packages.
	SplitDeps map[string]bool
	// New pseudo-version for the content of this split.
	Version string
	// Folder to which the content of this split is written.
	WorkDir string
	// Git repository stored inside WorkDir.
	Repo *git.Repository
}

splitData contains information that is not part of the configuration of a split but which is filled in and used throughout the processing of the source code.

type DataSplits

type DataSplits struct {
	// Indicates whether the source project is a Go Module itself.
	NonModuleSource bool
	// Filepath to split mapping.
	PathToSplit map[string]string
	// Go package name to split mapping.
	PkgToSplit map[string]string
	// Directory under which all split work will be done and stored.
	WorkTree string
}

DataSplits contains information that is not part of the configuration of the splits but which is filled in and used throughout the processing of the source code.