rook

Documentation

Index

• Variables
• func FindIncludes(files []string) (includes []versioning.DependencyString)
• func Get(ctx context.Context, gh *github.Client, meta versioning.DependencyMeta, ...) (err error)
• func Init(ctx context.Context, gh *github.Client, dir string, config *config.Config, ...) (err error)
• func Release(ctx context.Context, gh *github.Client, auth transport.AuthMethod, ...) (err error)
• type Answers

Variables

var IncludesToDependencies = map[string]versioning.DependencyString{
	`YSI\\.+`:       "pawn-lang/YSI-Includes",
	`streamer`:      "samp-incognito/samp-streamer-plugin",
	`map`:           "BigETI/pawn-map",
	`list`:          "BigETI/pawn-list",
	`DialogCenter`:  "Ino-Bagaric/Dialog-Center-Text",
	`progress2`:     "Southclaws/progress2",
	`zcmd`:          "Southclaws/zcmd",
	`formatex`:      "Southclaws/formatex",
	`modio`:         "Southclaws/modio",
	`ini`:           "Southclaws/ini",
	`a_mysql`:       "pBlueG/SA-MP-MySQL",
	`sscanf2`:       "maddinat0r/sscanf",
	`ctime`:         "Southclaws/ctime",
	`redis`:         "Southclaws/samp-redis",
	`sqlitei`:       "oscar-broman/sqlitei",
	`strlib`:        "oscar-broman/strlib",
	`weapon-config`: "oscar-broman/samp-weapon-config",
	`md-sort`:       "oscar-broman/md-sort",
	`logger`:        "Southclaws/samp-logger",
	`crashdetect`:   "zeex/samp-plugin-crashdetect",
}

IncludesToDependencies maps common include paths to known Pawn package dependency strings

Functions

func FindIncludes

func FindIncludes(files []string) (includes []versioning.DependencyString)

FindIncludes checks a list of files and scans the contents searching for includes with known dependency strings

func Get

func Get(
	ctx context.Context,
	gh *github.Client,
	meta versioning.DependencyMeta,
	dir string,
	auth transport.AuthMethod,
	platform,
	cacheDir string,
) (err error)

Get simply performs a git clone of the given package to the specified directory then ensures it

func Init

func Init(
	ctx context.Context,
	gh *github.Client,
	dir string,
	config *config.Config,
	auth transport.AuthMethod,
	platform,
	cacheDir string,
) (err error)

Init prompts the user to initialise a package

func Release

func Release(ctx context.Context, gh *github.Client, auth transport.AuthMethod, pkg pawnpackage.Package) (err error)

Release is an interactive release tool for package versioning

Types

type Answers

type Answers struct {
	Format        string
	User          string
	Repo          string
	RepoEscaped   string
	PackageType   string
	GitIgnore     bool
	Readme        bool
	Editor        string
	StdLib        bool
	Scan          bool
	Git           bool
	Travis        bool
	EntryGenerate bool
	Entry         string
}

Answers represents wizard question results