refactor: return package pointer

Author: michenriksen

cmd/pkgdmp/main.go

@@ -36,7 +36,7 @@ func main() {
 		log.Fatal(err)
 	}
 
-	parsed := make([]pkgdmp.Package, 0, len(unparsed))
+	parsed := make([]*pkgdmp.Package, 0, len(unparsed))
 
 	for _, uPkg := range unparsed {
 		pkg, err := pkgParser.Package(doc.New(uPkg, "", doc.AllDecls))
@@ -73,7 +73,7 @@ func getPackages(dirs []string) ([]*ast.Package, error) {
 	return all, nil
 }
 
-func printPackages(pkgs []pkgdmp.Package, cfg *cli.Config) error {
+func printPackages(pkgs []*pkgdmp.Package, cfg *cli.Config) error {
 	if cfg.JSON {
 		encoder := json.NewEncoder(os.Stdout)
 		encoder.SetIndent("", "  ")

entities.go

@@ -4,17 +4,9 @@ import (
 	"fmt"
 	"go/format"
 	"io"
-	"sort"
 	"strings"
 )
 
-// Identifier represents a program entity such as a function, struct, method,
-// interface, etc. that can be exported by a package or kept private.
-type Identifier interface {
-	Ident() string
-	IsExported() bool
-}
-
 // Package represents a go package containing functions and types such as
 // structs and interfaces.
 type Package struct {
@@ -24,14 +16,8 @@ type Package struct {
 	Types []TypeDef `json:"types"`
 }
 
-// OrderIdents arranges package entities, sorting them first by whether they are
-// exported or unexported, and then alphabetically.
-func (p Package) OrderIdents() {
-	p.orderFuncs()
-}
-
 // Source returns the formatted package signature source.
-func (p Package) Source() (string, error) {
+func (p *Package) Source() (string, error) {
 	formatted, err := format.Source([]byte(p.String()))
 	if err != nil {
 		return "", fmt.Errorf("formatting source: %w", err)
@@ -41,7 +27,7 @@ func (p Package) Source() (string, error) {
 }
 
 // String returns the unformatted package signature source.
-func (p Package) String() string {
+func (p *Package) String() string {
 	var b strings.Builder
 
 	if p.Doc != "" {
@@ -63,17 +49,6 @@ func (p Package) String() string {
 	return b.String()
 }
 
-func (p Package) orderFuncs() {
-	sortFn := func(i, j int) bool {
-		funcI := p.Funcs[i]
-		funcJ := p.Funcs[j]
-
-		return funcI.Less(funcJ)
-	}
-
-	sort.SliceStable(p.Funcs, sortFn)
-}
-
 // Func represents a function or a struct method if the Receiver field contains
 // a pointer to a [FuncReceiver].
 type Func struct {
@@ -87,30 +62,15 @@ type Func struct {
 }
 
 // Ident returns the function's name.
-//
-// Part of the [Identifier] interface implementation.
 func (f Func) Ident() string {
 	return f.Name
 }
 
 // IsExported returns true if the function is exported.
-//
-// Part of the [Identifier] interface implementation.
 func (f Func) IsExported() bool {
 	return isExportedIdent(f.Name)
 }
 
-// Less returns true if Func must sort before other Func.
-func (f Func) Less(other Func) bool {
-	if f.IsExported() && !other.IsExported() {
-		return true
-	} else if !f.IsExported() && other.IsExported() {
-		return false
-	}
-
-	return f.Ident() > other.Ident()
-}
-
 // String returns the function signature code.
 func (f Func) String() string {
 	var b strings.Builder
@@ -136,6 +96,7 @@ func (f Func) String() string {
 	return b.String()
 }
 
+// TypeDef represents a type definition.
 type TypeDef struct {
 	Type    string  `json:"type"`
 	Name    string  `json:"name"`
@@ -151,6 +112,17 @@ type TypeDef struct {
 	Methods []Func  `json:"methods,omitempty"`
 }
 
+// Ident returns the type definition's name.
+func (td TypeDef) Ident() string {
+	return td.Name
+}
+
+// IsExported returns true if the type definition is exported.
+func (td TypeDef) IsExported() bool {
+	return isExportedIdent(td.Name)
+}
+
+// String returns the type definition code.
 func (td TypeDef) String() string {
 	var b strings.Builder
 
@@ -191,15 +163,11 @@ type Field struct {
 }
 
 // Ident returns the name of the struct field.
-//
-// Part of the [Identifier] interface implementation.
 func (sf Field) Ident() string {
 	return sf.Names[0]
 }
 
 // IsExported returns true if the struct field is exported.
-//
-// Part of the [Identifier] interface implementation.
 func (sf Field) IsExported() bool {
 	return isExportedIdent(sf.Names[0])
 }

parse.go

@@ -33,18 +33,18 @@ func NewParser(opts ParserOptions) *Parser {
 }
 
 // Package parses dPkg to a simplified [Package].
-func (p *Parser) Package(dPkg *doc.Package) (Package, error) {
-	pkg := Package{
+func (p *Parser) Package(dPkg *doc.Package) (*Package, error) {
+	pkg := &Package{
 		Name: dPkg.Name,
 		Doc:  p.mkDoc(dPkg.Doc),
 	}
 
-	if err := p.parseFuncs(&pkg, dPkg.Funcs); err != nil {
-		return Package{}, fmt.Errorf("parsing functions: %w", err)
+	if err := p.parseFuncs(pkg, dPkg.Funcs); err != nil {
+		return nil, fmt.Errorf("parsing functions: %w", err)
 	}
 
-	if err := p.parseTypes(&pkg, dPkg.Types); err != nil {
-		return Package{}, fmt.Errorf("parsing types: %w", err)
+	if err := p.parseTypes(pkg, dPkg.Types); err != nil {
+		return nil, fmt.Errorf("parsing types: %w", err)
 	}
 
 	return pkg, nil

parse_test.go

@@ -199,7 +199,7 @@ func (tc *parserTestCase) pkgDoc(tb testing.TB) *doc.Package {
 	return doc.New(pkg, "", doc.AllDecls)
 }
 
-func (tc *parserTestCase) compareGolden(tb testing.TB, pkg pkgdmp.Package) {
+func (tc *parserTestCase) compareGolden(tb testing.TB, pkg *pkgdmp.Package) {
 	tb.Helper()
 
 	actual, err := pkg.Source()