Merge pull request #116 from barrettj12/flush-index

fix: correctly write index in documentation command

Author: barrettj12

documentation.go

@@ -182,10 +182,9 @@ func (c *documentationCommand) dumpSeveralFiles() error {
 			return err
 		}
 
-		writer := bufio.NewWriter(f)
-		_, err = writer.WriteString(c.commandsIndex())
+		err = c.writeIndex(f)
 		if err != nil {
-			return err
+			return fmt.Errorf("writing index: %w", err)
 		}
 		f.Close()
 	}
@@ -271,9 +270,9 @@ func (c *documentationCommand) dumpEntries(w io.Writer) error {
 	}
 
 	if !c.noIndex {
-		_, err := fmt.Fprintf(w, "%s", c.commandsIndex())
+		err := c.writeIndex(w)
 		if err != nil {
-			return err
+			return fmt.Errorf("writing index: %w", err)
 		}
 	}
 
@@ -310,19 +309,26 @@ func (c *documentationCommand) writeSections(w io.Writer, superCommands []string
 	return nil
 }
 
-func (c *documentationCommand) commandsIndex() string {
-	index := "# Index\n"
+// writeIndex writes the command index to the specified writer.
+func (c *documentationCommand) writeIndex(w io.Writer) error {
+	_, err := fmt.Fprintf(w, "# Index\n")
+	if err != nil {
+		return err
+	}
 
 	listCommands := c.getSortedListCommands()
 	for id, name := range listCommands {
 		if isDefaultCommand(name) {
 			continue
 		}
-		index += fmt.Sprintf("%d. [%s](%s)\n", id, name, c.linkForCommand(name))
+		_, err = fmt.Fprintf(w, "%d. [%s](%s)\n", id, name, c.linkForCommand(name))
+		if err != nil {
+			return err
+		}
 		// TODO: handle subcommands ??
 	}
-	index += "---\n\n"
-	return index
+	_, err = fmt.Fprintf(w, "---\n\n")
+	return err
 }
 
 // Return the URL/location for the given command

documentation_test.go

@@ -2,6 +2,8 @@ package cmd_test
 
 import (
 	"fmt"
+	"os"
+	"path/filepath"
 
 	"github.com/juju/gnuflag"
 	gc "gopkg.in/check.v1"
@@ -209,3 +211,24 @@ formatted YAML-formatted file.
 		c.Check(cmd.EscapeMarkdown(t.input), gc.Equals, t.output)
 	}
 }
+
+// TestWriteIndex checks that the index file is successfully written.
+func (*documentationSuite) TestWriteIndex(c *gc.C) {
+	// Make temp dir to hold docs
+	docsDir := c.MkDir()
+
+	// Create a supercommand and run the documentation command
+	superCmd := cmd.NewSuperCommand(cmd.SuperCommandParams{})
+	superCmd.SetFlags(&gnuflag.FlagSet{})
+	err := superCmd.Init([]string{"documentation", "--split", "--out", docsDir})
+	c.Assert(err, gc.IsNil)
+	err = superCmd.Run(&cmd.Context{})
+	c.Assert(err, gc.IsNil)
+
+	// Check the index file
+	indexPath := filepath.Join(docsDir, "index.md")
+	indexContents, err := os.ReadFile(indexPath)
+	c.Assert(err, gc.IsNil)
+	// Index should be non-empty
+	c.Assert(string(indexContents), gc.Matches, "(?m).*Index.*")
+}