Add lion: documentation extraction tool for Go code

Co-authored-by: neongreen <[email protected]>

Author: Copilot

lion/internal/extractor/extractor.go

@@ -101,7 +101,8 @@ func getEntityName(decl *ast.GenDecl) string {
 	return ""
 }
 
-/*lion:implementation
+/*
+lion:implementation
 extractFromCommentGroup processes a comment group and extracts lion comments.
 
 It supports three formats:
@@ -134,7 +135,7 @@ func extractFromCommentGroup(fset *token.FileSet, cg *ast.CommentGroup, filepath
 						}
 					}
 				}
-				
+
 				// Only use marker-at-end if there are regular comments before the marker
 				if hasOnlyRegularComments {
 					// Extract topic from the last line
@@ -152,12 +153,12 @@ func extractFromCommentGroup(fset *token.FileSet, cg *ast.CommentGroup, filepath
 								}
 							}
 						}
-						
+
 						// Add marker content if provided
 						if markerContent != "" {
 							contentLines = append(contentLines, markerContent)
 						}
-						
+
 						if len(contentLines) > 0 {
 							pos := fset.Position(cg.List[0].Pos())
 							entry := DocEntry{
@@ -175,7 +176,7 @@ func extractFromCommentGroup(fset *token.FileSet, cg *ast.CommentGroup, filepath
 			}
 		}
 	}
-	
+
 	// Otherwise, process comments individually (legacy behavior)
 	topicGroups := make(map[string][]string)
 	topicOrder := []string{}

lion/internal/extractor/extractor_test.go

@@ -359,10 +359,10 @@ type Config struct {
 }
 
 func TestExtractMarkerAtEnd(t *testing.T) {
-tmpDir := t.TempDir()
+	tmpDir := t.TempDir()
 
-// Create test Go file with marker-at-end format
-testFile := filepath.Join(tmpDir, "test.go")
+	// Create test Go file with marker-at-end format
+	testFile := filepath.Join(tmpDir, "test.go")
 	content := `// This is a multi-line comment.
 // It describes the functionality.
 // The lion marker is at the end.
@@ -386,74 +386,74 @@ return &Config{Port: 8080}
 }
 `
 
-if err := os.WriteFile(testFile, []byte(content), 0644); err != nil {
-t.Fatalf("failed to create test file: %v", err)
-}
+	if err := os.WriteFile(testFile, []byte(content), 0644); err != nil {
+		t.Fatalf("failed to create test file: %v", err)
+	}
 
-// Extract documentation
-docs, err := Extract(tmpDir)
-if err != nil {
-t.Fatalf("Extract failed: %v", err)
-}
+	// Extract documentation
+	docs, err := Extract(tmpDir)
+	if err != nil {
+		t.Fatalf("Extract failed: %v", err)
+	}
 
-// Verify topics
-if len(docs) != 2 {
-t.Errorf("expected 2 topics, got %d", len(docs))
-}
+	// Verify topics
+	if len(docs) != 2 {
+		t.Errorf("expected 2 topics, got %d", len(docs))
+	}
 
-// Verify overview content
-overviewEntries := docs["overview"]
-if len(overviewEntries) != 1 {
-t.Errorf("expected 1 overview entry, got %d", len(overviewEntries))
-}
-if len(overviewEntries) > 0 {
-content := overviewEntries[0].Content
-if !strings.Contains(content, "multi-line comment") {
-t.Errorf("overview content missing expected text, got: %q", content)
-}
-if !strings.Contains(content, "lion marker is at the end") {
-t.Errorf("overview content missing expected text, got: %q", content)
-}
-// Should NOT contain the lion marker itself
-if strings.Contains(content, "lion:overview") {
-t.Errorf("overview content should not contain lion marker, got: %q", content)
-}
-}
+	// Verify overview content
+	overviewEntries := docs["overview"]
+	if len(overviewEntries) != 1 {
+		t.Errorf("expected 1 overview entry, got %d", len(overviewEntries))
+	}
+	if len(overviewEntries) > 0 {
+		content := overviewEntries[0].Content
+		if !strings.Contains(content, "multi-line comment") {
+			t.Errorf("overview content missing expected text, got: %q", content)
+		}
+		if !strings.Contains(content, "lion marker is at the end") {
+			t.Errorf("overview content missing expected text, got: %q", content)
+		}
+		// Should NOT contain the lion marker itself
+		if strings.Contains(content, "lion:overview") {
+			t.Errorf("overview content should not contain lion marker, got: %q", content)
+		}
+	}
 
-// Verify api content (should have 2 entries)
-apiEntries := docs["api"]
-if len(apiEntries) != 2 {
-t.Errorf("expected 2 api entries, got %d", len(apiEntries))
-}
+	// Verify api content (should have 2 entries)
+	apiEntries := docs["api"]
+	if len(apiEntries) != 2 {
+		t.Errorf("expected 2 api entries, got %d", len(apiEntries))
+	}
 
-// First api entry (Config struct)
-if len(apiEntries) > 0 {
-content := apiEntries[0].Content
-if !strings.Contains(content, "Config struct holds settings") {
-t.Errorf("api content missing expected text, got: %q", content)
-}
-if !strings.Contains(content, "marker-at-end format") {
-t.Errorf("api content missing expected text, got: %q", content)
-}
-}
+	// First api entry (Config struct)
+	if len(apiEntries) > 0 {
+		content := apiEntries[0].Content
+		if !strings.Contains(content, "Config struct holds settings") {
+			t.Errorf("api content missing expected text, got: %q", content)
+		}
+		if !strings.Contains(content, "marker-at-end format") {
+			t.Errorf("api content missing expected text, got: %q", content)
+		}
+	}
 
-// Second api entry (Initialize function) - should include marker line content
-if len(apiEntries) > 1 {
-content := apiEntries[1].Content
-if !strings.Contains(content, "Initialize creates a new instance") {
-t.Errorf("api content missing expected text, got: %q", content)
-}
-if !strings.Contains(content, "Additional info can go on the marker line") {
-t.Errorf("api content should include marker line content, got: %q", content)
-}
-}
+	// Second api entry (Initialize function) - should include marker line content
+	if len(apiEntries) > 1 {
+		content := apiEntries[1].Content
+		if !strings.Contains(content, "Initialize creates a new instance") {
+			t.Errorf("api content missing expected text, got: %q", content)
+		}
+		if !strings.Contains(content, "Additional info can go on the marker line") {
+			t.Errorf("api content should include marker line content, got: %q", content)
+		}
+	}
 }
 
 func TestMixedCommentFormats(t *testing.T) {
-tmpDir := t.TempDir()
+	tmpDir := t.TempDir()
 
-// Test file that mixes all three formats
-testFile := filepath.Join(tmpDir, "test.go")
+	// Test file that mixes all three formats
+	testFile := filepath.Join(tmpDir, "test.go")
 	content := `// Format 1: Marker at end
 // This uses the cleanest syntax.
 //lion:format1
@@ -474,32 +474,32 @@ func format3example() {}
 func example() {}
 `
 
-if err := os.WriteFile(testFile, []byte(content), 0644); err != nil {
-t.Fatalf("failed to create test file: %v", err)
-}
+	if err := os.WriteFile(testFile, []byte(content), 0644); err != nil {
+		t.Fatalf("failed to create test file: %v", err)
+	}
 
-docs, err := Extract(tmpDir)
-if err != nil {
-t.Fatalf("Extract failed: %v", err)
-}
+	docs, err := Extract(tmpDir)
+	if err != nil {
+		t.Fatalf("Extract failed: %v", err)
+	}
 
-// Should have 3 topics
-if len(docs) != 3 {
-t.Errorf("expected 3 topics, got %d", len(docs))
-}
+	// Should have 3 topics
+	if len(docs) != 3 {
+		t.Errorf("expected 3 topics, got %d", len(docs))
+	}
 
-// Verify format1 has 2 entries
-if len(docs["format1"]) != 2 {
-t.Errorf("expected 2 format1 entries, got %d", len(docs["format1"]))
-}
+	// Verify format1 has 2 entries
+	if len(docs["format1"]) != 2 {
+		t.Errorf("expected 2 format1 entries, got %d", len(docs["format1"]))
+	}
 
-// Verify format2 has 1 entry
-if len(docs["format2"]) != 1 {
-t.Errorf("expected 1 format2 entry, got %d", len(docs["format2"]))
-}
+	// Verify format2 has 1 entry
+	if len(docs["format2"]) != 1 {
+		t.Errorf("expected 1 format2 entry, got %d", len(docs["format2"]))
+	}
 
-// Verify format3 has 1 entry
-if len(docs["format3"]) != 1 {
-t.Errorf("expected 1 format3 entry, got %d", len(docs["format3"]))
-}
+	// Verify format3 has 1 entry
+	if len(docs["format3"]) != 1 {
+		t.Errorf("expected 1 format3 entry, got %d", len(docs["format3"]))
+	}
 }