ErrRequire is the sentinel error returned when Require encounters problems. It prints the problems directly to standard error, so that multiple errors can be displayed easily.
LoadTests controls whether the loaders load tests of the root packages.
AllowWriteGoMod undoes the effect of DisallowWriteGoMod: future calls to WriteGoMod will update go.mod if needed. Note that any past calls have been discarded, so typically a call to AlowWriteGoMod should be followed by a call to WriteGoMod.
Allowed reports whether module m is allowed (not excluded) by the main module's go.mod.
BuildList returns the module build list, typically constructed by a previous call to LoadBuildList or ImportPaths. The caller must not modify the returned list.
DirImportPath returns the effective import path for dir, provided it is within the main module, or else returns ".".
DisallowWriteGoMod causes future calls to WriteGoMod to do nothing at all.
Enabled reports whether modules are (or must be) enabled. If modules must be enabled but are not, Enabled returns true and then the first use of module information will call die (usually through InitMod and MustInit).
Failed reports whether module loading failed. If Failed returns true, then any use of module information will call die.
Exported only for testing.
Exported only for testing.
Import finds the module and directory in the build list containing the package with the given import path. The answer must be unique: Import returns an error if multiple modules attempt to provide the same package. Import can return a module with an empty m.Path, for packages in the standard library. Import can return an empty directory string, for fake packages like "C" and "unsafe".
If the package cannot be found in the current build list, Import returns an ImportMissingError as the error. If Import can identify a module that could be added to supply the package, the ImportMissingError records that module.
ImportFromFiles adds modules to the build list as needed to satisfy the imports in the named Go source files.
ImportMap returns the actual package import path for an import path found in source code. If the given import path does not appear in the source code for the packages that have been loaded, ImportMap returns the empty string.
ImportPaths returns the set of packages matching the args (patterns), adding modules to the build list as needed to satisfy new imports.
LoadALL returns the set of all packages in the current module and their dependencies in any other modules, without filtering due to build tags, except "+build ignore". It adds modules to the build list as needed to satisfy new imports. This set is useful for deciding whether a particular import is needed anywhere in a module.
LoadBuildList loads and returns the build list from go.mod. The loading of the build list happens automatically in ImportPaths: LoadBuildList need only be called if ImportPaths is not (typically in commands that care about the module but no particular package).
LoadVendor is like LoadALL but only follows test dependencies for tests in the main module. Tests in dependency modules are ignored completely. This set is useful for identifying the which packages to include in a vendor directory.
Lookup returns the source directory, import path, and any loading error for the package at path. Lookup requires that one of the Load functions in this package has already been called.
MinReqs returns a Reqs with minimal dependencies of Target, as will be written to go.mod.
ModFile returns the parsed go.mod file.
Note that after calling ImportPaths or LoadBuildList, the require statements in the modfile.File are no longer the source of truth and will be ignored: edits made directly will be lost at the next call to WriteGoMod. To make permanent changes to the require statements in go.mod, edit it before calling ImportPaths or LoadBuildList.
ModuleUsedDirectly reports whether the main module directly imports some package in the module with the given path.
MustInit calls Init if needed and checks that modules are enabled and the main module has been found. If not, MustInit calls base.Fatalf with an appropriate message.
PackageDir returns the directory containing the source code for the package named by the import path.
PackageModule returns the module providing the package named by the import path.
Query looks up a revision of a given module given a version query string. The module must be a complete module path. The version must take one of the following forms:
- the literal string "latest", denoting the latest available, allowed tagged version, with non-prereleases preferred over prereleases. If there are no tagged versions in the repo, latest returns the most recent commit. - v1, denoting the latest available tagged version v1.x.x. - v1.2, denoting the latest available tagged version v1.2.x. - v1.2.3, a semantic version string denoting that tagged version. - <v1.2.3, <=v1.2.3, >v1.2.3, >=v1.2.3, denoting the version closest to the target and satisfying the given operator, with non-prereleases preferred over prereleases. - a repository commit identifier, denoting that commit.
If the allowed function is non-nil, Query excludes any versions for which allowed returns false.
If path is the path of the main module and the query is "latest", Query returns Target.Version as the version.
QueryPackage looks up a revision of a module containing path.
If multiple modules with revisions matching the query provide the requested package, QueryPackage picks the one with the longest module path.
If the path is in the the main module and the query is "latest", QueryPackage returns Target as the version.
Replacement returns the replacement for mod, if any, from go.mod. If there is no replacement for mod, Replacement returns a module.Version with Path == "".
Reqs returns the current module requirement graph. Future calls to SetBuildList do not affect the operation of the returned Reqs.
SetBuildList sets the module build list. The caller is responsible for ensuring that the list is valid. SetBuildList does not retain a reference to the original list.
TargetPackages returns the list of packages in the target (top-level) module, under all build tag settings.
Why returns the "go mod why" output stanza for the given package, without the leading # comment. The package graph must have been loaded already, usually by LoadALL. If there is no reason for the package to be in the current build, Why returns an empty string.
WhyDepth returns the number of steps in the Why listing. If there is no reason for the package to be in the current build, WhyDepth returns 0.
WriteGoMod writes the current build list back to go.mod.