add overwrite-readme flag to extension-init command

Author: IndraGunawan

caddy/extinit.go

@@ -3,46 +3,49 @@ package caddy
 import (
 	"errors"
 	"log"
-	"os"
 	"path/filepath"
 	"strings"
 
-	"github.com/dunglas/frankenphp/internal/extgen"
-
 	caddycmd "github.com/caddyserver/caddy/v2/cmd"
+	"github.com/dunglas/frankenphp/internal/extgen"
 	"github.com/spf13/cobra"
 )
 
 func init() {
 	caddycmd.RegisterCommand(caddycmd.Command{
 		Name:  "extension-init",
-		Usage: "go_extension.go [--verbose]",
+		Usage: "go_extension.go [--overwrite-readme]",
 		Short: "Initializes a PHP extension from a Go file (EXPERIMENTAL)",
 		Long: `
 Initializes a PHP extension from a Go file. This command generates the necessary C files for the extension, including the header and source files, as well as the arginfo file.`,
 		CobraFunc: func(cmd *cobra.Command) {
-			cmd.Flags().BoolP("debug", "v", false, "Enable verbose debug logs")
+			cmd.Flags().BoolP("overwrite-readme", "r", false, "Overwrite README.md if it exists")
 
-			cmd.RunE = caddycmd.WrapCommandFuncForCobra(cmdInitExtension)
+			cmd.RunE = cmdInitExtension
 		},
 	})
 }
 
-func cmdInitExtension(_ caddycmd.Flags) (int, error) {
-	if len(os.Args) < 3 {
-		return 1, errors.New("the path to the Go source is required")
+func cmdInitExtension(cmd *cobra.Command, args []string) error {
+	if len(args) == 0 {
+		return errors.New("the path to the Go source is required")
+	}
+
+	overwriteReadme, err := cmd.Flags().GetBool("overwrite-readme")
+	if err != nil {
+		return err
 	}
 
-	sourceFile := os.Args[2]
+	sourceFile := args[0]
 	baseName := extgen.SanitizePackageName(strings.TrimSuffix(filepath.Base(sourceFile), ".go"))
 
-	generator := extgen.Generator{BaseName: baseName, SourceFile: sourceFile, BuildDir: filepath.Dir(sourceFile)}
+	generator := extgen.Generator{BaseName: baseName, SourceFile: sourceFile, BuildDir: filepath.Dir(sourceFile), OverwriteReadme: overwriteReadme}
 
 	if err := generator.Generate(); err != nil {
-		return 1, err
+		return err
 	}
 
 	log.Printf("PHP extension %q initialized successfully in directory %q", baseName, generator.BuildDir)
 
-	return 0, nil
+	return nil
 }

internal/extgen/docs.go

@@ -3,6 +3,7 @@ package extgen
 import (
 	"bytes"
 	_ "embed"
+	"os"
 	"path/filepath"
 	"text/template"
 )
@@ -12,6 +13,7 @@ var docFileContent string
 
 type DocumentationGenerator struct {
 	generator *Generator
+	overwrite bool
 }
 
 type DocTemplateData struct {
@@ -22,6 +24,11 @@ type DocTemplateData struct {
 
 func (dg *DocumentationGenerator) generate() error {
 	filename := filepath.Join(dg.generator.BuildDir, "README.md")
+
+	if _, err := os.Stat(filename); err == nil && !dg.overwrite {
+		return nil
+	}
+
 	content, err := dg.generateMarkdown()
 	if err != nil {
 		return err

internal/extgen/docs_test.go

@@ -383,3 +383,66 @@ func BenchmarkDocumentationGenerator_GenerateMarkdown(b *testing.B) {
 		assert.NoError(b, err)
 	}
 }
+
+func TestDocumentationGenerator_OverwriteReadme(t *testing.T) {
+	tempDir := t.TempDir()
+	readmePath := filepath.Join(tempDir, "README.md")
+
+	err := os.WriteFile(readmePath, []byte("hello"), 0644)
+	require.NoError(t, err)
+
+	generator := &Generator{
+		BaseName: "testextension",
+		BuildDir: tempDir,
+		Functions: []phpFunction{
+			{
+				Name:       "greet",
+				ReturnType: phpString,
+				Params: []phpParameter{
+					{Name: "name", PhpType: phpString},
+				},
+				Signature: "greet(string $name): string",
+			},
+		},
+		Classes: []phpClass{},
+	}
+
+	docGen := &DocumentationGenerator{
+		generator: generator,
+	}
+
+	err = docGen.generate()
+	assert.NoError(t, err, "generate() unexpected error")
+
+	content, err := os.ReadFile(readmePath)
+	require.NoError(t, err, "Failed to read generated README.md")
+
+	assert.Equal(t, string(content), "hello")
+
+	// regenerate
+	docGen = &DocumentationGenerator{
+		generator: generator,
+		overwrite: true,
+	}
+
+	err = docGen.generate()
+	assert.NoError(t, err, "generate() unexpected error")
+
+	content, err = os.ReadFile(readmePath)
+	require.NoError(t, err, "Failed to read generated README.md")
+
+	contentStr := string(content)
+
+	assert.Contains(t, contentStr, "# testextension Extension", "README should contain extension title")
+	assert.Contains(t, contentStr, "Auto-generated PHP extension from Go code.", "README should contain description")
+
+	if len(generator.Functions) > 0 {
+		assert.Contains(t, contentStr, "## Functions", "README should contain functions section when functions exist")
+
+		for _, fn := range generator.Functions {
+			assert.Contains(t, contentStr, "### "+fn.Name, "README should contain function %s", fn.Name)
+			assert.Contains(t, contentStr, fn.Signature, "README should contain function signature for %s", fn.Name)
+		}
+	}
+
+}

internal/extgen/generator.go

@@ -6,13 +6,14 @@ import (
 )
 
 type Generator struct {
-	BaseName   string
-	SourceFile string
-	BuildDir   string
-	Functions  []phpFunction
-	Classes    []phpClass
-	Constants  []phpConstant
-	Namespace  string
+	BaseName        string
+	SourceFile      string
+	BuildDir        string
+	Functions       []phpFunction
+	Classes         []phpClass
+	Constants       []phpConstant
+	Namespace       string
+	OverwriteReadme bool
 }
 
 // EXPERIMENTAL
@@ -129,7 +130,10 @@ func (g *Generator) generateGoFile() error {
 }
 
 func (g *Generator) generateDocumentation() error {
-	docGen := DocumentationGenerator{g}
+	docGen := DocumentationGenerator{
+		generator: g,
+		overwrite: g.OverwriteReadme,
+	}
 	if err := docGen.generate(); err != nil {
 		return &GeneratorError{"documentation generation", "failed to generate documentation", err}
 	}