Add rule maintainability metadata and help patterns topic

Author: jeduden

cmd/mdsmith/main.go

@@ -1,13 +1,15 @@
 package main
 
 import (
+	"encoding/json"
 	"errors"
 	"fmt"
 	"io"
 	"math"
 	"os"
 	"path/filepath"
 	"runtime/debug"
+	"strings"
 
 	flag "github.com/spf13/pflag"
 
@@ -1037,6 +1039,7 @@ Topics:
   kinds                 Show concept page for file kinds
   kinds-cli             Summarize the 'kinds' subcommand surface
   placeholder-grammar   Show placeholder vocabulary reference
+  patterns              Show maintainability patterns across rules
 `
 
 // runHelp implements the "help" subcommand.
@@ -1057,12 +1060,53 @@ func runHelp(args []string) int {
 		return runHelpKindsCLI()
 	case "placeholder-grammar":
 		return runHelpConcept("placeholder-grammar")
+	case "patterns":
+		return runHelpPatterns(args[1:])
 	default:
 		fmt.Fprintf(os.Stderr, "mdsmith: help: unknown topic %q\n", args[0])
 		return 2
 	}
 }
 
+func runHelpPatterns(args []string) int {
+	format := "text"
+	if len(args) >= 2 && (args[0] == "-f" || args[0] == "--format") {
+		format = args[1]
+	}
+	rules, err := ruledocs.ListRules()
+	if err != nil {
+		fmt.Fprintf(os.Stderr, "mdsmith: %v\n", err)
+		return 2
+	}
+	type rec struct {
+		ID            string `json:"id"`
+		Name          string `json:"name"`
+		Signal        string `json:"signal"`
+		Fix           string `json:"fix"`
+		ForDiagnostic bool   `json:"for-diagnostic"`
+	}
+	items := make([]rec, 0)
+	for _, r := range rules {
+		if r.Maintainability == nil {
+			continue
+		}
+		items = append(items, rec{r.ID, r.Name, r.Maintainability.Signal, r.Maintainability.Fix, r.Maintainability.ForDiagnostic})
+	}
+	if format == "json" {
+		enc := json.NewEncoder(os.Stdout)
+		enc.SetIndent("", "  ")
+		if err := enc.Encode(items); err != nil {
+			fmt.Fprintf(os.Stderr, "mdsmith: %v\n", err)
+			return 2
+		}
+		return 0
+	}
+	for _, it := range items {
+		fmt.Printf("%s %s\n  signal: %s\n  fix: %s\n  for-diagnostic: %t\n\n", it.ID, it.Name, it.Signal, it.Fix, it.ForDiagnostic)
+	}
+	return 0
+}
+
 const helpKindsText = `File Kinds
 
 A kind is a named bundle of rule settings that can be applied to a set of
@@ -1192,11 +1236,28 @@ func listAllRules() int {
 }
 
 func showRule(query string) int {
-	content, err := ruledocs.LookupRule(query)
+	rules, err := ruledocs.ListRules()
 	if err != nil {
 		fmt.Fprintf(os.Stderr, "mdsmith: %v\n", err)
 		return 2
 	}
+	var chosen *ruledocs.RuleInfo
+	q := strings.ToUpper(query)
+	for i := range rules {
+		if strings.ToUpper(rules[i].ID) == q || rules[i].Name == query {
+			chosen = &rules[i]
+			break
+		}
+	}
+	if chosen == nil {
+		fmt.Fprintf(os.Stderr, "mdsmith: unknown rule %q\n", query)
+		return 2
+	}
+	content := ruledocs.StripFrontMatter(chosen.Content)
+	if chosen.Maintainability != nil {
+		content += "\n\n## Maintainability pattern\n\n"
+		content += fmt.Sprintf("- Signal: %s\n- Fix: %s\n- For diagnostic: %t\n", chosen.Maintainability.Signal, chosen.Maintainability.Fix, chosen.Maintainability.ForDiagnostic)
+	}
 	fmt.Print(content)
 	return 0
 }

internal/rules/MDS001-line-length/README.md

@@ -4,6 +4,7 @@ name: line-length
 status: ready
 description: Line exceeds maximum length.
 nature: content
+maintainability: null
 ---
 # MDS001: line-length
 

internal/rules/MDS002-heading-style/README.md

@@ -4,6 +4,7 @@ name: heading-style
 status: ready
 description: Heading style must be consistent.
 nature: style
+maintainability: null
 ---
 # MDS002: heading-style
 

internal/rules/MDS003-heading-increment/README.md

@@ -4,6 +4,7 @@ name: heading-increment
 status: ready
 description: Heading levels should increment by one. No jumping from `#` to `###`.
 nature: structure
+maintainability: null
 ---
 # MDS003: heading-increment
 

internal/rules/MDS004-first-line-heading/README.md

@@ -4,6 +4,7 @@ name: first-line-heading
 status: ready
 description: First line of the file should be a heading.
 nature: structure
+maintainability: null
 ---
 # MDS004: first-line-heading
 

internal/rules/MDS005-no-duplicate-headings/README.md

@@ -4,6 +4,7 @@ name: no-duplicate-headings
 status: ready
 description: No two headings should have the same text.
 nature: structure
+maintainability: null
 ---
 # MDS005: no-duplicate-headings
 

internal/rules/MDS006-no-trailing-spaces/README.md

@@ -4,6 +4,7 @@ name: no-trailing-spaces
 status: ready
 description: No trailing whitespace at the end of lines.
 nature: style
+maintainability: null
 ---
 # MDS006: no-trailing-spaces
 

internal/rules/MDS007-no-hard-tabs/README.md

@@ -4,6 +4,7 @@ name: no-hard-tabs
 status: ready
 description: No tab characters. Use spaces instead.
 nature: style
+maintainability: null
 ---
 # MDS007: no-hard-tabs
 

internal/rules/MDS008-no-multiple-blanks/README.md

@@ -4,6 +4,7 @@ name: no-multiple-blanks
 status: ready
 description: No more than one consecutive blank line.
 nature: style
+maintainability: null
 ---
 # MDS008: no-multiple-blanks
 

internal/rules/MDS009-single-trailing-newline/README.md

@@ -4,6 +4,7 @@ name: single-trailing-newline
 status: ready
 description: File must end with exactly one newline character.
 nature: style
+maintainability: null
 ---
 # MDS009: single-trailing-newline