From c51ca7c62e08f43ef9974af35886d30ce54a1f22 Mon Sep 17 00:00:00 2001 From: Alan Pearce Date: Thu, 16 May 2024 20:22:42 +0200 Subject: refactor: use interface to unify Options and Packages --- internal/nix/importable.go | 11 +++++++++++ internal/nix/option.go | 37 +++++++++++++++++++++++++++++++++++++ internal/nix/package.go | 41 +++++++++++++++++++++++++++++++++++++++++ 3 files changed, 89 insertions(+) create mode 100644 internal/nix/importable.go create mode 100644 internal/nix/option.go create mode 100644 internal/nix/package.go (limited to 'internal/nix') diff --git a/internal/nix/importable.go b/internal/nix/importable.go new file mode 100644 index 0000000..309ec5f --- /dev/null +++ b/internal/nix/importable.go @@ -0,0 +1,11 @@ +package nix + +type Importable interface { + BleveType() string + GetName() string + GetSource() string +} + +func GetKey(i Importable) string { + return i.BleveType() + "/" + i.GetSource() + "/" + i.GetName() +} diff --git a/internal/nix/option.go b/internal/nix/option.go new file mode 100644 index 0000000..c1cc4c3 --- /dev/null +++ b/internal/nix/option.go @@ -0,0 +1,37 @@ +package nix + +type Markdown string + +type Value struct { + Text string `json:",omitempty"` + Markdown Markdown `json:",omitempty"` +} + +type Link struct { + Name string + URL string +} + +type Option struct { + Name string + Source string + Declarations []Link + Default *Value `json:",omitempty"` + Description Markdown + Example *Value `json:",omitempty"` + Loc []string + RelatedPackages Markdown `json:",omitempty"` + Type string +} + +func (Option) BleveType() string { + return "option" +} + +func (p Option) GetName() string { + return p.Name +} + +func (p Option) GetSource() string { + return p.Source +} diff --git a/internal/nix/package.go b/internal/nix/package.go new file mode 100644 index 0000000..4158d1f --- /dev/null +++ b/internal/nix/package.go @@ -0,0 +1,41 @@ +package nix + +type Package struct { + Name string + Source string + Broken bool + Definition string + Description string + Homepages []string + Licenses []License + LongDescription string + MainProgram string + Maintainers []Maintainer + Platforms []string + Version string +} + +type License struct { + FullName string + Name string + SPDXId string + URL string + AppendixURL string +} + +type Maintainer struct { + Github string + Name string +} + +func (Package) BleveType() string { + return "package" +} + +func (p Package) GetName() string { + return p.Name +} + +func (p Package) GetSource() string { + return p.Source +} -- cgit 1.4.1