Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions internal/extgen/docs.go
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ package extgen
import (
"bytes"
_ "embed"
"os"
"path/filepath"
"text/template"
)
Expand All @@ -22,6 +23,11 @@ type DocTemplateData struct {

func (dg *DocumentationGenerator) generate() error {
filename := filepath.Join(dg.generator.BuildDir, "README.md")

if _, err := os.Stat(filename); err == nil {
return nil
}

content, err := dg.generateMarkdown()
if err != nil {
return err
Expand Down
36 changes: 36 additions & 0 deletions internal/extgen/docs_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -383,3 +383,39 @@ func BenchmarkDocumentationGenerator_GenerateMarkdown(b *testing.B) {
assert.NoError(b, err)
}
}

func TestDocumentationGenerator_SkipExistingReadme(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")
}
Loading