package
0.2.5
Repository: https://github.com/sourcegraph/srclib.git
Documentation: pkg.go.dev

# Functions

No description provided by the author
No description provided by the author
MakeURI converts a repository clone URL, such as "git://github.com/user/repo.git", to a normalized URI string, such as "github.com/user/repo" lexically.
No description provided by the author
Formatter creates a string formatter for a def.
RegisterMakeDefFormatter makes a DefFormatter constructor function (MakeDefFormatter) available for defs with the specified unitType.
TryMakeURI converts a repository clone URL, such as "git://github.com/user/repo.git", to a normalized URI string, such as "github.com/user/repo" lexically.
UniqueRefDefs groups refs by the RefDefKey field and returns a map of how often each RefDefKey appears.
URIEqual returns true if a and b are equal, based on a case insensitive comparison (strings.EqualFold).

# Constants

A DepQualified name is the package/module name (as seen by an external library that imports/depends on the def's package/module) plus the def's scope-qualified name.
A LanguageWideQualified name is the library/repository name plus the package-qualified def name.
A RepositoryWideQualified name is the full package/module name(s) plus the def's scope-qualified name.
A ScopeQualified name is the language-specific description of the def's defining scope plus the def's unqualified name.
StatAuthors is the number of distinct resolved people who contributed code to a def's definition (according to a VCS "blame" of the version).
StatClients is the number of distinct resolved people who have committed refs that reference a def.
StatDependents is the number of distinct repositories that contain refs that reference a def.
StatExportedElements is the number of exported defs whose path is a descendant of this def's path (and that is in the same repository and source unit).
StatRRefs is the number of references to a def from the same repository in which the def is defined.
StatURefs is the number of references to a def from the same source unit in which the def is defined.
StatXRefs is the number of external references to a def (i.e., references from other repositories).
An Unqualified name is just the def's name.

# Variables

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
MakeDefFormatter holds MakeDefFormatters that toolchains have registered with RegisterMakeDefFormatter.
QualLevels associates a number (the slice index) with each Qualification, for use in format strings (so that, e.g., "%.0n" means Unqualified name and "%.2n" means DepQualified name).

# Structs

Def is a definition in code.
DefDoc is documentation on a Def.
DefFormatStrings contains the various def format strings.
DefKey specifies a definition, either concretely or abstractly.
Doc is documentation on a Def.
DocKey is the unique key for a doc.
No description provided by the author
Propagate describes type/value propagation in code.
QualFormatStrings holds the formatted string for each Qualification for a def (for either Name or Type).
Ref represents a reference from source code to a Def.
No description provided by the author
No description provided by the author
RefSet is a set of Refs.
RepositoryListingDef holds rendered display text to show on the "package" listing page of a repository.

# Interfaces

DefFormatter formats a def.
No description provided by the author

# Type aliases

No description provided by the author
No description provided by the author
A MakeDefFormatter is a function, typically implemented by toolchains, that creates a DefFormatter for a def.
A Qualification specifies how much to qualify names when formatting defs and their type information.
No description provided by the author
Stats holds statistics for a def.
StatType is the name of a def statistic (see below for a listing).