gopls: eliminate the hooks package

Simplify some of the legacy indirection that used to be required when
the bulk of gopls' implementation lived in the x/tools module. We no
longer need to set hooks on the settings.Options; hooked-in
implementations can simply be statically linked.

Remove the settings.Hooks type, and pull the thread as far as it will
go, cleaning up a bunch of unnecessary indirection. As a result, we no
longer need the hooks package.

Change-Id: Ifd71da13174af4b7bc733f97774830ec1d98a2bc
Reviewed-on: https://go-review.googlesource.com/c/tools/+/578039
LUCI-TryBot-Result: Go LUCI <[email protected]>
Reviewed-by: Alan Donovan <[email protected]>

Author: findleyr

gopls/doc/generate.go

@@ -111,7 +111,7 @@ func loadAPI() (*settings.APIJSON, error) {
 	defaults := settings.DefaultOptions()
 	api := &settings.APIJSON{
 		Options:   map[string][]*settings.OptionJSON{},
-		Analyzers: loadAnalyzers(defaults.DefaultAnalyzers), // no staticcheck analyzers
+		Analyzers: loadAnalyzers(settings.DefaultAnalyzers), // no staticcheck analyzers
 	}
 
 	api.Commands, err = loadCommands()
@@ -508,17 +508,17 @@ func loadLenses(commands []*settings.CommandJSON) []*settings.LensJSON {
 func loadAnalyzers(m map[string]*settings.Analyzer) []*settings.AnalyzerJSON {
 	var sorted []string
 	for _, a := range m {
-		sorted = append(sorted, a.Analyzer.Name)
+		sorted = append(sorted, a.Analyzer().Name)
 	}
 	sort.Strings(sorted)
 	var json []*settings.AnalyzerJSON
 	for _, name := range sorted {
 		a := m[name]
 		json = append(json, &settings.AnalyzerJSON{
-			Name:    a.Analyzer.Name,
-			Doc:     a.Analyzer.Doc,
-			URL:     a.Analyzer.URL,
-			Default: a.Enabled,
+			Name:    a.Analyzer().Name,
+			Doc:     a.Analyzer().Doc,
+			URL:     a.Analyzer().URL,
+			Default: a.EnabledByDefault(),
 		})
 	}
 	return json

gopls/internal/cache/analysis.go

@@ -192,30 +192,30 @@ func (s *Snapshot) Analyze(ctx context.Context, pkgs map[PackageID]*metadata.Pac
 	// Filter and sort enabled root analyzers.
 	// A disabled analyzer may still be run if required by another.
 	toSrc := make(map[*analysis.Analyzer]*settings.Analyzer)
-	var enabled []*analysis.Analyzer // enabled subset + transitive requirements
+	var enabledAnalyzers []*analysis.Analyzer // enabled subset + transitive requirements
 	for _, a := range analyzers {
-		if a.IsEnabled(s.Options()) {
-			toSrc[a.Analyzer] = a
-			enabled = append(enabled, a.Analyzer)
+		if enabled, ok := s.Options().Analyses[a.Analyzer().Name]; enabled || !ok && a.EnabledByDefault() {
+			toSrc[a.Analyzer()] = a
+			enabledAnalyzers = append(enabledAnalyzers, a.Analyzer())
 		}
 	}
-	sort.Slice(enabled, func(i, j int) bool {
-		return enabled[i].Name < enabled[j].Name
+	sort.Slice(enabledAnalyzers, func(i, j int) bool {
+		return enabledAnalyzers[i].Name < enabledAnalyzers[j].Name
 	})
 	analyzers = nil // prevent accidental use
 
-	enabled = requiredAnalyzers(enabled)
+	enabledAnalyzers = requiredAnalyzers(enabledAnalyzers)
 
 	// Perform basic sanity checks.
 	// (Ideally we would do this only once.)
-	if err := analysis.Validate(enabled); err != nil {
+	if err := analysis.Validate(enabledAnalyzers); err != nil {
 		return nil, fmt.Errorf("invalid analyzer configuration: %v", err)
 	}
 
 	stableNames := make(map[*analysis.Analyzer]string)
 
 	var facty []*analysis.Analyzer // facty subset of enabled + transitive requirements
-	for _, a := range enabled {
+	for _, a := range enabledAnalyzers {
 		// TODO(adonovan): reject duplicate stable names (very unlikely).
 		stableNames[a] = stableName(a)
 
@@ -317,7 +317,7 @@ func (s *Snapshot) Analyze(ctx context.Context, pkgs map[PackageID]*metadata.Pac
 		if err != nil {
 			return nil, err
 		}
-		root.analyzers = enabled
+		root.analyzers = enabledAnalyzers
 		roots = append(roots, root)
 	}
 
@@ -451,7 +451,7 @@ func (s *Snapshot) Analyze(ctx context.Context, pkgs map[PackageID]*metadata.Pac
 	// results, we should propagate the per-action errors.
 	var results []*Diagnostic
 	for _, root := range roots {
-		for _, a := range enabled {
+		for _, a := range enabledAnalyzers {
 			// Skip analyzers that were added only to
 			// fulfil requirements of the original set.
 			srcAnalyzer, ok := toSrc[a]

gopls/internal/cache/errors.go

@@ -279,7 +279,7 @@ func toSourceDiagnostic(srcAnalyzer *settings.Analyzer, gobDiag *gobDiagnostic)
 		related = append(related, protocol.DiagnosticRelatedInformation(gobRelated))
 	}
 
-	severity := srcAnalyzer.Severity
+	severity := srcAnalyzer.Severity()
 	if severity == 0 {
 		severity = protocol.SeverityWarning
 	}
@@ -293,15 +293,15 @@ func toSourceDiagnostic(srcAnalyzer *settings.Analyzer, gobDiag *gobDiagnostic)
 		Source:   DiagnosticSource(gobDiag.Source),
 		Message:  gobDiag.Message,
 		Related:  related,
-		Tags:     srcAnalyzer.Tag,
+		Tags:     srcAnalyzer.Tags(),
 	}
 
 	// We cross the set of fixes (whether edit- or command-based)
 	// with the set of kinds, as a single fix may represent more
 	// than one kind of action (e.g. refactor, quickfix, fixall),
 	// each corresponding to a distinct client UI element
 	// or operation.
-	kinds := srcAnalyzer.ActionKinds
+	kinds := srcAnalyzer.ActionKinds()
 	if len(kinds) == 0 {
 		kinds = []protocol.CodeActionKind{protocol.QuickFix}
 	}

gopls/internal/cmd/capabilities_test.go

@@ -40,7 +40,7 @@ func TestCapabilities(t *testing.T) {
 	}
 	defer os.RemoveAll(tmpDir)
 
-	app := New(nil)
+	app := New()
 
 	params := &protocol.ParamInitialize{}
 	params.RootURI = protocol.URIFromPath(tmpDir)

gopls/internal/cmd/check.go

@@ -45,7 +45,9 @@ func (c *check) Run(ctx context.Context, args ...string) error {
 	// false. Investigate.
 	origOptions := c.app.options
 	c.app.options = func(opts *settings.Options) {
-		origOptions(opts)
+		if origOptions != nil {
+			origOptions(opts)
+		}
 		opts.RelatedInformationSupported = true
 	}
 

gopls/internal/cmd/cmd.go

@@ -95,9 +95,8 @@ func (app *Application) verbose() bool {
 }
 
 // New returns a new Application ready to run.
-func New(options func(*settings.Options)) *Application {
+func New() *Application {
 	app := &Application{
-		options: options,
 		OCAgent: "off", //TODO: Remove this line to default the exporter to on
 
 		Serve: Serve{

gopls/internal/cmd/codelens.go

@@ -74,7 +74,9 @@ func (r *codelens) Run(ctx context.Context, args ...string) error {
 	// See golang.LensFuncs().
 	origOptions := r.app.options
 	r.app.options = func(opts *settings.Options) {
-		origOptions(opts)
+		if origOptions != nil {
+			origOptions(opts)
+		}
 		if opts.Codelenses == nil {
 			opts.Codelenses = make(map[string]bool)
 		}

gopls/internal/cmd/help_test.go

@@ -32,7 +32,7 @@ const appName = "gopls"
 
 func TestHelpFiles(t *testing.T) {
 	testenv.NeedsGoBuild(t) // This is a lie. We actually need the source code.
-	app := cmd.New(nil)
+	app := cmd.New()
 	ctx := context.Background()
 	for _, page := range append(app.Commands(), app) {
 		t.Run(page.Name(), func(t *testing.T) {
@@ -65,7 +65,7 @@ func TestHelpFiles(t *testing.T) {
 
 func TestVerboseHelp(t *testing.T) {
 	testenv.NeedsGoBuild(t) // This is a lie. We actually need the source code.
-	app := cmd.New(nil)
+	app := cmd.New()
 	ctx := context.Background()
 	var buf bytes.Buffer
 	s := flag.NewFlagSet(appName, flag.ContinueOnError)

gopls/internal/cmd/info.go

@@ -19,6 +19,7 @@ import (
 
 	"golang.org/x/tools/gopls/internal/debug"
 	"golang.org/x/tools/gopls/internal/filecache"
+	licensespkg "golang.org/x/tools/gopls/internal/licenses"
 	"golang.org/x/tools/gopls/internal/settings"
 	"golang.org/x/tools/gopls/internal/util/browser"
 	goplsbug "golang.org/x/tools/gopls/internal/util/bug"
@@ -301,12 +302,11 @@ gopls also includes software made available under these licenses:
 `
 
 func (l *licenses) Run(ctx context.Context, args ...string) error {
-	opts := settings.DefaultOptions(l.app.options)
 	txt := licensePreamble
-	if opts.LicensesText == "" {
+	if licensespkg.Text == "" {
 		txt += "(development gopls, license information not available)"
 	} else {
-		txt += opts.LicensesText
+		txt += licensespkg.Text
 	}
 	fmt.Fprint(os.Stdout, txt)
 	return nil

gopls/internal/cmd/integration_test.go

@@ -40,7 +40,6 @@ import (
 
 	"golang.org/x/tools/gopls/internal/cmd"
 	"golang.org/x/tools/gopls/internal/debug"
-	"golang.org/x/tools/gopls/internal/hooks"
 	"golang.org/x/tools/gopls/internal/protocol"
 	"golang.org/x/tools/gopls/internal/util/bug"
 	"golang.org/x/tools/gopls/internal/version"
@@ -1060,7 +1059,7 @@ func goplsMain() {
 		version.VersionOverride = v
 	}
 
-	tool.Main(context.Background(), cmd.New(hooks.Options), os.Args[1:])
+	tool.Main(context.Background(), cmd.New(), os.Args[1:])
 }
 
 // writeTree extracts a txtar archive into a new directory and returns its path.