diff --git a/cmd/present/static/article.css b/cmd/present/base/static/article.css similarity index 100% rename from cmd/present/static/article.css rename to cmd/present/base/static/article.css diff --git a/cmd/present/static/dir.css b/cmd/present/base/static/dir.css similarity index 100% rename from cmd/present/static/dir.css rename to cmd/present/base/static/dir.css diff --git a/cmd/present/static/dir.js b/cmd/present/base/static/dir.js similarity index 100% rename from cmd/present/static/dir.js rename to cmd/present/base/static/dir.js diff --git a/cmd/present/static/favicon.ico b/cmd/present/base/static/favicon.ico similarity index 100% rename from cmd/present/static/favicon.ico rename to cmd/present/base/static/favicon.ico diff --git a/cmd/present/static/jquery-ui.js b/cmd/present/base/static/jquery-ui.js similarity index 100% rename from cmd/present/static/jquery-ui.js rename to cmd/present/base/static/jquery-ui.js diff --git a/cmd/present/static/notes.css b/cmd/present/base/static/notes.css similarity index 100% rename from cmd/present/static/notes.css rename to cmd/present/base/static/notes.css diff --git a/cmd/present/static/notes.js b/cmd/present/base/static/notes.js similarity index 100% rename from cmd/present/static/notes.js rename to cmd/present/base/static/notes.js diff --git a/cmd/present/static/slides.js b/cmd/present/base/static/slides.js similarity index 100% rename from cmd/present/static/slides.js rename to cmd/present/base/static/slides.js diff --git a/cmd/present/static/styles.css b/cmd/present/base/static/styles.css similarity index 100% rename from cmd/present/static/styles.css rename to cmd/present/base/static/styles.css diff --git a/cmd/present/templates/action.tmpl b/cmd/present/base/templates/action.tmpl similarity index 100% rename from cmd/present/templates/action.tmpl rename to cmd/present/base/templates/action.tmpl diff --git a/cmd/present/templates/article.tmpl b/cmd/present/base/templates/article.tmpl similarity index 100% rename from cmd/present/templates/article.tmpl rename to cmd/present/base/templates/article.tmpl diff --git a/cmd/present/templates/dir.tmpl b/cmd/present/base/templates/dir.tmpl similarity index 100% rename from cmd/present/templates/dir.tmpl rename to cmd/present/base/templates/dir.tmpl diff --git a/cmd/present/templates/slides.tmpl b/cmd/present/base/templates/slides.tmpl similarity index 100% rename from cmd/present/templates/slides.tmpl rename to cmd/present/base/templates/slides.tmpl diff --git a/cmd/present/dir.go b/cmd/present/dir.go index 17736ec14ee..0e71aee20d4 100644 --- a/cmd/present/dir.go +++ b/cmd/present/dir.go @@ -7,6 +7,7 @@ package main import ( "html/template" "io" + "io/fs" "log" "net" "net/http" @@ -18,10 +19,6 @@ import ( "golang.org/x/tools/present" ) -func init() { - http.HandleFunc("/", dirHandler) -} - // dirHandler serves a directory listing for the requested path, rooted at *contentPath. func dirHandler(w http.ResponseWriter, r *http.Request) { if r.URL.Path == "/favicon.ico" { @@ -65,9 +62,9 @@ var ( contentTemplate map[string]*template.Template ) -func initTemplates(base string) error { +func initTemplates(fs fs.FS) error { // Locate the template file. - actionTmpl := filepath.Join(base, "templates/action.tmpl") + actionTmpl := "templates/action.tmpl" contentTemplate = make(map[string]*template.Template) @@ -75,19 +72,19 @@ func initTemplates(base string) error { ".slide": "slides.tmpl", ".article": "article.tmpl", } { - contentTmpl = filepath.Join(base, "templates", contentTmpl) + contentTmpl = filepath.Join("templates", contentTmpl) // Read and parse the input. tmpl := present.Template() tmpl = tmpl.Funcs(template.FuncMap{"playable": playable}) - if _, err := tmpl.ParseFiles(actionTmpl, contentTmpl); err != nil { + if _, err := tmpl.ParseFS(fs, actionTmpl, contentTmpl); err != nil { return err } contentTemplate[ext] = tmpl } var err error - dirListTemplate, err = template.ParseFiles(filepath.Join(base, "templates/dir.tmpl")) + dirListTemplate, err = template.ParseFS(fs, "templates/dir.tmpl") return err } diff --git a/cmd/present/main.go b/cmd/present/main.go index cc04c464087..b8d2d86c1c9 100644 --- a/cmd/present/main.go +++ b/cmd/present/main.go @@ -5,9 +5,10 @@ package main import ( + "embed" "flag" "fmt" - "go/build" + "io/fs" "log" "net" "net/http" @@ -50,16 +51,25 @@ func main() { *contentPath = "./content/" } - if *basePath == "" { - p, err := build.Default.Import(basePkg, "", build.FindOnly) + baseFS := func() fs.FS { + if *basePath != "" { + return os.DirFS(*basePath) + } + //go:embed base + var staticFS embed.FS + + // by default, lets use the embedded files. + fs, err := fs.Sub(staticFS, "base") if err != nil { - fmt.Fprintf(os.Stderr, "Couldn't find gopresent files: %v\n", err) - fmt.Fprintf(os.Stderr, basePathMessage, basePkg) - os.Exit(1) + panic(err) } - *basePath = p.Dir - } - err := initTemplates(*basePath) + + return fs + }() + + http.HandleFunc("/", dirHandler) + + err := initTemplates(baseFS) if err != nil { log.Fatalf("Failed to parse templates: %v", err) } @@ -98,8 +108,8 @@ func main() { } } - initPlayground(*basePath, origin) - http.Handle("/static/", http.FileServer(http.Dir(*basePath))) + initPlayground(baseFS, origin) + http.Handle("/static/", http.FileServer(http.FS(baseFS))) if !ln.Addr().(*net.TCPAddr).IP.IsLoopback() && present.PlayEnabled && !*nativeClient && !*usePlayground { diff --git a/cmd/present/play.go b/cmd/present/play.go index 6650b943771..8eb4017e567 100644 --- a/cmd/present/play.go +++ b/cmd/present/play.go @@ -7,6 +7,7 @@ package main import ( "bytes" "fmt" + "io/fs" "io/ioutil" "net/http" "net/url" @@ -31,7 +32,8 @@ var scripts = []string{"jquery.js", "jquery-ui.js", "playground.js", "play.js"} // playScript registers an HTTP handler at /play.js that serves all the // scripts specified by the variable above, and appends a line that // initializes the playground with the specified transport. -func playScript(root, transport string) { +// func playScript(root, transport string) { +func playScript(fs fs.FS, transport string) { modTime := time.Now() var buf bytes.Buffer for _, p := range scripts { @@ -39,10 +41,18 @@ func playScript(root, transport string) { buf.WriteString(s) continue } - b, err := ioutil.ReadFile(filepath.Join(root, "static", p)) + + f, err := fs.Open(filepath.Join("static", p)) + if err != nil { + panic(err) + } + defer f.Close() + + b, err := ioutil.ReadAll(f) if err != nil { panic(err) } + buf.Write(b) } fmt.Fprintf(&buf, "\ninitPlayground(new %v());\n", transport) @@ -53,12 +63,13 @@ func playScript(root, transport string) { }) } -func initPlayground(basepath string, origin *url.URL) { +// func initPlayground(basepath string, origin *url.URL) { +func initPlayground(fs fs.FS, origin *url.URL) { if !present.PlayEnabled { return } if *usePlayground { - playScript(basepath, "HTTPTransport") + playScript(fs, "HTTPTransport") return } @@ -73,7 +84,7 @@ func initPlayground(basepath string, origin *url.URL) { return environ("GOOS=nacl") } } - playScript(basepath, "SocketTransport") + playScript(fs, "SocketTransport") http.Handle("/socket", socket.NewHandler(origin)) } diff --git a/gopls/doc/generate.go b/gopls/doc/generate.go index 416f606f3d1..1eff8b979c5 100644 --- a/gopls/doc/generate.go +++ b/gopls/doc/generate.go @@ -14,14 +14,17 @@ import ( "go/format" "go/token" "go/types" + "io" "io/ioutil" "os" "path/filepath" "reflect" "regexp" "sort" + "strconv" "strings" "time" + "unicode" "github.com/sanity-io/litter" "golang.org/x/tools/go/ast/astutil" @@ -75,18 +78,6 @@ func loadAPI() (*source.APIJSON, error) { Options: map[string][]*source.OptionJSON{}, } defaults := source.DefaultOptions() - for _, cat := range []reflect.Value{ - reflect.ValueOf(defaults.DebuggingOptions), - reflect.ValueOf(defaults.UserOptions), - reflect.ValueOf(defaults.ExperimentalOptions), - } { - opts, err := loadOptions(cat, pkg) - if err != nil { - return nil, err - } - catName := strings.TrimSuffix(cat.Type().Name(), "Options") - api.Options[catName] = opts - } api.Commands, err = loadCommands(pkg) if err != nil { @@ -106,16 +97,57 @@ func loadAPI() (*source.APIJSON, error) { } { api.Analyzers = append(api.Analyzers, loadAnalyzers(m)...) } - return api, nil -} + for _, category := range []reflect.Value{ + reflect.ValueOf(defaults.UserOptions), + } { + // Find the type information and ast.File corresponding to the category. + optsType := pkg.Types.Scope().Lookup(category.Type().Name()) + if optsType == nil { + return nil, fmt.Errorf("could not find %v in scope %v", category.Type().Name(), pkg.Types.Scope()) + } + opts, err := loadOptions(category, optsType, pkg, "") + if err != nil { + return nil, err + } + catName := strings.TrimSuffix(category.Type().Name(), "Options") + api.Options[catName] = opts -func loadOptions(category reflect.Value, pkg *packages.Package) ([]*source.OptionJSON, error) { - // Find the type information and ast.File corresponding to the category. - optsType := pkg.Types.Scope().Lookup(category.Type().Name()) - if optsType == nil { - return nil, fmt.Errorf("could not find %v in scope %v", category.Type().Name(), pkg.Types.Scope()) + // Hardcode the expected values for the analyses and code lenses + // settings, since their keys are not enums. + for _, opt := range opts { + switch opt.Name { + case "analyses": + for _, a := range api.Analyzers { + opt.EnumKeys.Keys = append(opt.EnumKeys.Keys, source.EnumKey{ + Name: fmt.Sprintf("%q", a.Name), + Doc: a.Doc, + Default: strconv.FormatBool(a.Default), + }) + } + case "codelenses": + // Hack: Lenses don't set default values, and we don't want to + // pass in the list of expected lenses to loadOptions. Instead, + // format the defaults using reflection here. The hackiest part + // is reversing lowercasing of the field name. + reflectField := category.FieldByName(upperFirst(opt.Name)) + for _, l := range api.Lenses { + def, err := formatDefaultFromEnumBoolMap(reflectField, l.Lens) + if err != nil { + return nil, err + } + opt.EnumKeys.Keys = append(opt.EnumKeys.Keys, source.EnumKey{ + Name: fmt.Sprintf("%q", l.Lens), + Doc: l.Doc, + Default: def, + }) + } + } + } } + return api, nil +} +func loadOptions(category reflect.Value, optsType types.Object, pkg *packages.Package, hierarchy string) ([]*source.OptionJSON, error) { file, err := fileForPos(pkg, optsType.Pos()) if err != nil { return nil, err @@ -131,6 +163,21 @@ func loadOptions(category reflect.Value, pkg *packages.Package) ([]*source.Optio for i := 0; i < optsStruct.NumFields(); i++ { // The types field gives us the type. typesField := optsStruct.Field(i) + + // If the field name ends with "Options", assume it is a struct with + // additional options and process it recursively. + if h := strings.TrimSuffix(typesField.Name(), "Options"); h != typesField.Name() { + // Keep track of the parent structs. + if hierarchy != "" { + h = hierarchy + "." + h + } + options, err := loadOptions(category, typesField, pkg, strings.ToLower(h)) + if err != nil { + return nil, err + } + opts = append(opts, options...) + continue + } path, _ := astutil.PathEnclosingInterval(file, typesField.Pos(), typesField.Pos()) if len(path) < 2 { return nil, fmt.Errorf("could not find AST node for field %v", typesField) @@ -147,49 +194,48 @@ func loadOptions(category reflect.Value, pkg *packages.Package) ([]*source.Optio return nil, fmt.Errorf("could not find reflect field for %v", typesField.Name()) } - // Format the default value. VSCode exposes settings as JSON, so showing them as JSON is reasonable. - def := reflectField.Interface() - // Durations marshal as nanoseconds, but we want the stringy versions, e.g. "100ms". - if t, ok := def.(time.Duration); ok { - def = t.String() - } - defBytes, err := json.Marshal(def) + def, err := formatDefault(reflectField) if err != nil { return nil, err } - // Nil values format as "null" so print them as hardcoded empty values. - switch reflectField.Type().Kind() { - case reflect.Map: - if reflectField.IsNil() { - defBytes = []byte("{}") - } - case reflect.Slice: - if reflectField.IsNil() { - defBytes = []byte("[]") - } - } - typ := typesField.Type().String() if _, ok := enums[typesField.Type()]; ok { typ = "enum" } + name := lowerFirst(typesField.Name()) - // Track any maps whose keys are enums. - enumValues := enums[typesField.Type()] + var enumKeys source.EnumKeys if m, ok := typesField.Type().(*types.Map); ok { - if e, ok := enums[m.Key()]; ok { - enumValues = e + e, ok := enums[m.Key()] + if ok { typ = strings.Replace(typ, m.Key().String(), m.Key().Underlying().String(), 1) } + keys, err := collectEnumKeys(name, m, reflectField, e) + if err != nil { + return nil, err + } + if keys != nil { + enumKeys = *keys + } } + // Get the status of the field by checking its struct tags. + reflectStructField, ok := category.Type().FieldByName(typesField.Name()) + if !ok { + return nil, fmt.Errorf("no struct field for %s", typesField.Name()) + } + status := reflectStructField.Tag.Get("status") + opts = append(opts, &source.OptionJSON{ - Name: lowerFirst(typesField.Name()), + Name: name, Type: typ, Doc: lowerFirst(astField.Doc.Text()), - Default: string(defBytes), - EnumValues: enumValues, + Default: def, + EnumKeys: enumKeys, + EnumValues: enums[typesField.Type()], + Status: status, + Hierarchy: hierarchy, }) } return opts, nil @@ -220,6 +266,90 @@ func loadEnums(pkg *packages.Package) (map[types.Type][]source.EnumValue, error) return enums, nil } +func collectEnumKeys(name string, m *types.Map, reflectField reflect.Value, enumValues []source.EnumValue) (*source.EnumKeys, error) { + // Make sure the value type gets set for analyses and codelenses + // too. + if len(enumValues) == 0 && !hardcodedEnumKeys(name) { + return nil, nil + } + keys := &source.EnumKeys{ + ValueType: m.Elem().String(), + } + // We can get default values for enum -> bool maps. + var isEnumBoolMap bool + if basic, ok := m.Elem().(*types.Basic); ok && basic.Kind() == types.Bool { + isEnumBoolMap = true + } + for _, v := range enumValues { + var def string + if isEnumBoolMap { + var err error + def, err = formatDefaultFromEnumBoolMap(reflectField, v.Value) + if err != nil { + return nil, err + } + } + keys.Keys = append(keys.Keys, source.EnumKey{ + Name: v.Value, + Doc: v.Doc, + Default: def, + }) + } + return keys, nil +} + +func formatDefaultFromEnumBoolMap(reflectMap reflect.Value, enumKey string) (string, error) { + if reflectMap.Kind() != reflect.Map { + return "", nil + } + name := enumKey + if unquoted, err := strconv.Unquote(name); err == nil { + name = unquoted + } + for _, e := range reflectMap.MapKeys() { + if e.String() == name { + value := reflectMap.MapIndex(e) + if value.Type().Kind() == reflect.Bool { + return formatDefault(value) + } + } + } + // Assume that if the value isn't mentioned in the map, it defaults to + // the default value, false. + return formatDefault(reflect.ValueOf(false)) +} + +// formatDefault formats the default value into a JSON-like string. +// VS Code exposes settings as JSON, so showing them as JSON is reasonable. +// TODO(rstambler): Reconsider this approach, as the VS Code Go generator now +// marshals to JSON. +func formatDefault(reflectField reflect.Value) (string, error) { + def := reflectField.Interface() + + // Durations marshal as nanoseconds, but we want the stringy versions, + // e.g. "100ms". + if t, ok := def.(time.Duration); ok { + def = t.String() + } + defBytes, err := json.Marshal(def) + if err != nil { + return "", err + } + + // Nil values format as "null" so print them as hardcoded empty values. + switch reflectField.Type().Kind() { + case reflect.Map: + if reflectField.IsNil() { + defBytes = []byte("{}") + } + case reflect.Slice: + if reflectField.IsNil() { + defBytes = []byte("[]") + } + } + return string(defBytes), err +} + // valueDoc transforms a docstring documenting an constant identifier to a // docstring documenting its value. // @@ -357,6 +487,13 @@ func lowerFirst(x string) string { return strings.ToLower(x[:1]) + x[1:] } +func upperFirst(x string) string { + if x == "" { + return x + } + return strings.ToUpper(x[:1]) + x[1:] +} + func fileForPos(pkg *packages.Package, pos token.Pos) (*ast.File, error) { fset := pkg.Fset for _, f := range pkg.Syntax { @@ -389,7 +526,7 @@ func rewriteFile(file string, api *source.APIJSON, write bool, rewrite func([]by return true, nil } -func rewriteAPI(input []byte, api *source.APIJSON) ([]byte, error) { +func rewriteAPI(_ []byte, api *source.APIJSON) ([]byte, error) { buf := bytes.NewBuffer(nil) apiStr := litter.Options{ HomePackage: "source", @@ -401,6 +538,7 @@ func rewriteAPI(input []byte, api *source.APIJSON) ([]byte, error) { apiStr = strings.ReplaceAll(apiStr, "&LensJSON", "") apiStr = strings.ReplaceAll(apiStr, "&AnalyzerJSON", "") apiStr = strings.ReplaceAll(apiStr, " EnumValue{", "{") + apiStr = strings.ReplaceAll(apiStr, " EnumKey{", "{") apiBytes, err := format.Source([]byte(apiStr)) if err != nil { return nil, err @@ -411,34 +549,39 @@ func rewriteAPI(input []byte, api *source.APIJSON) ([]byte, error) { var parBreakRE = regexp.MustCompile("\n{2,}") +type optionsGroup struct { + title string + final string + level int + options []*source.OptionJSON +} + func rewriteSettings(doc []byte, api *source.APIJSON) ([]byte, error) { result := doc for category, opts := range api.Options { + groups := collectGroups(opts) + + // First, print a table of contents. section := bytes.NewBuffer(nil) - for _, opt := range opts { - var enumValues strings.Builder - if len(opt.EnumValues) > 0 { - var msg string - if opt.Type == "enum" { - msg = "\nMust be one of:\n\n" - } else { - msg = "\nCan contain any of:\n\n" - } - enumValues.WriteString(msg) - for i, val := range opt.EnumValues { - if val.Doc != "" { - // Don't break the list item by starting a new paragraph. - unbroken := parBreakRE.ReplaceAllString(val.Doc, "\\\n") - fmt.Fprintf(&enumValues, "* %s", unbroken) - } else { - fmt.Fprintf(&enumValues, "* `%s`", val.Value) - } - if i < len(opt.EnumValues)-1 { - fmt.Fprint(&enumValues, "\n") - } - } + fmt.Fprintln(section, "") + for _, h := range groups { + writeBullet(section, h.final, h.level) + } + fmt.Fprintln(section, "") + + // Currently, the settings document has a title and a subtitle, so + // start at level 3 for a header beginning with "###". + baseLevel := 3 + for _, h := range groups { + level := baseLevel + h.level + writeTitle(section, h.final, level) + for _, opt := range h.options { + header := strMultiply("#", level+1) + fmt.Fprintf(section, "%s **%v** *%v*\n\n", header, opt.Name, opt.Type) + writeStatus(section, opt.Status) + enumValues := collectEnums(opt) + fmt.Fprintf(section, "%v%v\nDefault: `%v`.\n\n", opt.Doc, enumValues, opt.Default) } - fmt.Fprintf(section, "### **%v** *%v*\n%v%v\n\nDefault: `%v`.\n", opt.Name, opt.Type, opt.Doc, enumValues.String(), opt.Default) } var err error result, err = replaceSection(result, category, section.Bytes()) @@ -449,11 +592,144 @@ func rewriteSettings(doc []byte, api *source.APIJSON) ([]byte, error) { section := bytes.NewBuffer(nil) for _, lens := range api.Lenses { - fmt.Fprintf(section, "### **%v**\nIdentifier: `%v`\n\n%v\n\n", lens.Title, lens.Lens, lens.Doc) + fmt.Fprintf(section, "### **%v**\n\nIdentifier: `%v`\n\n%v\n", lens.Title, lens.Lens, lens.Doc) } return replaceSection(result, "Lenses", section.Bytes()) } +func collectGroups(opts []*source.OptionJSON) []optionsGroup { + optsByHierarchy := map[string][]*source.OptionJSON{} + for _, opt := range opts { + optsByHierarchy[opt.Hierarchy] = append(optsByHierarchy[opt.Hierarchy], opt) + } + + // As a hack, assume that uncategorized items are less important to + // users and force the empty string to the end of the list. + var containsEmpty bool + var sorted []string + for h := range optsByHierarchy { + if h == "" { + containsEmpty = true + continue + } + sorted = append(sorted, h) + } + sort.Strings(sorted) + if containsEmpty { + sorted = append(sorted, "") + } + var groups []optionsGroup + baseLevel := 0 + for _, h := range sorted { + split := strings.SplitAfter(h, ".") + last := split[len(split)-1] + // Hack to capitalize all of UI. + if last == "ui" { + last = "UI" + } + // A hierarchy may look like "ui.formatting". If "ui" has no + // options of its own, it may not be added to the map, but it + // still needs a heading. + components := strings.Split(h, ".") + for i := 1; i < len(components); i++ { + parent := strings.Join(components[0:i], ".") + if _, ok := optsByHierarchy[parent]; !ok { + groups = append(groups, optionsGroup{ + title: parent, + final: last, + level: baseLevel + i, + }) + } + } + groups = append(groups, optionsGroup{ + title: h, + final: last, + level: baseLevel + strings.Count(h, "."), + options: optsByHierarchy[h], + }) + } + return groups +} + +func collectEnums(opt *source.OptionJSON) string { + var b strings.Builder + write := func(name, doc string, index, len int) { + if doc != "" { + unbroken := parBreakRE.ReplaceAllString(doc, "\\\n") + fmt.Fprintf(&b, "* %s", unbroken) + } else { + fmt.Fprintf(&b, "* `%s`", name) + } + if index < len-1 { + fmt.Fprint(&b, "\n") + } + } + if len(opt.EnumValues) > 0 && opt.Type == "enum" { + b.WriteString("\nMust be one of:\n\n") + for i, val := range opt.EnumValues { + write(val.Value, val.Doc, i, len(opt.EnumValues)) + } + } else if len(opt.EnumKeys.Keys) > 0 && shouldShowEnumKeysInSettings(opt.Name) { + b.WriteString("\nCan contain any of:\n\n") + for i, val := range opt.EnumKeys.Keys { + write(val.Name, val.Doc, i, len(opt.EnumKeys.Keys)) + } + } + return b.String() +} + +func shouldShowEnumKeysInSettings(name string) bool { + // Both of these fields have too many possible options to print. + return !hardcodedEnumKeys(name) +} + +func hardcodedEnumKeys(name string) bool { + return name == "analyses" || name == "codelenses" +} + +func writeBullet(w io.Writer, title string, level int) { + if title == "" { + return + } + // Capitalize the first letter of each title. + prefix := strMultiply(" ", level) + fmt.Fprintf(w, "%s* [%s](#%s)\n", prefix, capitalize(title), strings.ToLower(title)) +} + +func writeTitle(w io.Writer, title string, level int) { + if title == "" { + return + } + // Capitalize the first letter of each title. + fmt.Fprintf(w, "%s %s\n\n", strMultiply("#", level), capitalize(title)) +} + +func writeStatus(section io.Writer, status string) { + switch status { + case "": + case "advanced": + fmt.Fprint(section, "**This is an advanced setting and should not be configured by most `gopls` users.**\n\n") + case "debug": + fmt.Fprint(section, "**This setting is for debugging purposes only.**\n\n") + case "experimental": + fmt.Fprint(section, "**This setting is experimental and may be deleted.**\n\n") + default: + fmt.Fprintf(section, "**Status: %s.**\n\n", status) + } +} + +func capitalize(s string) string { + return string(unicode.ToUpper(rune(s[0]))) + s[1:] +} + +func strMultiply(str string, count int) string { + var result string + for i := 0; i < count; i++ { + result += string(str) + } + return result +} + func rewriteCommands(doc []byte, api *source.APIJSON) ([]byte, error) { section := bytes.NewBuffer(nil) for _, command := range api.Commands { diff --git a/gopls/doc/settings.md b/gopls/doc/settings.md index 5f92dcf58a9..cf465ce3afb 100644 --- a/gopls/doc/settings.md +++ b/gopls/doc/settings.md @@ -2,9 +2,13 @@ -This document describes the global settings for `gopls` inside the editor. The settings block will be called `"gopls"` and contains a collection of controls for `gopls` that the editor is not expected to understand or control. These settings can also be configured differently per workspace folder. +This document describes the global settings for `gopls` inside the editor. +The settings block will be called `"gopls"` and contains a collection of +controls for `gopls` that the editor is not expected to understand or control. +These settings can also be configured differently per workspace folder. -In VSCode, this would be a section in your `settings.json` file that might look like this: +In VSCode, this would be a section in your `settings.json` file that might look +like this: ```json5 "gopls": { @@ -17,92 +21,141 @@ In VSCode, this would be a section in your `settings.json` file that might look Below is the list of settings that are officially supported for `gopls`. +Any settings that are experimental or for debugging purposes are marked as +such. + To enable all experimental features, use **allExperiments: `true`**. You will still be able to independently override specific experimental features. -### **buildFlags** *[]string* + +* [Build](#build) +* [Formatting](#formatting) +* [UI](#ui) + * [Completion](#completion) + * [Diagnostic](#diagnostic) + * [Documentation](#documentation) + * [Navigation](#navigation) + +### Build + +#### **buildFlags** *[]string* + buildFlags is the set of flags passed on to the build system when invoked. It is applied to queries like `go list`, which is used when discovering files. The most common use is to set `-tags`. - Default: `[]`. -### **env** *map[string]string* -env adds environment variables to external commands run by `gopls`, most notably `go list`. +#### **env** *map[string]string* + +env adds environment variables to external commands run by `gopls`, most notably `go list`. Default: `{}`. -### **hoverKind** *enum* -hoverKind controls the information that appears in the hover text. -SingleLine and Structured are intended for use only by authors of editor plugins. -Must be one of: +#### **directoryFilters** *[]string* -* `"FullDocumentation"` -* `"NoDocumentation"` -* `"SingleLine"` -* `"Structured"` is an experimental setting that returns a structured hover format. -This format separates the signature from the documentation, so that the client -can do more manipulation of these fields.\ -This should only be used by clients that support this behavior. +directoryFilters can be used to exclude unwanted directories from the +workspace. By default, all directories are included. Filters are an +operator, `+` to include and `-` to exclude, followed by a path prefix +relative to the workspace folder. They are evaluated in order, and +the last filter that applies to a path controls whether it is included. +The path prefix can be empty, so an initial `-` excludes everything. -* `"SynopsisDocumentation"` +Examples: +Exclude node_modules: `-node_modules` +Include only project_a: `-` (exclude everything), `+project_a` +Include only project_a, but not node_modules inside it: `-`, `+project_a`, `-project_a/node_modules` -Default: `"FullDocumentation"`. -### **usePlaceholders** *bool* -placeholders enables placeholders for function parameters or struct fields in completion responses. +Default: `[]`. + +#### **expandWorkspaceToModule** *bool* + +**This setting is experimental and may be deleted.** + +expandWorkspaceToModule instructs `gopls` to adjust the scope of the +workspace to find the best available module root. `gopls` first looks for +a go.mod file in any parent directory of the workspace folder, expanding +the scope to that directory if it exists. If no viable parent directory is +found, gopls will check if there is exactly one child directory containing +a go.mod file, narrowing the scope to that directory if it exists. + +Default: `true`. + +#### **experimentalWorkspaceModule** *bool* +**This setting is experimental and may be deleted.** + +experimentalWorkspaceModule opts a user into the experimental support +for multi-module workspaces. Default: `false`. -### **linkTarget** *string* -linkTarget controls where documentation links go. -It might be one of: -* `"godoc.org"` -* `"pkg.go.dev"` +#### **experimentalPackageCacheKey** *bool* -If company chooses to use its own `godoc.org`, its address can be used as well. +**This setting is experimental and may be deleted.** +experimentalPackageCacheKey controls whether to use a coarser cache key +for package type information to increase cache hits. This setting removes +the user's environment, build flags, and working directory from the cache +key, which should be a safe change as all relevant inputs into the type +checking pass are already hashed into the key. This is temporarily guarded +by an experiment because caching behavior is subtle and difficult to +comprehensively test. -Default: `"pkg.go.dev"`. -### **local** *string* -local is the equivalent of the `goimports -local` flag, which puts imports beginning with this string after 3rd-party packages. -It should be the prefix of the import path whose imports should be grouped separately. +Default: `true`. + +#### **allowModfileModifications** *bool* + +**This setting is experimental and may be deleted.** + +allowModfileModifications disables -mod=readonly, allowing imports from +out-of-scope modules. This option will eventually be removed. + +Default: `false`. + +#### **allowImplicitNetworkAccess** *bool* + +**This setting is experimental and may be deleted.** + +allowImplicitNetworkAccess disables GOPROXY=off, allowing implicit module +downloads rather than requiring user action. This option will eventually +be removed. + +Default: `false`. + +### Formatting + +#### **local** *string* +local is the equivalent of the `goimports -local` flag, which puts +imports beginning with this string after third-party packages. It should +be the prefix of the import path whose imports should be grouped +separately. Default: `""`. -### **gofumpt** *bool* -gofumpt indicates if we should run gofumpt formatting. +#### **gofumpt** *bool* + +gofumpt indicates if we should run gofumpt formatting. Default: `false`. -### **analyses** *map[string]bool* -analyses specify analyses that the user would like to enable or disable. -A map of the names of analysis passes that should be enabled/disabled. -A full list of analyzers that gopls uses can be found [here](analyzers.md) -Example Usage: -```json5 -... -"analyses": { - "unreachable": false, // Disable the unreachable analyzer. - "unusedparams": true // Enable the unusedparams analyzer. -} -... -``` +### UI +#### **codelenses** *map[string]bool* -Default: `{}`. -### **codelenses** *map[string]bool* -codelenses overrides the enabled/disabled state of code lenses. See the "Code Lenses" -section of settings.md for the list of supported lenses. +codelenses overrides the enabled/disabled state of code lenses. See the +"Code Lenses" section of the +[Settings page](https://github.com/golang/tools/blob/master/gopls/doc/settings.md) +for the list of supported lenses. Example Usage: + ```json5 "gopls": { ... - "codelenses": { + "codelens": { "generate": false, // Don't show the `go generate` lens. "gc_details": true // Show a code lens toggling the display of gc's choices. } @@ -110,94 +163,86 @@ Example Usage: } ``` - Default: `{"gc_details":false,"generate":true,"regenerate_cgo":true,"tidy":true,"upgrade_dependency":true,"vendor":true}`. -### **linksInHover** *bool* -linksInHover toggles the presence of links to documentation in hover. +#### **semanticTokens** *bool* -Default: `true`. -### **importShortcut** *enum* -importShortcut specifies whether import statements should link to -documentation or go to definitions. +**This setting is experimental and may be deleted.** -Must be one of: +semanticTokens controls whether the LSP server will send +semantic tokens to the client. -* `"Both"` -* `"Definition"` -* `"Link"` +Default: `false`. -Default: `"Both"`. -### **matcher** *enum* -matcher sets the algorithm that is used when calculating completion candidates. +#### Completion -Must be one of: +##### **usePlaceholders** *bool* -* `"CaseInsensitive"` -* `"CaseSensitive"` -* `"Fuzzy"` +placeholders enables placeholders for function parameters or struct +fields in completion responses. -Default: `"Fuzzy"`. -### **symbolMatcher** *enum* -symbolMatcher sets the algorithm that is used when finding workspace symbols. +Default: `false`. + +##### **completionBudget** *time.Duration* + +**This setting is for debugging purposes only.** + +completionBudget is the soft latency goal for completion requests. Most +requests finish in a couple milliseconds, but in some cases deep +completions can take much longer. As we use up our budget we +dynamically reduce the search scope to ensure we return timely +results. Zero means unlimited. + +Default: `"100ms"`. + +##### **matcher** *enum* + +**This is an advanced setting and should not be configured by most `gopls` users.** + +matcher sets the algorithm that is used when calculating completion +candidates. Must be one of: * `"CaseInsensitive"` * `"CaseSensitive"` * `"Fuzzy"` - Default: `"Fuzzy"`. -### **symbolStyle** *enum* -symbolStyle controls how symbols are qualified in symbol responses. + +#### Diagnostic + +##### **analyses** *map[string]bool* + +analyses specify analyses that the user would like to enable or disable. +A map of the names of analysis passes that should be enabled/disabled. +A full list of analyzers that gopls uses can be found +[here](https://github.com/golang/tools/blob/master/gopls/doc/analyzers.md). Example Usage: + ```json5 -"gopls": { -... - "symbolStyle": "dynamic", ... +"analyses": { + "unreachable": false, // Disable the unreachable analyzer. + "unusedparams": true // Enable the unusedparams analyzer. } +... ``` -Must be one of: - -* `"Dynamic"` uses whichever qualifier results in the highest scoring -match for the given symbol query. Here a "qualifier" is any "/" or "." -delimited suffix of the fully qualified symbol. i.e. "to/pkg.Foo.Field" or -just "Foo.Field". - -* `"Full"` is fully qualified symbols, i.e. -"path/to/pkg.Foo.Field". - -* `"Package"` is package qualified symbols i.e. -"pkg.Foo.Field". - +Default: `{}`. -Default: `"Dynamic"`. -### **directoryFilters** *[]string* -directoryFilters can be used to exclude unwanted directories from the -workspace. By default, all directories are included. Filters are an -operator, `+` to include and `-` to exclude, followed by a path prefix -relative to the workspace folder. They are evaluated in order, and -the last filter that applies to a path controls whether it is included. -The path prefix can be empty, so an initial `-` excludes everything. +##### **staticcheck** *bool* -Examples: -Exclude node_modules: `-node_modules` -Include only project_a: `-` (exclude everything), `+project_a` -Include only project_a, but not node_modules inside it: `-`, `+project_a`, `-project_a/node_modules` +**This setting is experimental and may be deleted.** +staticcheck enables additional analyses from staticcheck.io. -Default: `[]`. - +Default: `false`. -## Experimental +##### **annotations** *map[string]bool* -The below settings are considered experimental. They may be deprecated or changed in the future. They are typically used to test experimental opt-in features or to disable features. +**This setting is experimental and may be deleted.** - -### **annotations** *map[string]bool* annotations specifies the various kinds of optimization diagnostics that should be reported by the gc_details command. @@ -211,36 +256,12 @@ Can contain any of: * `"nil"` controls nil checks. - Default: `{"bounds":true,"escape":true,"inline":true,"nil":true}`. -### **staticcheck** *bool* -staticcheck enables additional analyses from staticcheck.io. +##### **experimentalDiagnosticsDelay** *time.Duration* -Default: `false`. -### **semanticTokens** *bool* -semanticTokens controls whether the LSP server will send -semantic tokens to the client. - - -Default: `false`. -### **expandWorkspaceToModule** *bool* -expandWorkspaceToModule instructs `gopls` to adjust the scope of the -workspace to find the best available module root. `gopls` first looks for -a go.mod file in any parent directory of the workspace folder, expanding -the scope to that directory if it exists. If no viable parent directory is -found, gopls will check if there is exactly one child directory containing -a go.mod file, narrowing the scope to that directory if it exists. +**This setting is experimental and may be deleted.** - -Default: `true`. -### **experimentalWorkspaceModule** *bool* -experimentalWorkspaceModule opts a user into the experimental support -for multi-module workspaces. - - -Default: `false`. -### **experimentalDiagnosticsDelay** *time.Duration* experimentalDiagnosticsDelay controls the amount of time that gopls waits after the most recent file modification before computing deep diagnostics. Simple diagnostics (parsing and type-checking) are always run immediately @@ -248,100 +269,161 @@ on recently modified packages. This option must be set to a valid duration string, for example `"250ms"`. - Default: `"250ms"`. -### **experimentalPackageCacheKey** *bool* -experimentalPackageCacheKey controls whether to use a coarser cache key -for package type information to increase cache hits. This setting removes -the user's environment, build flags, and working directory from the cache -key, which should be a safe change as all relevant inputs into the type -checking pass are already hashed into the key. This is temporarily guarded -by an experiment because caching behavior is subtle and difficult to -comprehensively test. +#### Documentation + +##### **hoverKind** *enum* + +hoverKind controls the information that appears in the hover text. +SingleLine and Structured are intended for use only by authors of editor plugins. + +Must be one of: + +* `"FullDocumentation"` +* `"NoDocumentation"` +* `"SingleLine"` +* `"Structured"` is an experimental setting that returns a structured hover format. +This format separates the signature from the documentation, so that the client +can do more manipulation of these fields.\ +This should only be used by clients that support this behavior. + +* `"SynopsisDocumentation"` +Default: `"FullDocumentation"`. + +##### **linkTarget** *string* + +linkTarget controls where documentation links go. +It might be one of: + +* `"godoc.org"` +* `"pkg.go.dev"` + +If company chooses to use its own `godoc.org`, its address can be used as well. + +Default: `"pkg.go.dev"`. + +##### **linksInHover** *bool* + +linksInHover toggles the presence of links to documentation in hover. Default: `true`. -### **allowModfileModifications** *bool* -allowModfileModifications disables -mod=readonly, allowing imports from -out-of-scope modules. This option will eventually be removed. +#### Navigation -Default: `false`. -### **allowImplicitNetworkAccess** *bool* -allowImplicitNetworkAccess disables GOPROXY=off, allowing implicit module -downloads rather than requiring user action. This option will eventually -be removed. +##### **importShortcut** *enum* +importShortcut specifies whether import statements should link to +documentation or go to definitions. -Default: `false`. - +Must be one of: -## Debugging +* `"Both"` +* `"Definition"` +* `"Link"` +Default: `"Both"`. -The below settings are for use in debugging `gopls`. Like the experimental options, they may be deprecated or changed in the future. +##### **symbolMatcher** *enum* - -### **verboseOutput** *bool* -verboseOutput enables additional debug logging. +**This is an advanced setting and should not be configured by most `gopls` users.** +symbolMatcher sets the algorithm that is used when finding workspace symbols. -Default: `false`. -### **completionBudget** *time.Duration* -completionBudget is the soft latency goal for completion requests. Most -requests finish in a couple milliseconds, but in some cases deep -completions can take much longer. As we use up our budget we -dynamically reduce the search scope to ensure we return timely -results. Zero means unlimited. +Must be one of: + +* `"CaseInsensitive"` +* `"CaseSensitive"` +* `"Fuzzy"` +Default: `"Fuzzy"`. +##### **symbolStyle** *enum* -Default: `"100ms"`. - +**This is an advanced setting and should not be configured by most `gopls` users.** + +symbolStyle controls how symbols are qualified in symbol responses. + +Example Usage: + +```json5 +"gopls": { +... + "symbolStyle": "dynamic", +... +} +``` + +Must be one of: + +* `"Dynamic"` uses whichever qualifier results in the highest scoring +match for the given symbol query. Here a "qualifier" is any "/" or "." +delimited suffix of the fully qualified symbol. i.e. "to/pkg.Foo.Field" or +just "Foo.Field". + +* `"Full"` is fully qualified symbols, i.e. +"path/to/pkg.Foo.Field". + +* `"Package"` is package qualified symbols i.e. +"pkg.Foo.Field". + +Default: `"Dynamic"`. + +#### **verboseOutput** *bool* + +**This setting is for debugging purposes only.** + +verboseOutput enables additional debug logging. + +Default: `false`. + + ## Code Lenses -These are the code lenses that `gopls` currently supports. They can be enabled and disabled using the `codeLenses` setting, documented above. The names and features are subject to change. +These are the code lenses that `gopls` currently supports. They can be enabled +and disabled using the `codelenses` setting, documented above. Their names and +features are subject to change. ### **Run go generate** + Identifier: `generate` generate runs `go generate` for a given directory. - ### **Regenerate cgo** + Identifier: `regenerate_cgo` regenerate_cgo regenerates cgo definitions. - ### **Run test(s)** + Identifier: `test` test runs `go test` for a specific test function. - ### **Run go mod tidy** + Identifier: `tidy` tidy runs `go mod tidy` for a module. - ### **Upgrade dependency** + Identifier: `upgrade_dependency` upgrade_dependency upgrades a dependency. - ### **Run go mod vendor** + Identifier: `vendor` vendor runs `go mod vendor` for a module. - ### **Toggle gc_details** + Identifier: `gc_details` gc_details controls calculation of gc annotations. - diff --git a/internal/lsp/debug/info.go b/internal/lsp/debug/info.go index d4580190a29..f01c8dd905f 100644 --- a/internal/lsp/debug/info.go +++ b/internal/lsp/debug/info.go @@ -26,7 +26,7 @@ const ( ) // Version is a manually-updated mechanism for tracking versions. -const Version = "master" +var Version = "master" // ServerVersion is the format used by gopls to report its version to the // client. This format is structured so that the client can parse it easily. diff --git a/internal/lsp/source/api_json.go b/internal/lsp/source/api_json.go index e2444e1866b..da164ed8409 100755 --- a/internal/lsp/source/api_json.go +++ b/internal/lsp/source/api_json.go @@ -4,123 +4,119 @@ package source var GeneratedAPIJSON = &APIJSON{ Options: map[string][]*OptionJSON{ - "Debugging": { - { - Name: "verboseOutput", - Type: "bool", - Doc: "verboseOutput enables additional debug logging.\n", - EnumValues: nil, - Default: "false", - }, + "User": { { - Name: "completionBudget", - Type: "time.Duration", - Doc: "completionBudget is the soft latency goal for completion requests. Most\nrequests finish in a couple milliseconds, but in some cases deep\ncompletions can take much longer. As we use up our budget we\ndynamically reduce the search scope to ensure we return timely\nresults. Zero means unlimited.\n", + Name: "buildFlags", + Type: "[]string", + Doc: "buildFlags is the set of flags passed on to the build system when invoked.\nIt is applied to queries like `go list`, which is used when discovering files.\nThe most common use is to set `-tags`.\n", + EnumKeys: EnumKeys{ + ValueType: "", + Keys: nil, + }, EnumValues: nil, - Default: "\"100ms\"", + Default: "[]", + Status: "", + Hierarchy: "build", }, - }, - "Experimental": { { - Name: "annotations", - Type: "map[string]bool", - Doc: "annotations specifies the various kinds of optimization diagnostics\nthat should be reported by the gc_details command.\n", - EnumValues: []EnumValue{ - { - Value: "\"bounds\"", - Doc: "`\"bounds\"` controls bounds checking diagnostics.\n", - }, - { - Value: "\"escape\"", - Doc: "`\"escape\"` controls diagnostics about escape choices.\n", - }, - { - Value: "\"inline\"", - Doc: "`\"inline\"` controls diagnostics about inlining choices.\n", - }, - { - Value: "\"nil\"", - Doc: "`\"nil\"` controls nil checks.\n", - }, + Name: "env", + Type: "map[string]string", + Doc: "env adds environment variables to external commands run by `gopls`, most notably `go list`.\n", + EnumKeys: EnumKeys{ + ValueType: "", + Keys: nil, }, - Default: "{\"bounds\":true,\"escape\":true,\"inline\":true,\"nil\":true}", - }, - { - Name: "staticcheck", - Type: "bool", - Doc: "staticcheck enables additional analyses from staticcheck.io.\n", EnumValues: nil, - Default: "false", + Default: "{}", + Status: "", + Hierarchy: "build", }, { - Name: "semanticTokens", - Type: "bool", - Doc: "semanticTokens controls whether the LSP server will send\nsemantic tokens to the client.\n", + Name: "directoryFilters", + Type: "[]string", + Doc: "directoryFilters can be used to exclude unwanted directories from the\nworkspace. By default, all directories are included. Filters are an\noperator, `+` to include and `-` to exclude, followed by a path prefix\nrelative to the workspace folder. They are evaluated in order, and\nthe last filter that applies to a path controls whether it is included.\nThe path prefix can be empty, so an initial `-` excludes everything.\n\nExamples:\nExclude node_modules: `-node_modules`\nInclude only project_a: `-` (exclude everything), `+project_a`\nInclude only project_a, but not node_modules inside it: `-`, `+project_a`, `-project_a/node_modules`\n", + EnumKeys: EnumKeys{ + ValueType: "", + Keys: nil, + }, EnumValues: nil, - Default: "false", + Default: "[]", + Status: "", + Hierarchy: "build", }, { - Name: "expandWorkspaceToModule", - Type: "bool", - Doc: "expandWorkspaceToModule instructs `gopls` to adjust the scope of the\nworkspace to find the best available module root. `gopls` first looks for\na go.mod file in any parent directory of the workspace folder, expanding\nthe scope to that directory if it exists. If no viable parent directory is\nfound, gopls will check if there is exactly one child directory containing\na go.mod file, narrowing the scope to that directory if it exists.\n", + Name: "expandWorkspaceToModule", + Type: "bool", + Doc: "expandWorkspaceToModule instructs `gopls` to adjust the scope of the\nworkspace to find the best available module root. `gopls` first looks for\na go.mod file in any parent directory of the workspace folder, expanding\nthe scope to that directory if it exists. If no viable parent directory is\nfound, gopls will check if there is exactly one child directory containing\na go.mod file, narrowing the scope to that directory if it exists.\n", + EnumKeys: EnumKeys{ + ValueType: "", + Keys: nil, + }, EnumValues: nil, Default: "true", + Status: "experimental", + Hierarchy: "build", }, { - Name: "experimentalWorkspaceModule", - Type: "bool", - Doc: "experimentalWorkspaceModule opts a user into the experimental support\nfor multi-module workspaces.\n", + Name: "experimentalWorkspaceModule", + Type: "bool", + Doc: "experimentalWorkspaceModule opts a user into the experimental support\nfor multi-module workspaces.\n", + EnumKeys: EnumKeys{ + ValueType: "", + Keys: nil, + }, EnumValues: nil, Default: "false", + Status: "experimental", + Hierarchy: "build", }, { - Name: "experimentalDiagnosticsDelay", - Type: "time.Duration", - Doc: "experimentalDiagnosticsDelay controls the amount of time that gopls waits\nafter the most recent file modification before computing deep diagnostics.\nSimple diagnostics (parsing and type-checking) are always run immediately\non recently modified packages.\n\nThis option must be set to a valid duration string, for example `\"250ms\"`.\n", - EnumValues: nil, - Default: "\"250ms\"", - }, - { - Name: "experimentalPackageCacheKey", - Type: "bool", - Doc: "experimentalPackageCacheKey controls whether to use a coarser cache key\nfor package type information to increase cache hits. This setting removes\nthe user's environment, build flags, and working directory from the cache\nkey, which should be a safe change as all relevant inputs into the type\nchecking pass are already hashed into the key. This is temporarily guarded\nby an experiment because caching behavior is subtle and difficult to\ncomprehensively test.\n", + Name: "experimentalPackageCacheKey", + Type: "bool", + Doc: "experimentalPackageCacheKey controls whether to use a coarser cache key\nfor package type information to increase cache hits. This setting removes\nthe user's environment, build flags, and working directory from the cache\nkey, which should be a safe change as all relevant inputs into the type\nchecking pass are already hashed into the key. This is temporarily guarded\nby an experiment because caching behavior is subtle and difficult to\ncomprehensively test.\n", + EnumKeys: EnumKeys{ + ValueType: "", + Keys: nil, + }, EnumValues: nil, Default: "true", + Status: "experimental", + Hierarchy: "build", }, { - Name: "allowModfileModifications", - Type: "bool", - Doc: "allowModfileModifications disables -mod=readonly, allowing imports from\nout-of-scope modules. This option will eventually be removed.\n", + Name: "allowModfileModifications", + Type: "bool", + Doc: "allowModfileModifications disables -mod=readonly, allowing imports from\nout-of-scope modules. This option will eventually be removed.\n", + EnumKeys: EnumKeys{ + ValueType: "", + Keys: nil, + }, EnumValues: nil, Default: "false", + Status: "experimental", + Hierarchy: "build", }, { - Name: "allowImplicitNetworkAccess", - Type: "bool", - Doc: "allowImplicitNetworkAccess disables GOPROXY=off, allowing implicit module\ndownloads rather than requiring user action. This option will eventually\nbe removed.\n", + Name: "allowImplicitNetworkAccess", + Type: "bool", + Doc: "allowImplicitNetworkAccess disables GOPROXY=off, allowing implicit module\ndownloads rather than requiring user action. This option will eventually\nbe removed.\n", + EnumKeys: EnumKeys{ + ValueType: "", + Keys: nil, + }, EnumValues: nil, Default: "false", - }, - }, - "User": { - { - Name: "buildFlags", - Type: "[]string", - Doc: "buildFlags is the set of flags passed on to the build system when invoked.\nIt is applied to queries like `go list`, which is used when discovering files.\nThe most common use is to set `-tags`.\n", - EnumValues: nil, - Default: "[]", - }, - { - Name: "env", - Type: "map[string]string", - Doc: "env adds environment variables to external commands run by `gopls`, most notably `go list`.\n", - EnumValues: nil, - Default: "{}", + Status: "experimental", + Hierarchy: "build", }, { Name: "hoverKind", Type: "enum", Doc: "hoverKind controls the information that appears in the hover text.\nSingleLine and Structured are intended for use only by authors of editor plugins.\n", + EnumKeys: EnumKeys{ + ValueType: "", + Keys: nil, + }, EnumValues: []EnumValue{ { Value: "\"FullDocumentation\"", @@ -143,101 +139,122 @@ var GeneratedAPIJSON = &APIJSON{ Doc: "", }, }, - Default: "\"FullDocumentation\"", + Default: "\"FullDocumentation\"", + Status: "", + Hierarchy: "ui.documentation", }, { - Name: "usePlaceholders", - Type: "bool", - Doc: "placeholders enables placeholders for function parameters or struct fields in completion responses.\n", - EnumValues: nil, - Default: "false", - }, - { - Name: "linkTarget", - Type: "string", - Doc: "linkTarget controls where documentation links go.\nIt might be one of:\n\n* `\"godoc.org\"`\n* `\"pkg.go.dev\"`\n\nIf company chooses to use its own `godoc.org`, its address can be used as well.\n", + Name: "linkTarget", + Type: "string", + Doc: "linkTarget controls where documentation links go.\nIt might be one of:\n\n* `\"godoc.org\"`\n* `\"pkg.go.dev\"`\n\nIf company chooses to use its own `godoc.org`, its address can be used as well.\n", + EnumKeys: EnumKeys{ + ValueType: "", + Keys: nil, + }, EnumValues: nil, Default: "\"pkg.go.dev\"", + Status: "", + Hierarchy: "ui.documentation", }, { - Name: "local", - Type: "string", - Doc: "local is the equivalent of the `goimports -local` flag, which puts imports beginning with this string after 3rd-party packages.\nIt should be the prefix of the import path whose imports should be grouped separately.\n", + Name: "linksInHover", + Type: "bool", + Doc: "linksInHover toggles the presence of links to documentation in hover.\n", + EnumKeys: EnumKeys{ + ValueType: "", + Keys: nil, + }, EnumValues: nil, - Default: "\"\"", + Default: "true", + Status: "", + Hierarchy: "ui.documentation", }, { - Name: "gofumpt", - Type: "bool", - Doc: "gofumpt indicates if we should run gofumpt formatting.\n", + Name: "usePlaceholders", + Type: "bool", + Doc: "placeholders enables placeholders for function parameters or struct\nfields in completion responses.\n", + EnumKeys: EnumKeys{ + ValueType: "", + Keys: nil, + }, EnumValues: nil, Default: "false", + Status: "", + Hierarchy: "ui.completion", }, { - Name: "analyses", - Type: "map[string]bool", - Doc: "analyses specify analyses that the user would like to enable or disable.\nA map of the names of analysis passes that should be enabled/disabled.\nA full list of analyzers that gopls uses can be found [here](analyzers.md)\n\nExample Usage:\n```json5\n...\n\"analyses\": {\n \"unreachable\": false, // Disable the unreachable analyzer.\n \"unusedparams\": true // Enable the unusedparams analyzer.\n}\n...\n```\n", - EnumValues: nil, - Default: "{}", - }, - { - Name: "codelenses", - Type: "map[string]bool", - Doc: "codelenses overrides the enabled/disabled state of code lenses. See the \"Code Lenses\"\nsection of settings.md for the list of supported lenses.\n\nExample Usage:\n```json5\n\"gopls\": {\n...\n \"codelenses\": {\n \"generate\": false, // Don't show the `go generate` lens.\n \"gc_details\": true // Show a code lens toggling the display of gc's choices.\n }\n...\n}\n```\n", - EnumValues: nil, - Default: "{\"gc_details\":false,\"generate\":true,\"regenerate_cgo\":true,\"tidy\":true,\"upgrade_dependency\":true,\"vendor\":true}", - }, - { - Name: "linksInHover", - Type: "bool", - Doc: "linksInHover toggles the presence of links to documentation in hover.\n", + Name: "completionBudget", + Type: "time.Duration", + Doc: "completionBudget is the soft latency goal for completion requests. Most\nrequests finish in a couple milliseconds, but in some cases deep\ncompletions can take much longer. As we use up our budget we\ndynamically reduce the search scope to ensure we return timely\nresults. Zero means unlimited.\n", + EnumKeys: EnumKeys{ + ValueType: "", + Keys: nil, + }, EnumValues: nil, - Default: "true", + Default: "\"100ms\"", + Status: "debug", + Hierarchy: "ui.completion", }, { - Name: "importShortcut", + Name: "matcher", Type: "enum", - Doc: "importShortcut specifies whether import statements should link to\ndocumentation or go to definitions.\n", + Doc: "matcher sets the algorithm that is used when calculating completion\ncandidates.\n", + EnumKeys: EnumKeys{ + ValueType: "", + Keys: nil, + }, EnumValues: []EnumValue{ { - Value: "\"Both\"", + Value: "\"CaseInsensitive\"", Doc: "", }, { - Value: "\"Definition\"", + Value: "\"CaseSensitive\"", Doc: "", }, { - Value: "\"Link\"", + Value: "\"Fuzzy\"", Doc: "", }, }, - Default: "\"Both\"", + Default: "\"Fuzzy\"", + Status: "advanced", + Hierarchy: "ui.completion", }, { - Name: "matcher", + Name: "importShortcut", Type: "enum", - Doc: "matcher sets the algorithm that is used when calculating completion candidates.\n", + Doc: "importShortcut specifies whether import statements should link to\ndocumentation or go to definitions.\n", + EnumKeys: EnumKeys{ + ValueType: "", + Keys: nil, + }, EnumValues: []EnumValue{ { - Value: "\"CaseInsensitive\"", + Value: "\"Both\"", Doc: "", }, { - Value: "\"CaseSensitive\"", + Value: "\"Definition\"", Doc: "", }, { - Value: "\"Fuzzy\"", + Value: "\"Link\"", Doc: "", }, }, - Default: "\"Fuzzy\"", + Default: "\"Both\"", + Status: "", + Hierarchy: "ui.navigation", }, { Name: "symbolMatcher", Type: "enum", Doc: "symbolMatcher sets the algorithm that is used when finding workspace symbols.\n", + EnumKeys: EnumKeys{ + ValueType: "", + Keys: nil, + }, EnumValues: []EnumValue{ { Value: "\"CaseInsensitive\"", @@ -252,12 +269,18 @@ var GeneratedAPIJSON = &APIJSON{ Doc: "", }, }, - Default: "\"Fuzzy\"", + Default: "\"Fuzzy\"", + Status: "advanced", + Hierarchy: "ui.navigation", }, { Name: "symbolStyle", Type: "enum", - Doc: "symbolStyle controls how symbols are qualified in symbol responses.\n\nExample Usage:\n```json5\n\"gopls\": {\n...\n \"symbolStyle\": \"dynamic\",\n...\n}\n```\n", + Doc: "symbolStyle controls how symbols are qualified in symbol responses.\n\nExample Usage:\n\n```json5\n\"gopls\": {\n...\n \"symbolStyle\": \"dynamic\",\n...\n}\n```\n", + EnumKeys: EnumKeys{ + ValueType: "", + Keys: nil, + }, EnumValues: []EnumValue{ { Value: "\"Dynamic\"", @@ -272,14 +295,379 @@ var GeneratedAPIJSON = &APIJSON{ Doc: "`\"Package\"` is package qualified symbols i.e.\n\"pkg.Foo.Field\".\n", }, }, - Default: "\"Dynamic\"", + Default: "\"Dynamic\"", + Status: "advanced", + Hierarchy: "ui.navigation", }, { - Name: "directoryFilters", - Type: "[]string", - Doc: "directoryFilters can be used to exclude unwanted directories from the\nworkspace. By default, all directories are included. Filters are an\noperator, `+` to include and `-` to exclude, followed by a path prefix\nrelative to the workspace folder. They are evaluated in order, and\nthe last filter that applies to a path controls whether it is included.\nThe path prefix can be empty, so an initial `-` excludes everything.\n\nExamples:\nExclude node_modules: `-node_modules`\nInclude only project_a: `-` (exclude everything), `+project_a`\nInclude only project_a, but not node_modules inside it: `-`, `+project_a`, `-project_a/node_modules`\n", + Name: "analyses", + Type: "map[string]bool", + Doc: "analyses specify analyses that the user would like to enable or disable.\nA map of the names of analysis passes that should be enabled/disabled.\nA full list of analyzers that gopls uses can be found\n[here](https://github.com/golang/tools/blob/master/gopls/doc/analyzers.md).\n\nExample Usage:\n\n```json5\n...\n\"analyses\": {\n \"unreachable\": false, // Disable the unreachable analyzer.\n \"unusedparams\": true // Enable the unusedparams analyzer.\n}\n...\n```\n", + EnumKeys: EnumKeys{ + ValueType: "bool", + Keys: []EnumKey{ + { + Name: "\"asmdecl\"", + Doc: "report mismatches between assembly files and Go declarations", + Default: "true", + }, + { + Name: "\"assign\"", + Doc: "check for useless assignments\n\nThis checker reports assignments of the form x = x or a[i] = a[i].\nThese are almost always useless, and even when they aren't they are\nusually a mistake.", + Default: "true", + }, + { + Name: "\"atomic\"", + Doc: "check for common mistakes using the sync/atomic package\n\nThe atomic checker looks for assignment statements of the form:\n\n\tx = atomic.AddUint64(&x, 1)\n\nwhich are not atomic.", + Default: "true", + }, + { + Name: "\"atomicalign\"", + Doc: "check for non-64-bits-aligned arguments to sync/atomic functions", + Default: "true", + }, + { + Name: "\"bools\"", + Doc: "check for common mistakes involving boolean operators", + Default: "true", + }, + { + Name: "\"buildtag\"", + Doc: "check that +build tags are well-formed and correctly located", + Default: "true", + }, + { + Name: "\"cgocall\"", + Doc: "detect some violations of the cgo pointer passing rules\n\nCheck for invalid cgo pointer passing.\nThis looks for code that uses cgo to call C code passing values\nwhose types are almost always invalid according to the cgo pointer\nsharing rules.\nSpecifically, it warns about attempts to pass a Go chan, map, func,\nor slice to C, either directly, or via a pointer, array, or struct.", + Default: "true", + }, + { + Name: "\"composites\"", + Doc: "check for unkeyed composite literals\n\nThis analyzer reports a diagnostic for composite literals of struct\ntypes imported from another package that do not use the field-keyed\nsyntax. Such literals are fragile because the addition of a new field\n(even if unexported) to the struct will cause compilation to fail.\n\nAs an example,\n\n\terr = &net.DNSConfigError{err}\n\nshould be replaced by:\n\n\terr = &net.DNSConfigError{Err: err}\n", + Default: "true", + }, + { + Name: "\"copylocks\"", + Doc: "check for locks erroneously passed by value\n\nInadvertently copying a value containing a lock, such as sync.Mutex or\nsync.WaitGroup, may cause both copies to malfunction. Generally such\nvalues should be referred to through a pointer.", + Default: "true", + }, + { + Name: "\"deepequalerrors\"", + Doc: "check for calls of reflect.DeepEqual on error values\n\nThe deepequalerrors checker looks for calls of the form:\n\n reflect.DeepEqual(err1, err2)\n\nwhere err1 and err2 are errors. Using reflect.DeepEqual to compare\nerrors is discouraged.", + Default: "true", + }, + { + Name: "\"errorsas\"", + Doc: "report passing non-pointer or non-error values to errors.As\n\nThe errorsas analysis reports calls to errors.As where the type\nof the second argument is not a pointer to a type implementing error.", + Default: "true", + }, + { + Name: "\"fieldalignment\"", + Doc: "find structs that would take less memory if their fields were sorted\n\nThis analyzer find structs that can be rearranged to take less memory, and provides\na suggested edit with the optimal order.\n", + Default: "false", + }, + { + Name: "\"httpresponse\"", + Doc: "check for mistakes using HTTP responses\n\nA common mistake when using the net/http package is to defer a function\ncall to close the http.Response Body before checking the error that\ndetermines whether the response is valid:\n\n\tresp, err := http.Head(url)\n\tdefer resp.Body.Close()\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\t// (defer statement belongs here)\n\nThis checker helps uncover latent nil dereference bugs by reporting a\ndiagnostic for such mistakes.", + Default: "true", + }, + { + Name: "\"ifaceassert\"", + Doc: "detect impossible interface-to-interface type assertions\n\nThis checker flags type assertions v.(T) and corresponding type-switch cases\nin which the static type V of v is an interface that cannot possibly implement\nthe target interface T. This occurs when V and T contain methods with the same\nname but different signatures. Example:\n\n\tvar v interface {\n\t\tRead()\n\t}\n\t_ = v.(io.Reader)\n\nThe Read method in v has a different signature than the Read method in\nio.Reader, so this assertion cannot succeed.\n", + Default: "true", + }, + { + Name: "\"loopclosure\"", + Doc: "check references to loop variables from within nested functions\n\nThis analyzer checks for references to loop variables from within a\nfunction literal inside the loop body. It checks only instances where\nthe function literal is called in a defer or go statement that is the\nlast statement in the loop body, as otherwise we would need whole\nprogram analysis.\n\nFor example:\n\n\tfor i, v := range s {\n\t\tgo func() {\n\t\t\tprintln(i, v) // not what you might expect\n\t\t}()\n\t}\n\nSee: https://golang.org/doc/go_faq.html#closures_and_goroutines", + Default: "true", + }, + { + Name: "\"lostcancel\"", + Doc: "check cancel func returned by context.WithCancel is called\n\nThe cancellation function returned by context.WithCancel, WithTimeout,\nand WithDeadline must be called or the new context will remain live\nuntil its parent context is cancelled.\n(The background context is never cancelled.)", + Default: "true", + }, + { + Name: "\"nilfunc\"", + Doc: "check for useless comparisons between functions and nil\n\nA useless comparison is one like f == nil as opposed to f() == nil.", + Default: "true", + }, + { + Name: "\"printf\"", + Doc: "check consistency of Printf format strings and arguments\n\nThe check applies to known functions (for example, those in package fmt)\nas well as any detected wrappers of known functions.\n\nA function that wants to avail itself of printf checking but is not\nfound by this analyzer's heuristics (for example, due to use of\ndynamic calls) can insert a bogus call:\n\n\tif false {\n\t\t_ = fmt.Sprintf(format, args...) // enable printf checking\n\t}\n\nThe -funcs flag specifies a comma-separated list of names of additional\nknown formatting functions or methods. If the name contains a period,\nit must denote a specific function using one of the following forms:\n\n\tdir/pkg.Function\n\tdir/pkg.Type.Method\n\t(*dir/pkg.Type).Method\n\nOtherwise the name is interpreted as a case-insensitive unqualified\nidentifier such as \"errorf\". Either way, if a listed name ends in f, the\nfunction is assumed to be Printf-like, taking a format string before the\nargument list. Otherwise it is assumed to be Print-like, taking a list\nof arguments with no format string.\n", + Default: "true", + }, + { + Name: "\"shadow\"", + Doc: "check for possible unintended shadowing of variables\n\nThis analyzer check for shadowed variables.\nA shadowed variable is a variable declared in an inner scope\nwith the same name and type as a variable in an outer scope,\nand where the outer variable is mentioned after the inner one\nis declared.\n\n(This definition can be refined; the module generates too many\nfalse positives and is not yet enabled by default.)\n\nFor example:\n\n\tfunc BadRead(f *os.File, buf []byte) error {\n\t\tvar err error\n\t\tfor {\n\t\t\tn, err := f.Read(buf) // shadows the function variable 'err'\n\t\t\tif err != nil {\n\t\t\t\tbreak // causes return of wrong value\n\t\t\t}\n\t\t\tfoo(buf)\n\t\t}\n\t\treturn err\n\t}\n", + Default: "false", + }, + { + Name: "\"shift\"", + Doc: "check for shifts that equal or exceed the width of the integer", + Default: "true", + }, + { + Name: "\"simplifycompositelit\"", + Doc: "check for composite literal simplifications\n\nAn array, slice, or map composite literal of the form:\n\t[]T{T{}, T{}}\nwill be simplified to:\n\t[]T{{}, {}}\n\nThis is one of the simplifications that \"gofmt -s\" applies.", + Default: "true", + }, + { + Name: "\"simplifyrange\"", + Doc: "check for range statement simplifications\n\nA range of the form:\n\tfor x, _ = range v {...}\nwill be simplified to:\n\tfor x = range v {...}\n\nA range of the form:\n\tfor _ = range v {...}\nwill be simplified to:\n\tfor range v {...}\n\nThis is one of the simplifications that \"gofmt -s\" applies.", + Default: "true", + }, + { + Name: "\"simplifyslice\"", + Doc: "check for slice simplifications\n\nA slice expression of the form:\n\ts[a:len(s)]\nwill be simplified to:\n\ts[a:]\n\nThis is one of the simplifications that \"gofmt -s\" applies.", + Default: "true", + }, + { + Name: "\"sortslice\"", + Doc: "check the argument type of sort.Slice\n\nsort.Slice requires an argument of a slice type. Check that\nthe interface{} value passed to sort.Slice is actually a slice.", + Default: "true", + }, + { + Name: "\"stdmethods\"", + Doc: "check signature of methods of well-known interfaces\n\nSometimes a type may be intended to satisfy an interface but may fail to\ndo so because of a mistake in its method signature.\nFor example, the result of this WriteTo method should be (int64, error),\nnot error, to satisfy io.WriterTo:\n\n\ttype myWriterTo struct{...}\n func (myWriterTo) WriteTo(w io.Writer) error { ... }\n\nThis check ensures that each method whose name matches one of several\nwell-known interface methods from the standard library has the correct\nsignature for that interface.\n\nChecked method names include:\n\tFormat GobEncode GobDecode MarshalJSON MarshalXML\n\tPeek ReadByte ReadFrom ReadRune Scan Seek\n\tUnmarshalJSON UnreadByte UnreadRune WriteByte\n\tWriteTo\n", + Default: "true", + }, + { + Name: "\"stringintconv\"", + Doc: "check for string(int) conversions\n\nThis checker flags conversions of the form string(x) where x is an integer\n(but not byte or rune) type. Such conversions are discouraged because they\nreturn the UTF-8 representation of the Unicode code point x, and not a decimal\nstring representation of x as one might expect. Furthermore, if x denotes an\ninvalid code point, the conversion cannot be statically rejected.\n\nFor conversions that intend on using the code point, consider replacing them\nwith string(rune(x)). Otherwise, strconv.Itoa and its equivalents return the\nstring representation of the value in the desired base.\n", + Default: "true", + }, + { + Name: "\"structtag\"", + Doc: "check that struct field tags conform to reflect.StructTag.Get\n\nAlso report certain struct tags (json, xml) used with unexported fields.", + Default: "true", + }, + { + Name: "\"testinggoroutine\"", + Doc: "report calls to (*testing.T).Fatal from goroutines started by a test.\n\nFunctions that abruptly terminate a test, such as the Fatal, Fatalf, FailNow, and\nSkip{,f,Now} methods of *testing.T, must be called from the test goroutine itself.\nThis checker detects calls to these functions that occur within a goroutine\nstarted by the test. For example:\n\nfunc TestFoo(t *testing.T) {\n go func() {\n t.Fatal(\"oops\") // error: (*T).Fatal called from non-test goroutine\n }()\n}\n", + Default: "true", + }, + { + Name: "\"tests\"", + Doc: "check for common mistaken usages of tests and examples\n\nThe tests checker walks Test, Benchmark and Example functions checking\nmalformed names, wrong signatures and examples documenting non-existent\nidentifiers.\n\nPlease see the documentation for package testing in golang.org/pkg/testing\nfor the conventions that are enforced for Tests, Benchmarks, and Examples.", + Default: "true", + }, + { + Name: "\"unmarshal\"", + Doc: "report passing non-pointer or non-interface values to unmarshal\n\nThe unmarshal analysis reports calls to functions such as json.Unmarshal\nin which the argument type is not a pointer or an interface.", + Default: "true", + }, + { + Name: "\"unreachable\"", + Doc: "check for unreachable code\n\nThe unreachable analyzer finds statements that execution can never reach\nbecause they are preceded by an return statement, a call to panic, an\ninfinite loop, or similar constructs.", + Default: "true", + }, + { + Name: "\"unsafeptr\"", + Doc: "check for invalid conversions of uintptr to unsafe.Pointer\n\nThe unsafeptr analyzer reports likely incorrect uses of unsafe.Pointer\nto convert integers to pointers. A conversion from uintptr to\nunsafe.Pointer is invalid if it implies that there is a uintptr-typed\nword in memory that holds a pointer value, because that word will be\ninvisible to stack copying and to the garbage collector.", + Default: "true", + }, + { + Name: "\"unusedparams\"", + Doc: "check for unused parameters of functions\n\nThe unusedparams analyzer checks functions to see if there are\nany parameters that are not being used.\n\nTo reduce false positives it ignores:\n- methods\n- parameters that do not have a name or are underscored\n- functions in test files\n- functions with empty bodies or those with just a return stmt", + Default: "false", + }, + { + Name: "\"unusedresult\"", + Doc: "check for unused results of calls to some functions\n\nSome functions like fmt.Errorf return a result and have no side effects,\nso it is always a mistake to discard the result. This analyzer reports\ncalls to certain functions in which the result of the call is ignored.\n\nThe set of functions may be controlled using flags.", + Default: "true", + }, + { + Name: "\"fillreturns\"", + Doc: "suggested fixes for \"wrong number of return values (want %d, got %d)\"\n\nThis checker provides suggested fixes for type errors of the\ntype \"wrong number of return values (want %d, got %d)\". For example:\n\tfunc m() (int, string, *bool, error) {\n\t\treturn\n\t}\nwill turn into\n\tfunc m() (int, string, *bool, error) {\n\t\treturn 0, \"\", nil, nil\n\t}\n\nThis functionality is similar to https://github.com/sqs/goreturns.\n", + Default: "true", + }, + { + Name: "\"nonewvars\"", + Doc: "suggested fixes for \"no new vars on left side of :=\"\n\nThis checker provides suggested fixes for type errors of the\ntype \"no new vars on left side of :=\". For example:\n\tz := 1\n\tz := 2\nwill turn into\n\tz := 1\n\tz = 2\n", + Default: "true", + }, + { + Name: "\"noresultvalues\"", + Doc: "suggested fixes for \"no result values expected\"\n\nThis checker provides suggested fixes for type errors of the\ntype \"no result values expected\". For example:\n\tfunc z() { return nil }\nwill turn into\n\tfunc z() { return }\n", + Default: "true", + }, + { + Name: "\"undeclaredname\"", + Doc: "suggested fixes for \"undeclared name: <>\"\n\nThis checker provides suggested fixes for type errors of the\ntype \"undeclared name: <>\". It will insert a new statement:\n\"<> := \".", + Default: "true", + }, + { + Name: "\"fillstruct\"", + Doc: "note incomplete struct initializations\n\nThis analyzer provides diagnostics for any struct literals that do not have\nany fields initialized. Because the suggested fix for this analysis is\nexpensive to compute, callers should compute it separately, using the\nSuggestedFix function below.\n", + Default: "true", + }, + }, + }, EnumValues: nil, - Default: "[]", + Default: "{}", + Status: "", + Hierarchy: "ui.diagnostic", + }, + { + Name: "staticcheck", + Type: "bool", + Doc: "staticcheck enables additional analyses from staticcheck.io.\n", + EnumKeys: EnumKeys{ + ValueType: "", + Keys: nil, + }, + EnumValues: nil, + Default: "false", + Status: "experimental", + Hierarchy: "ui.diagnostic", + }, + { + Name: "annotations", + Type: "map[string]bool", + Doc: "annotations specifies the various kinds of optimization diagnostics\nthat should be reported by the gc_details command.\n", + EnumKeys: EnumKeys{ + ValueType: "bool", + Keys: []EnumKey{ + { + Name: "\"bounds\"", + Doc: "`\"bounds\"` controls bounds checking diagnostics.\n", + Default: "true", + }, + { + Name: "\"escape\"", + Doc: "`\"escape\"` controls diagnostics about escape choices.\n", + Default: "true", + }, + { + Name: "\"inline\"", + Doc: "`\"inline\"` controls diagnostics about inlining choices.\n", + Default: "true", + }, + { + Name: "\"nil\"", + Doc: "`\"nil\"` controls nil checks.\n", + Default: "true", + }, + }, + }, + EnumValues: nil, + Default: "{\"bounds\":true,\"escape\":true,\"inline\":true,\"nil\":true}", + Status: "experimental", + Hierarchy: "ui.diagnostic", + }, + { + Name: "experimentalDiagnosticsDelay", + Type: "time.Duration", + Doc: "experimentalDiagnosticsDelay controls the amount of time that gopls waits\nafter the most recent file modification before computing deep diagnostics.\nSimple diagnostics (parsing and type-checking) are always run immediately\non recently modified packages.\n\nThis option must be set to a valid duration string, for example `\"250ms\"`.\n", + EnumKeys: EnumKeys{ + ValueType: "", + Keys: nil, + }, + EnumValues: nil, + Default: "\"250ms\"", + Status: "experimental", + Hierarchy: "ui.diagnostic", + }, + { + Name: "codelenses", + Type: "map[string]bool", + Doc: "codelenses overrides the enabled/disabled state of code lenses. See the\n\"Code Lenses\" section of the\n[Settings page](https://github.com/golang/tools/blob/master/gopls/doc/settings.md)\nfor the list of supported lenses.\n\nExample Usage:\n\n```json5\n\"gopls\": {\n...\n \"codelens\": {\n \"generate\": false, // Don't show the `go generate` lens.\n \"gc_details\": true // Show a code lens toggling the display of gc's choices.\n }\n...\n}\n```\n", + EnumKeys: EnumKeys{ + ValueType: "bool", + Keys: []EnumKey{ + { + Name: "\"generate\"", + Doc: "generate runs `go generate` for a given directory.\n", + Default: "true", + }, + { + Name: "\"regenerate_cgo\"", + Doc: "regenerate_cgo regenerates cgo definitions.\n", + Default: "true", + }, + { + Name: "\"test\"", + Doc: "test runs `go test` for a specific test function.\n", + Default: "false", + }, + { + Name: "\"tidy\"", + Doc: "tidy runs `go mod tidy` for a module.\n", + Default: "true", + }, + { + Name: "\"upgrade_dependency\"", + Doc: "upgrade_dependency upgrades a dependency.\n", + Default: "true", + }, + { + Name: "\"vendor\"", + Doc: "vendor runs `go mod vendor` for a module.\n", + Default: "true", + }, + { + Name: "\"gc_details\"", + Doc: "gc_details controls calculation of gc annotations.\n", + Default: "false", + }, + }, + }, + EnumValues: nil, + Default: "{\"gc_details\":false,\"generate\":true,\"regenerate_cgo\":true,\"tidy\":true,\"upgrade_dependency\":true,\"vendor\":true}", + Status: "", + Hierarchy: "ui", + }, + { + Name: "semanticTokens", + Type: "bool", + Doc: "semanticTokens controls whether the LSP server will send\nsemantic tokens to the client.\n", + EnumKeys: EnumKeys{ + ValueType: "", + Keys: nil, + }, + EnumValues: nil, + Default: "false", + Status: "experimental", + Hierarchy: "ui", + }, + { + Name: "local", + Type: "string", + Doc: "local is the equivalent of the `goimports -local` flag, which puts\nimports beginning with this string after third-party packages. It should\nbe the prefix of the import path whose imports should be grouped\nseparately.\n", + EnumKeys: EnumKeys{ + ValueType: "", + Keys: nil, + }, + EnumValues: nil, + Default: "\"\"", + Status: "", + Hierarchy: "formatting", + }, + { + Name: "gofumpt", + Type: "bool", + Doc: "gofumpt indicates if we should run gofumpt formatting.\n", + EnumKeys: EnumKeys{ + ValueType: "", + Keys: nil, + }, + EnumValues: nil, + Default: "false", + Status: "", + Hierarchy: "formatting", + }, + { + Name: "verboseOutput", + Type: "bool", + Doc: "verboseOutput enables additional debug logging.\n", + EnumKeys: EnumKeys{ + ValueType: "", + Keys: nil, + }, + EnumValues: nil, + Default: "false", + Status: "debug", + Hierarchy: "", }, }, }, diff --git a/internal/lsp/source/options.go b/internal/lsp/source/options.go index b1e7ecd1092..4e208935fda 100644 --- a/internal/lsp/source/options.go +++ b/internal/lsp/source/options.go @@ -64,8 +64,6 @@ var ( defaultOptions *Options ) -//go:generate go run golang.org/x/tools/internal/lsp/source/genapijson -output api_json.go - // DefaultOptions is the options that are used for Gopls execution independent // of any externally provided configuration (LSP initialization, command // invokation, etc.). @@ -102,34 +100,42 @@ func DefaultOptions() *Options { SupportedCommands: commands, }, UserOptions: UserOptions{ - HoverKind: FullDocumentation, - LinkTarget: "pkg.go.dev", - Codelenses: map[string]bool{ - CommandGenerate.Name: true, - CommandRegenerateCgo.Name: true, - CommandTidy.Name: true, - CommandToggleDetails.Name: false, - CommandUpgradeDependency.Name: true, - CommandVendor.Name: true, + BuildOptions: BuildOptions{ + ExpandWorkspaceToModule: true, + ExperimentalPackageCacheKey: true, }, - LinksInHover: true, - ImportShortcut: Both, - Matcher: Fuzzy, - SymbolMatcher: SymbolFuzzy, - SymbolStyle: DynamicSymbols, - }, - DebuggingOptions: DebuggingOptions{ - CompletionBudget: 100 * time.Millisecond, - }, - ExperimentalOptions: ExperimentalOptions{ - ExpandWorkspaceToModule: true, - ExperimentalPackageCacheKey: true, - ExperimentalDiagnosticsDelay: 250 * time.Millisecond, - Annotations: map[Annotation]bool{ - Bounds: true, - Escape: true, - Inline: true, - Nil: true, + UIOptions: UIOptions{ + DiagnosticOptions: DiagnosticOptions{ + ExperimentalDiagnosticsDelay: 250 * time.Millisecond, + Annotations: map[Annotation]bool{ + Bounds: true, + Escape: true, + Inline: true, + Nil: true, + }, + }, + DocumentationOptions: DocumentationOptions{ + HoverKind: FullDocumentation, + LinkTarget: "pkg.go.dev", + LinksInHover: true, + }, + NavigationOptions: NavigationOptions{ + ImportShortcut: Both, + SymbolMatcher: SymbolFuzzy, + SymbolStyle: DynamicSymbols, + }, + CompletionOptions: CompletionOptions{ + Matcher: Fuzzy, + CompletionBudget: 100 * time.Millisecond, + }, + Codelenses: map[string]bool{ + CommandGenerate.Name: true, + CommandRegenerateCgo.Name: true, + CommandTidy.Name: true, + CommandToggleDetails.Name: false, + CommandUpgradeDependency.Name: true, + CommandVendor.Name: true, + }, }, }, InternalOptions: InternalOptions{ @@ -159,8 +165,6 @@ type Options struct { ClientOptions ServerOptions UserOptions - DebuggingOptions - ExperimentalOptions InternalOptions Hooks } @@ -186,9 +190,7 @@ type ServerOptions struct { SupportedCommands []string } -// UserOptions holds custom Gopls configuration (not part of the LSP) that is -// modified by the client. -type UserOptions struct { +type BuildOptions struct { // BuildFlags is the set of flags passed on to the build system when invoked. // It is applied to queries like `go list`, which is used when discovering files. // The most common use is to set `-tags`. @@ -197,13 +199,102 @@ type UserOptions struct { // Env adds environment variables to external commands run by `gopls`, most notably `go list`. Env map[string]string + // DirectoryFilters can be used to exclude unwanted directories from the + // workspace. By default, all directories are included. Filters are an + // operator, `+` to include and `-` to exclude, followed by a path prefix + // relative to the workspace folder. They are evaluated in order, and + // the last filter that applies to a path controls whether it is included. + // The path prefix can be empty, so an initial `-` excludes everything. + // + // Examples: + // Exclude node_modules: `-node_modules` + // Include only project_a: `-` (exclude everything), `+project_a` + // Include only project_a, but not node_modules inside it: `-`, `+project_a`, `-project_a/node_modules` + DirectoryFilters []string + + // ExpandWorkspaceToModule instructs `gopls` to adjust the scope of the + // workspace to find the best available module root. `gopls` first looks for + // a go.mod file in any parent directory of the workspace folder, expanding + // the scope to that directory if it exists. If no viable parent directory is + // found, gopls will check if there is exactly one child directory containing + // a go.mod file, narrowing the scope to that directory if it exists. + ExpandWorkspaceToModule bool `status:"experimental"` + + // ExperimentalWorkspaceModule opts a user into the experimental support + // for multi-module workspaces. + ExperimentalWorkspaceModule bool `status:"experimental"` + + // ExperimentalPackageCacheKey controls whether to use a coarser cache key + // for package type information to increase cache hits. This setting removes + // the user's environment, build flags, and working directory from the cache + // key, which should be a safe change as all relevant inputs into the type + // checking pass are already hashed into the key. This is temporarily guarded + // by an experiment because caching behavior is subtle and difficult to + // comprehensively test. + ExperimentalPackageCacheKey bool `status:"experimental"` + + // AllowModfileModifications disables -mod=readonly, allowing imports from + // out-of-scope modules. This option will eventually be removed. + AllowModfileModifications bool `status:"experimental"` + + // AllowImplicitNetworkAccess disables GOPROXY=off, allowing implicit module + // downloads rather than requiring user action. This option will eventually + // be removed. + AllowImplicitNetworkAccess bool `status:"experimental"` +} + +type UIOptions struct { + DocumentationOptions + CompletionOptions + NavigationOptions + DiagnosticOptions + + // Codelenses overrides the enabled/disabled state of code lenses. See the + // "Code Lenses" section of the + // [Settings page](https://github.com/golang/tools/blob/master/gopls/doc/settings.md) + // for the list of supported lenses. + // + // Example Usage: + // + // ```json5 + // "gopls": { + // ... + // "codelens": { + // "generate": false, // Don't show the `go generate` lens. + // "gc_details": true // Show a code lens toggling the display of gc's choices. + // } + // ... + // } + // ``` + Codelenses map[string]bool + + // SemanticTokens controls whether the LSP server will send + // semantic tokens to the client. + SemanticTokens bool `status:"experimental"` +} + +type CompletionOptions struct { + // Placeholders enables placeholders for function parameters or struct + // fields in completion responses. + UsePlaceholders bool + + // CompletionBudget is the soft latency goal for completion requests. Most + // requests finish in a couple milliseconds, but in some cases deep + // completions can take much longer. As we use up our budget we + // dynamically reduce the search scope to ensure we return timely + // results. Zero means unlimited. + CompletionBudget time.Duration `status:"debug"` + + // Matcher sets the algorithm that is used when calculating completion + // candidates. + Matcher Matcher `status:"advanced"` +} + +type DocumentationOptions struct { // HoverKind controls the information that appears in the hover text. // SingleLine and Structured are intended for use only by authors of editor plugins. HoverKind HoverKind - // Placeholders enables placeholders for function parameters or struct fields in completion responses. - UsePlaceholders bool - // LinkTarget controls where documentation links go. // It might be one of: // @@ -213,18 +304,29 @@ type UserOptions struct { // If company chooses to use its own `godoc.org`, its address can be used as well. LinkTarget string - // Local is the equivalent of the `goimports -local` flag, which puts imports beginning with this string after 3rd-party packages. - // It should be the prefix of the import path whose imports should be grouped separately. + // LinksInHover toggles the presence of links to documentation in hover. + LinksInHover bool +} + +type FormattingOptions struct { + // Local is the equivalent of the `goimports -local` flag, which puts + // imports beginning with this string after third-party packages. It should + // be the prefix of the import path whose imports should be grouped + // separately. Local string // Gofumpt indicates if we should run gofumpt formatting. Gofumpt bool +} +type DiagnosticOptions struct { // Analyses specify analyses that the user would like to enable or disable. // A map of the names of analysis passes that should be enabled/disabled. - // A full list of analyzers that gopls uses can be found [here](analyzers.md) + // A full list of analyzers that gopls uses can be found + // [here](https://github.com/golang/tools/blob/master/gopls/doc/analyzers.md). // // Example Usage: + // // ```json5 // ... // "analyses": { @@ -235,38 +337,34 @@ type UserOptions struct { // ``` Analyses map[string]bool - // Codelenses overrides the enabled/disabled state of code lenses. See the "Code Lenses" - // section of settings.md for the list of supported lenses. - // - // Example Usage: - // ```json5 - // "gopls": { - // ... - // "codelenses": { - // "generate": false, // Don't show the `go generate` lens. - // "gc_details": true // Show a code lens toggling the display of gc's choices. - // } - // ... - // } - // ``` - Codelenses map[string]bool + // Staticcheck enables additional analyses from staticcheck.io. + Staticcheck bool `status:"experimental"` - // LinksInHover toggles the presence of links to documentation in hover. - LinksInHover bool + // Annotations specifies the various kinds of optimization diagnostics + // that should be reported by the gc_details command. + Annotations map[Annotation]bool `status:"experimental"` + + // ExperimentalDiagnosticsDelay controls the amount of time that gopls waits + // after the most recent file modification before computing deep diagnostics. + // Simple diagnostics (parsing and type-checking) are always run immediately + // on recently modified packages. + // + // This option must be set to a valid duration string, for example `"250ms"`. + ExperimentalDiagnosticsDelay time.Duration `status:"experimental"` +} +type NavigationOptions struct { // ImportShortcut specifies whether import statements should link to // documentation or go to definitions. ImportShortcut ImportShortcut - // Matcher sets the algorithm that is used when calculating completion candidates. - Matcher Matcher - // SymbolMatcher sets the algorithm that is used when finding workspace symbols. - SymbolMatcher SymbolMatcher + SymbolMatcher SymbolMatcher `status:"advanced"` // SymbolStyle controls how symbols are qualified in symbol responses. // // Example Usage: + // // ```json5 // "gopls": { // ... @@ -274,20 +372,18 @@ type UserOptions struct { // ... // } // ``` - SymbolStyle SymbolStyle + SymbolStyle SymbolStyle `status:"advanced"` +} - // DirectoryFilters can be used to exclude unwanted directories from the - // workspace. By default, all directories are included. Filters are an - // operator, `+` to include and `-` to exclude, followed by a path prefix - // relative to the workspace folder. They are evaluated in order, and - // the last filter that applies to a path controls whether it is included. - // The path prefix can be empty, so an initial `-` excludes everything. - // - // Examples: - // Exclude node_modules: `-node_modules` - // Include only project_a: `-` (exclude everything), `+project_a` - // Include only project_a, but not node_modules inside it: `-`, `+project_a`, `-project_a/node_modules` - DirectoryFilters []string +// UserOptions holds custom Gopls configuration (not part of the LSP) that is +// modified by the client. +type UserOptions struct { + BuildOptions + UIOptions + FormattingOptions + + // VerboseOutput enables additional debug logging. + VerboseOutput bool `status:"debug"` } // EnvSlice returns Env as a slice of k=v strings. @@ -324,75 +420,6 @@ type Hooks struct { StaticcheckAnalyzers map[string]Analyzer } -// ExperimentalOptions defines configuration for features under active -// development. WARNING: This configuration will be changed in the future. It -// only exists while these features are under development. -type ExperimentalOptions struct { - - // Annotations specifies the various kinds of optimization diagnostics - // that should be reported by the gc_details command. - Annotations map[Annotation]bool - - // Staticcheck enables additional analyses from staticcheck.io. - Staticcheck bool - - // SemanticTokens controls whether the LSP server will send - // semantic tokens to the client. - SemanticTokens bool - - // ExpandWorkspaceToModule instructs `gopls` to adjust the scope of the - // workspace to find the best available module root. `gopls` first looks for - // a go.mod file in any parent directory of the workspace folder, expanding - // the scope to that directory if it exists. If no viable parent directory is - // found, gopls will check if there is exactly one child directory containing - // a go.mod file, narrowing the scope to that directory if it exists. - ExpandWorkspaceToModule bool - - // ExperimentalWorkspaceModule opts a user into the experimental support - // for multi-module workspaces. - ExperimentalWorkspaceModule bool - - // ExperimentalDiagnosticsDelay controls the amount of time that gopls waits - // after the most recent file modification before computing deep diagnostics. - // Simple diagnostics (parsing and type-checking) are always run immediately - // on recently modified packages. - // - // This option must be set to a valid duration string, for example `"250ms"`. - ExperimentalDiagnosticsDelay time.Duration - - // ExperimentalPackageCacheKey controls whether to use a coarser cache key - // for package type information to increase cache hits. This setting removes - // the user's environment, build flags, and working directory from the cache - // key, which should be a safe change as all relevant inputs into the type - // checking pass are already hashed into the key. This is temporarily guarded - // by an experiment because caching behavior is subtle and difficult to - // comprehensively test. - ExperimentalPackageCacheKey bool - - // AllowModfileModifications disables -mod=readonly, allowing imports from - // out-of-scope modules. This option will eventually be removed. - AllowModfileModifications bool - - // AllowImplicitNetworkAccess disables GOPROXY=off, allowing implicit module - // downloads rather than requiring user action. This option will eventually - // be removed. - AllowImplicitNetworkAccess bool -} - -// DebuggingOptions should not affect the logical execution of Gopls, but may -// be altered for debugging purposes. -type DebuggingOptions struct { - // VerboseOutput enables additional debug logging. - VerboseOutput bool - - // CompletionBudget is the soft latency goal for completion requests. Most - // requests finish in a couple milliseconds, but in some cases deep - // completions can take much longer. As we use up our budget we - // dynamically reduce the search scope to ensure we return timely - // results. Zero means unlimited. - CompletionBudget time.Duration -} - // InternalOptions contains settings that are not intended for use by the // average user. These may be settings used by tests or outdated settings that // will soon be deprecated. Some of these settings may not even be configurable @@ -544,8 +571,9 @@ func SetOptions(options *Options, opts interface{}) OptionResults { options.enableAllExperiments() } } + seen := map[string]struct{}{} for name, value := range opts { - results = append(results, options.set(name, value)) + results = append(results, options.set(name, value, seen)) } // Finally, enable any experimental features that are specified in // maps, which allows users to individually toggle them on or off. @@ -589,10 +617,8 @@ func (o *Options) ForClientCapabilities(caps protocol.ClientCapabilities) { func (o *Options) Clone() *Options { result := &Options{ - ClientOptions: o.ClientOptions, - DebuggingOptions: o.DebuggingOptions, - ExperimentalOptions: o.ExperimentalOptions, - InternalOptions: o.InternalOptions, + ClientOptions: o.ClientOptions, + InternalOptions: o.InternalOptions, Hooks: Hooks{ GoDiff: o.Hooks.GoDiff, ComputeEdits: o.Hooks.ComputeEdits, @@ -657,8 +683,17 @@ func (o *Options) enableAllExperimentMaps() { } } -func (o *Options) set(name string, value interface{}) OptionResult { +func (o *Options) set(name string, value interface{}, seen map[string]struct{}) OptionResult { + // Flatten the name in case we get options with a hierarchy. + split := strings.Split(name, ".") + name = split[len(split)-1] + result := OptionResult{Name: name, Value: value} + if _, ok := seen[name]; ok { + result.errorf("duplicate configuration for %s", name) + } + seen[name] = struct{}{} + switch name { case "env": menv, ok := value.(map[string]interface{}) @@ -1131,8 +1166,22 @@ type OptionJSON struct { Name string Type string Doc string + EnumKeys EnumKeys EnumValues []EnumValue Default string + Status string + Hierarchy string +} + +type EnumKeys struct { + ValueType string + Keys []EnumKey +} + +type EnumKey struct { + Name string + Doc string + Default string } type EnumValue struct { diff --git a/internal/lsp/source/options_test.go b/internal/lsp/source/options_test.go index dd03044678f..83cb7959e8e 100644 --- a/internal/lsp/source/options_test.go +++ b/internal/lsp/source/options_test.go @@ -88,6 +88,13 @@ func TestSetOption(t *testing.T) { return o.HoverKind == Structured }, }, + { + name: "ui.documentation.hoverKind", + value: "Structured", + check: func(o Options) bool { + return o.HoverKind == Structured + }, + }, { name: "matcher", value: "Fuzzy", @@ -163,7 +170,7 @@ func TestSetOption(t *testing.T) { for _, test := range tests { var opts Options - result := opts.set(test.name, test.value) + result := opts.set(test.name, test.value, map[string]struct{}{}) if (result.Error != nil) != test.wantError { t.Fatalf("Options.set(%q, %v): result.Error = %v, want error: %t", test.name, test.value, result.Error, test.wantError) }