project

Documentation

Overview

Package project loads a complete, immutable Pawn project view.

Index

• type Options
• type Project
  • func Load(reg *source.Registry, fsys fsx.FS, start string, opts Options) (*Project, error)
  • func (p *Project) BackendRequest(operation backend.Operation, opts backend.RequestOptions) (backend.Request, error)
  • func (p *Project) Diagnostics() []diagnostic.Diagnostic
  • func (p *Project) Fingerprint() (string, error)
  • func (p *Project) IncludeResolver() *include.Resolver
  • func (p *Project) Lockfile() *lockfile.Lock
  • func (p *Project) Manifest() *manifest.Manifest
  • func (p *Project) Paths() paths.Resolved
  • func (p *Project) Root() string
  • func (p *Project) Selection() profile.Selection
  • func (p *Project) Workspace() workspace.Root

Types

type Options

type Options struct {
	// Profile contains profile, build, and runtime overrides.
	Profile profile.Options
	// ManagedIncludeRoots contains absolute include roots supplied by tools.
	ManagedIncludeRoots []string
}

Options configures Load.

type Project

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

Project is the resolved view of a Pawn workspace.

func Load

func Load(reg *source.Registry, fsys fsx.FS, start string, opts Options) (*Project, error)

Load discovers and resolves the project containing start. Content issues are returned as diagnostics; environment failures return an error.

func (*Project) BackendRequest

func (p *Project) BackendRequest(operation backend.Operation, opts backend.RequestOptions) (backend.Request, error)

BackendRequest builds a resolved request without reloading the manifest.

func (*Project) Diagnostics

func (p *Project) Diagnostics() []diagnostic.Diagnostic

Diagnostics returns every diagnostic accumulated while loading the manifest and lockfile, in that order.

func (*Project) Fingerprint

func (p *Project) Fingerprint() (string, error)

Fingerprint computes a stable cache key for the project's current resolved state; see package fingerprint.

func (*Project) IncludeResolver

func (p *Project) IncludeResolver() *include.Resolver

func (*Project) Lockfile

func (p *Project) Lockfile() *lockfile.Lock

func (*Project) Manifest

func (p *Project) Manifest() *manifest.Manifest

func (*Project) Paths

func (p *Project) Paths() paths.Resolved

func (*Project) Root

func (p *Project) Root() string

func (*Project) Selection

func (p *Project) Selection() profile.Selection

func (*Project) Workspace

func (p *Project) Workspace() workspace.Root