commit 68a73a6ff064a99a4d7f16e84d1cf59aafb9bc3d
author Hana <hyangah@gmail.com> Tue Nov 17 12:07:23 2020 -0500
committer Hyang-Ah Hana Kim <hyangah@gmail.com> Tue Nov 17 19:33:54 2020 +0000
tree b33e1a1ca77ad481e1b9b6d4634b5d67510e5136
parent a5b2aba65e99792f6bcdc5dbdc20dbb2ec5d91f7

tools/generate.go: recognize markdownDescription field

`markdownDescription` field will be used by all the gopls properties.

For golang/vscode-go#197

Change-Id: I5c4dec896e52f0520f81dd7d857fa876943de6ca
Reviewed-on: https://go-review.googlesource.com/c/vscode-go/+/265742
Trust: Hyang-Ah Hana Kim <hyangah@gmail.com>
Run-TryBot: Hyang-Ah Hana Kim <hyangah@gmail.com>
TryBot-Result: kokoro <noreply+kokoro@google.com>
Reviewed-by: Suzy Mueller <suzmue@golang.org>

tools/generate.go

diff --git a/tools/generate.go b/tools/generate.go
index 4afaca6..76b5ba5 100644
--- a/tools/generate.go
+++ b/tools/generate.go
@@ -38,12 +38,14 @@
 }
 
 type Property struct {
-	Name string
+	name string // Set by us.
 
-	Default     interface{} `json:"default,omitempty"`
-	Description string      `json:"description,omitempty"`
-	Type        interface{} `json:"type,omitempty"`
-	Enum        []string    `json:"enum,omitempty"`
+	// Below are defined in package.json
+	Default             interface{} `json:"default,omitempty"`
+	MarkdownDescription string      `json:"markdownDescription,omitempty"`
+	Description         string      `json:"description,omitempty"`
+	Type                interface{} `json:"type,omitempty"`
+	Enum                []string    `json:"enum,omitempty"`
 }
 
 func main() {
@@ -63,6 +65,7 @@
 	if err := json.Unmarshal(data, pkgJSON); err != nil {
 		log.Fatal(err)
 	}
+
 	rewrite := func(filename string, toAdd []byte) {
 		oldContent, err := ioutil.ReadFile(filename)
 		if err != nil {
@@ -95,7 +98,7 @@
 			base := filepath.Join("docs", filepath.Base(filename))
 			fmt.Printf(`%s have changed in the package.json, but documentation in %s was not updated.
 `, strings.TrimSuffix(base, ".md"), base)
-			os.Exit(1)
+			os.Exit(1) // causes CI to break.
 		}
 	}
 	var b bytes.Buffer
@@ -112,20 +115,19 @@
 
 	var properties []Property
 	for name, p := range pkgJSON.Contributes.Configuration.Properties {
-		properties = append(properties, Property{
-			Name:        name,
-			Default:     p.Default,
-			Description: p.Description,
-			Type:        p.Type,
-			Enum:        p.Enum,
-		})
+		p.name = name
+		properties = append(properties, p)
 	}
 	sort.Slice(properties, func(i, j int) bool {
-		return properties[i].Name < properties[j].Name
+		return properties[i].name < properties[j].name
 	})
 	indent := "&nbsp;&nbsp;"
 	for i, p := range properties {
-		b.WriteString(fmt.Sprintf("### `%s`\n\n%s", p.Name, p.Description))
+		desc := p.Description
+		if p.MarkdownDescription != "" {
+			desc = p.MarkdownDescription
+		}
+		b.WriteString(fmt.Sprintf("### `%s`\n\n%s", p.name, desc))
 		if p.Enum != nil {
 			b.WriteString(fmt.Sprintf("\n\nAllowed Values:`%v`", p.Enum))
 		}