Skip to content
Open
Show file tree
Hide file tree
Changes from 2 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
22 changes: 9 additions & 13 deletions caddy/extinit.go
Original file line number Diff line number Diff line change
Expand Up @@ -3,46 +3,42 @@ 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",
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.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")
}

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)}

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
}
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