pkgcontext

Documentation

Index

• Variables
• type PackageContext
  • func NewPackageContext(gh *github.Client, auth transport.AuthMethod, parent bool, dir string, ...) (pcx *PackageContext, err error)
  • func (pcx *PackageContext) Build(ctx context.Context, build string, ensure bool, dry bool, relative bool, ...) (problems build.Problems, result build.Result, err error)
  • func (pcx *PackageContext) BuildWatch(ctx context.Context, name string, ensure bool, buildFile string, relative bool, ...) (err error)
  • func (pcx *PackageContext) EnsureDependencies(ctx context.Context, forceUpdate bool) (err error)
  • func (pcx *PackageContext) EnsureDependenciesCached() (errOuter error)
  • func (pcx PackageContext) EnsureDependencyCached(meta versioning.DependencyMeta, forceUpdate bool) (repo *git.Repository, err error)
  • func (pcx PackageContext) EnsureDependencyFromCache(meta versioning.DependencyMeta, path string, forceUpdate bool) (repo *git.Repository, err error)
  • func (pcx *PackageContext) EnsurePackage(meta versioning.DependencyMeta, forceUpdate bool) error
  • func (pcx *PackageContext) GatherPlugins() (pluginDeps []versioning.DependencyMeta, err error)
  • func (pcx *PackageContext) Install(ctx context.Context, targets []versioning.DependencyString, development bool) (err error)
  • func (pcx *PackageContext) Run(ctx context.Context, output io.Writer, input io.Reader) (err error)
  • func (pcx *PackageContext) RunPrepare(ctx context.Context) (err error)
  • func (pcx *PackageContext) RunWatch(ctx context.Context) (err error)
  • func (pcx *PackageContext) Uninstall(targets []versioning.DependencyString, development bool) (err error)

Variables

var ErrNotRemotePackage = errors.New("remote repository does not declare a package")

ErrNotRemotePackage describes a repository that does not contain a package definition file

Types

type PackageContext

type PackageContext struct {
	Package         pawnpackage.Package         // the package this context wraps
	GitHub          *github.Client              // GitHub client for downloading plugins
	GitAuth         transport.AuthMethod        // Authentication method for git
	Platform        string                      // the platform this package targets
	CacheDir        string                      // the cache directory
	AllDependencies []versioning.DependencyMeta // flattened list of dependencies
	AllPlugins      []versioning.DependencyMeta // flattened list of plugin dependencies
	AllIncludePaths []string                    // any additional include paths specified by resources
	ActualRuntime   run.Runtime                 // actual runtime configuration to use for running the package
	ActualBuild     build.Config                // actual build configuration to use for running the package

	// Runtime specific fields
	Runtime     string // the runtime config to use, defaults to `default`
	Container   bool   // whether or not to run the package in a container
	AppVersion  string // the version of sampctl
	BuildName   string // Build configuration to use
	ForceBuild  bool   // Force a build before running
	ForceEnsure bool   // Force an ensure before building before running
	NoCache     bool   // Don't use a cache, download all plugin dependencies
	BuildFile   string // File to increment build number
	Relative    bool   // Show output as relative paths

}

PackageContext stores state for a package during its lifecycle.

func NewPackageContext

func NewPackageContext(
	gh *github.Client,
	auth transport.AuthMethod,
	parent bool,
	dir string,
	platform string,
	cacheDir string,
	vendor string,
	init bool,
) (pcx *PackageContext, err error)

NewPackageContext attempts to parse a directory as a Package by looking for a `pawn.json` or `pawn.yaml` file and unmarshalling it - additional parameters are required to specify whether or not the package is a "parent package" and where the vendor directory is.

func (*PackageContext) Build

func (pcx *PackageContext) Build(
	ctx context.Context,
	build string,
	ensure bool,
	dry bool,
	relative bool,
	buildFile string,
) (
	problems build.Problems,
	result build.Result,
	err error,
)

Build compiles a package, dependencies are ensured and a list of paths are sent to the compiler.

func (*PackageContext) BuildWatch

func (pcx *PackageContext) BuildWatch(
	ctx context.Context,
	name string,
	ensure bool,
	buildFile string,
	relative bool,
	trigger chan build.Problems,
) (err error)

BuildWatch runs the Build code on file changes

func (*PackageContext) EnsureDependencies

func (pcx *PackageContext) EnsureDependencies(ctx context.Context, forceUpdate bool) (err error)

EnsureDependencies traverses package dependencies and ensures they are up to date

func (*PackageContext) EnsureDependenciesCached

func (pcx *PackageContext) EnsureDependenciesCached() (errOuter error)

EnsureDependenciesCached will recursively visit a parent package dependencies in the cache, pulling them if they do not exist yet.

func (PackageContext) EnsureDependencyCached

func (pcx PackageContext) EnsureDependencyCached(
	meta versioning.DependencyMeta,
	forceUpdate bool,
) (repo *git.Repository, err error)

EnsureDependencyCached clones a package to path using the default branch

func (PackageContext) EnsureDependencyFromCache

func (pcx PackageContext) EnsureDependencyFromCache(
	meta versioning.DependencyMeta,
	path string,
	forceUpdate bool,
) (repo *git.Repository, err error)

EnsureDependencyFromCache ensures the repository at `path` is up to date

func (*PackageContext) EnsurePackage

func (pcx *PackageContext) EnsurePackage(meta versioning.DependencyMeta, forceUpdate bool) error

EnsurePackage will make sure a vendor directory contains the specified package. If the package is not present, it will clone it at the correct version tag, sha1 or HEAD If the package is present, it will ensure the directory contains the correct version

func (*PackageContext) GatherPlugins

func (pcx *PackageContext) GatherPlugins() (pluginDeps []versioning.DependencyMeta, err error)

GatherPlugins iterates the AllPlugins list and appends them to the runtime dependencies list

func (*PackageContext) Install

func (pcx *PackageContext) Install(
	ctx context.Context,
	targets []versioning.DependencyString,
	development bool,
) (err error)

Install adds a new dependency to an existing local parent package

func (*PackageContext) Run

func (pcx *PackageContext) Run(ctx context.Context, output io.Writer, input io.Reader) (err error)

Run will create a temporary server runtime and run the package output AMX as a gamemode using the runtime configuration in the package info.

func (*PackageContext) RunPrepare

func (pcx *PackageContext) RunPrepare(ctx context.Context) (err error)

RunPrepare prepares the context directory for executing the server. It generates a server.cfg and ensures plugins.

func (*PackageContext) RunWatch

func (pcx *PackageContext) RunWatch(ctx context.Context) (err error)

RunWatch runs the Run code on file changes

func (*PackageContext) Uninstall

func (pcx *PackageContext) Uninstall(
	targets []versioning.DependencyString,
	development bool,
) (err error)

Uninstall removes a dependency from a package and attempts to delete the contents