eh, NewModule can do work

Author: chlowell

src/go/cmd/module.go

@@ -33,9 +33,6 @@ type Module struct {
 	Name string
 	// Packages maps import paths to the module's Packages
 	Packages map[string]*Pkg
-
-	// indexed is true after Index() succeeds
-	indexed bool
 }
 
 // getPackageNameFromModPath gets the API review name for the module at modPath
@@ -53,8 +50,7 @@ func getPackageNameFromModPath(modPath string) string {
 	return modPath
 }
 
-// NewModule constructs a Module, locating its constituent packages but not parsing any source.
-// Call [Module.Index] to collect type information.
+// NewModule indexes a module's ASTs
 func NewModule(dir string) (*Module, error) {
 	mf, err := parseModFile(dir)
 	if err != nil {
@@ -97,20 +93,10 @@ func NewModule(dir string) (*Module, error) {
 	if err != nil {
 		return nil, err
 	}
-	return &m, nil
-}
 
-// Index all the types in the module's packages, populating m.Packages and resolving
-// cross-package type aliases. It adds cross-module aliases to [Module.ExternalAliases]
-// so callers can later resolve these after indexing referenced external modules.
-func (m *Module) Index() {
-	if m.indexed {
-		return
-	}
 	for _, p := range m.Packages {
 		p.Index()
 	}
-
 	// resolve cross-package references by adding the definitions of types exported by alias to the exporting package
 	for _, p := range m.Packages {
 		for _, alias := range p.TypeAliases {
@@ -136,7 +122,7 @@ func (m *Module) Index() {
 			}
 		}
 	}
-	m.indexed = true
+	return &m, nil
 }
 
 // returns the type name for the specified struct field.

src/go/cmd/review.go

@@ -50,7 +50,6 @@ func (r *Review) AddModule(m *Module) error {
 	if _, ok := r.modules[m.ModFile.Module.Mod.Path]; ok {
 		return fmt.Errorf("module %s already exists in index", m.ModFile.Module.Mod.Path)
 	}
-	m.Index()
 	if len(r.modules) == 0 {
 		r.reviewed = m
 	}
@@ -59,7 +58,7 @@ func (r *Review) AddModule(m *Module) error {
 }
 
 func (r *Review) Review() (PackageReview, error) {
-	r.index()
+	r.resolveAliases()
 
 	tokenList := &[]Token{}
 	nav := []Navigation{}
@@ -127,13 +126,6 @@ func (r *Review) Review() (PackageReview, error) {
 	}, nil
 }
 
-func (r *Review) index() {
-	for _, m := range r.modules {
-		m.Index()
-	}
-	r.resolveAliases()
-}
-
 // findLocalModule tries to find the source module defining a type in the same repository as
 // the reviewed module. Returns errExternalModule if the source module is in a different repository.
 func (r *Review) findLocalModule(ta TypeAlias) (*Module, error) {