fix: add guardrail test for unescaped markdown in command descriptions (#549)

* fix: add guardrail test for unescaped markdown in command descriptions

The docgen command parses Long descriptions as Go text/template and
renders them as MDX for the docs site. Unescaped { characters break
the Docusaurus build. This adds a test that walks all commands and
validates their descriptions render correctly, catching issues in CI
rather than at release time.

* style: add comment to docs escape regex in test

Author: mwbrooks

.claude/CLAUDE.md

@@ -229,6 +229,10 @@ Use conventional commit format (feat:, fix:, chore:, etc.) for commit titles.
 5. Run `slack docgen ./docs/reference` to generate docs
 6. Consider adding command alias in `AliasMap` if appropriate
 
+### Command Descriptions and Documentation
+
+Command `Long` descriptions are parsed as Go `text/template` by `docgen` and rendered as MDX for the documentation site. Escape `{` and `[` as `\{` and `\[` in description text to prevent build errors on the docs site. Available template functions: `{{Emoji "name"}}`, `{{LinkText "url"}}`, `{{ToBold "text"}}`.
+
 ### Adding New Dependencies
 
 1. Update `go.mod` with the new module version

cmd/root_test.go

@@ -18,6 +18,7 @@ import (
 	"context"
 	"fmt"
 	"os"
+	"regexp"
 	"strings"
 	"testing"
 
@@ -290,3 +291,29 @@ func testExecCmd(ctx context.Context, args []string) (string, error) {
 	}
 	return clientsMock.GetCombinedOutput(), nil
 }
+
+func Test_CommandDescriptionsRenderForDocs(t *testing.T) {
+	ctx := slackcontext.MockContext(t.Context())
+	tmp, _ := os.MkdirTemp("", "")
+	_ = os.Chdir(tmp)
+	defer os.RemoveAll(tmp)
+
+	cmd, _ := Init(ctx)
+
+	// Matches a lone { that is not escaped (\{) and not part of a Go template ({{)
+	unescapedBrace := regexp.MustCompile(`[^\\{]\{[^{]`)
+
+	var walk func(*cobra.Command)
+	walk = func(c *cobra.Command) {
+		if c.Long != "" {
+			t.Run(c.CommandPath(), func(t *testing.T) {
+				assert.NotRegexp(t, unescapedBrace, c.Long,
+					"description contains unescaped '{' which breaks the MDX docs site; escape as \\{")
+			})
+		}
+		for _, child := range c.Commands() {
+			walk(child)
+		}
+	}
+	walk(cmd)
+}