paths

Documentation

Overview

Package paths resolves manifest paths within a project root.

Index

• func JoinWithin(root, boundary, relative string) (string, error)
• type Resolved
  • func Resolve(root string, m *manifest.Manifest) (Resolved, error)
  • func ResolveWithin(root, boundary string, m *manifest.Manifest) (Resolved, error)

Functions

func JoinWithin

func JoinWithin(root, boundary, relative string) (string, error)

JoinWithin resolves a relative path while keeping it inside boundary.

Types

type Resolved

type Resolved struct {
	// Root is the absolute project root directory (the manifest's
	// directory).
	Root string

	// Entry is the absolute path to manifest.Entry, or "" if unset.
	Entry string

	// Output is the absolute path to manifest.Output, or "" if unset.
	Output string

	// IncludeRoots are de-duplicated and retain declaration order.
	IncludeRoots []string

	// GeneratedFiles lists known generated project files.
	GeneratedFiles []string
}

Resolved contains normalized absolute project paths.

func Resolve

func Resolve(root string, m *manifest.Manifest) (Resolved, error)

Resolve computes Resolved for m rooted at root, which must already be an absolute path (typically workspace.Root.Dir).

func ResolveWithin

func ResolveWithin(root, boundary string, m *manifest.Manifest) (Resolved, error)

ResolveWithin allows entry and output paths inside boundary.