stubs

Documentation

Index

• Constants
• Variables
• func Generate(root string, version *phpversion.PHPVersion, progress *atomic.Uint32) (string, error)
• func Path(root string, version *phpversion.PHPVersion) (string, error)

Constants

const TotalStubs = 721

The total amount of stub files. Retrieved from phpstorm-stubs version v2022.3-116-gddf4f526 in the directory ../../third_party/phpstorm-stubs.

Variables

var ErrNotExists = os.ErrNotExist

Functions

func Generate

func Generate(
	root string,
	version *phpversion.PHPVersion,
	progress *atomic.Uint32,
) (string, error)

Generate generates the stubs for the given version in the given root. It returns the root directory of the stubs. Optionally pass a atomic uint to keep track of the number of files that are done being generated. You can compare that with stubs.TotalStubs to keep track of progress.

func Path

func Path(root string, version *phpversion.PHPVersion) (string, error)

Path returns the path to the root of the stubs directory for the given version. Returns ErrNotExists if the directory does not exists. Call Generate to generate the stubs.