context

Documentation

Index

• type Context
  • func BuildPackageGraph(repoRoot turbopath.AbsoluteSystemPath, rootPackageJSON *fs.PackageJSON, ...) (*Context, error)
  • func SinglePackageGraph(rootPackageJSON *fs.PackageJSON, packageManagerName string) (*Context, error)
  • func (c *Context) ChangedPackages(previousLockfile lockfile.Lockfile) ([]string, error)
  • func (c *Context) InternalDependencies(start []string) ([]string, error)
• type Warnings
  • func (w *Warnings) Error() string

Types

type Context

type Context struct {
	// WorkspaceInfos contains the contents of package.json for every workspace
	// TODO(gsoltis): should the RootPackageJSON be included in WorkspaceInfos?
	WorkspaceInfos workspace.Catalog

	// WorkspaceNames is all the names of the workspaces
	WorkspaceNames []string

	// WorkspaceGraph is a graph of workspace dependencies
	// (based on package.json dependencies and devDependencies)
	WorkspaceGraph dag.AcyclicGraph

	// RootNode is a sigil identifying the root workspace
	RootNode string

	// Lockfile is a struct to read the lockfile based on the package manager
	Lockfile lockfile.Lockfile

	// PackageManager is an abstraction for all the info a package manager
	// can give us about the repo.
	PackageManager *packagemanager.PackageManager
	// contains filtered or unexported fields
}

Context of the CLI

func BuildPackageGraph

func BuildPackageGraph(repoRoot turbopath.AbsoluteSystemPath, rootPackageJSON *fs.PackageJSON, packageManagerName string) (*Context, error)

BuildPackageGraph constructs a Context instance with information about the package dependency graph

func SinglePackageGraph

func SinglePackageGraph(rootPackageJSON *fs.PackageJSON, packageManagerName string) (*Context, error)

SinglePackageGraph constructs a Context instance from a single package.

func (*Context) ChangedPackages

func (c *Context) ChangedPackages(previousLockfile lockfile.Lockfile) ([]string, error)

ChangedPackages returns a list of changed packages based on the contents of a previous lockfile This assumes that none of the package.json in the workspace change, it is the responsibility of the caller to verify this.

func (*Context) InternalDependencies

func (c *Context) InternalDependencies(start []string) ([]string, error)

InternalDependencies finds all dependencies required by the slice of starting packages, as well as the starting packages themselves.

type Warnings

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

Warnings Error type for errors that don't prevent the creation of a functional Context

func (*Warnings) Error

func (w *Warnings) Error() string