search

type CommandError struct {
	// contains filtered or unexported fields
}

type Derivation interface {
	// contains filtered or unexported methods
}

type HighlightStyle interface {
	// contains filtered or unexported methods
}

type HighlightStyleANSI struct {
	// ANSIEscape is the ANSI escape sequence to use for highlighting.
	// It should be a valid ANSI escape sequence with a prefix of "\x1b".
	// If empty, red is used.
	ANSIEscape string
}

type HighlightStyleHTML struct {
	// Tag is the HTML tag to use for highlighting.
	// If empty, "mark" is used.
	Tag string
	// Attributes is a map of attributes to add to the tag.
	Attributes map[string]string
}

type HighlightedMap map[string]Highlights

type Highlights [][2]int

type IndexPackagesOpts struct {
	// Nixpkgs is the Nixpkgs path to index.
	Nixpkgs string
	// Parallelism is the number of parallel workers to use.
	Parallelism int
}

type Opts struct {
	// Highlight is an optional highlighter for this package.
	// If not nil, it can be used to prehighlight matching terms of all
	// packages.
	Highlight HighlightStyle
	// Regex is whether to use regex matching instead.
	// If unsupported, it should return an error.
	Regex bool
	// Exact is whether to match the package exactly according to the string.
	// Note that this filter is applied on top of Bluge's, meaning it narrows
	// down Bluge's results but does not expand them.
	Exact bool
}

type Package struct {
	Name                string   `json:"name,omitempty"`
	Version             string   `json:"version,omitempty"`
	Description         string   `json:"description"`
	LongDescription     string   `json:"longDescription,omitempty"`
	Licenses            []string `json:"license,omitempty"` // usually SPDX identifiers
	MainProgram         string   `json:"mainProgram,omitempty"`
	Broken              bool     `json:"broken,omitempty"`
	Unfree              bool     `json:"unfree,omitempty"`
	UnsupportedPlatform bool     `json:"unsupportedPlatform,omitempty"`
}

type PackageSet map[string]Derivation

type PackagesSearcher interface {
	// SearchPackages returns a channel of packages that match the given query.
	// The channel is closed when there are no more results or ctx is canceled.
	SearchPackages(ctx context.Context, query string, opts Opts) (iter.Seq[SearchedPackage], error)
}

type Path []string

type SearchedPackage struct {
	// Path is the path to the derivation.
	Path string `json:"path"`
	Package

	// Highlighted is the color-highlighted package, if any.
	// This is only used if Highlight is set in Opts.
	Highlighted *SearchedPackage `json:"unhighlighted"`
}

type TopLevelPackages struct {
	PackageSet
	// Channel is the name of the channel that these packages are from.
	// For example, "nixpkgs".
	Channel string `json:"channel"`
}