🧹 remove todo comments from docs (#699)

Additionally: - 🐛 Fix field comments in gcp.lr : see commit messages Fixes #598 Co-authored-by: Tim Smith <[email protected]>
mondoohq · Jan 3, 2023 · e0ec1be · e0ec1be
1 parent 5924bd8
commit e0ec1be
Show file tree

Hide file tree

Showing 5 changed files with 27 additions and 12 deletions.
diff --git a/resources/lr/cli/cmd/markdown.go b/resources/lr/cli/cmd/markdown.go
@@ -279,7 +279,8 @@ func (l *lrSchemaRenderer) renderResourcePage(resource *lr.Resource, schema *res
 
 		for k := range basicFields {
 			field := basicFields[k]
-			rows = append(rows, []string{field.ID, renderLrType(field.Type, l.resourceHrefMap), strings.Join(sanitizeComments(comments[k]), ", ")})
+			rows = append(rows, []string{field.ID, renderLrType(field.Type, l.resourceHrefMap),
+				strings.Join(sanitizeComments(comments[k]), ", ")})
 		}
 
 		table := tablewriter.NewWriter(builder)
@@ -360,5 +361,6 @@ func sanitizeComments(c []string) []string {
 	for i := range c {
 		c[i] = strings.TrimPrefix(c[i], "// ")
 	}
+
 	return c
 }
diff --git a/resources/lr/lr.go b/resources/lr/lr.go
@@ -186,18 +186,28 @@ func (r *Resource) GetInitFields() []*Init {
 	return inits
 }
 
-func extractComments(raw []string) (string, string) {
-	if len(raw) == 0 {
-		return "", ""
-	}
-
+func SanitizeComments(raw []string) []string {
+	todoStart := -1
 	for i := range raw {
 		if raw[i] != "" {
 			raw[i] = strings.Trim(raw[i][2:], " \t\n")
 		}
+		if todoStart == -1 && strings.HasPrefix(raw[i], "TODO") {
+			todoStart = i
+		}
+	}
+	if todoStart != -1 {
+		raw = raw[0:todoStart]
 	}
+	return raw
+}
 
+func extractTitleAndDescription(raw []string) (string, string) {
+	if len(raw) == 0 {
+		return "", ""
+	}
 	title, rest := raw[0], raw[1:]
+
 	desc := strings.Join(rest, " ")
 
 	return title, desc
@@ -218,7 +228,8 @@ func Parse(input string) (*LR, error) {
 	for i := range res.Resources {
 		resource := res.Resources[i]
 
-		resource.title, resource.desc = extractComments(resource.Comments)
+		resource.Comments = SanitizeComments(resource.Comments)
+		resource.title, resource.desc = extractTitleAndDescription(resource.Comments)
 		resource.Comments = nil
 
 		// List types have an implicit list field

diff --git a/resources/lr/schema.go b/resources/lr/schema.go
@@ -90,7 +90,8 @@ func resourceFields(r *Resource, ast *LR) map[string]*resources.Field {
 			}
 		}
 
-		title, desc := extractComments(f.Comments)
+		f.Comments = SanitizeComments(f.Comments)
+		title, desc := extractTitleAndDescription(f.Comments)
 		fields[f.BasicField.ID] = &resources.Field{
 			Name:        f.BasicField.ID,
 			Type:        string(f.BasicField.Type.Type(ast)),

diff --git a/resources/packs/gcp/gcp.lr b/resources/packs/gcp/gcp.lr
@@ -542,8 +542,8 @@ private gcp.storage.bucket @defaults("id") {
   location string
   //
   locationType string
-  //
-  projectNumber string // TODO: project number / project id / project name
+  // TODO: project number / project id / project name
+  projectNumber string 
   //
   storageClass string
   //
@@ -585,7 +585,8 @@ private gcp.sql.instance @defaults("name") {
   // Instance state
   state string
   // Project
-  project string // TODO: should this be id or name
+  // TODO: should this be id or name
+  project string 
   // Region
   region string
   // Service account email address

diff --git a/resources/packs/gcp/info/gcp.lr.json b/resources/packs/gcp/info/gcp.lr.json