feat: add debug flag to vipsgen command (#20)

* readme

* readme

* funding

* chore: CI badge

* clean up logs

* clean up logs

* clean up logs

* readme

* debug flag

* debug flag

* go doc

Author: cshum

.github/FUNDING.yml

@@ -0,0 +1 @@
+github: cshum

.gitignore

@@ -9,9 +9,5 @@ tmp/
 .env
 bin/vipsgen
 profile.cov
-
-repomix-output.xml
-
-debug_enums.json
-debug_operations.json
-debug_image_types.json
+*-output.xml
+debug_*.json

README.md

@@ -1,16 +1,16 @@
 # vipsgen
 
-[![Go Reference](https://pkg.go.dev/badge/github.com/cshum/vipsgen.svg)](https://pkg.go.dev/github.com/cshum/vipsgen)
-![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/cshum/vipsgen)
 [![CI](https://github.com/cshum/vipsgen/actions/workflows/ci.yml/badge.svg)](https://github.com/cshum/vipsgen/actions/workflows/ci.yml)
+[![Go Reference](https://pkg.go.dev/badge/github.com/cshum/vipsgen/vips.svg)](https://pkg.go.dev/github.com/cshum/vipsgen/vips)
+![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/cshum/vipsgen)
 
 vipsgen is a Go binding generator for [libvips](https://github.com/libvips/libvips) - a fast and efficient image processing library.
 
 Existing Go libvips bindings rely on manually written code that is often incomplete, error-prone, and difficult to maintain as libvips evolves. vipsgen aims to solve this problem by generating type-safe, robust, and fully documented Go bindings using GObject introspection.
 
 vipsgen provides a pre-generated library you can import directly `github.com/cshum/vipsgen/vips`. Also allows code generation via `vipsgen` command that adapts to your specific libvips installation.
 
-- **Coverage**: Comprehensive bindings for over 200 libvips operations
+- **Coverage**: Comprehensive bindings for around 300 libvips operations
 - **Type-Safe**: Generates proper Go types for libvips enums and structs
 - **Idiomatic**: Creates clear Go style code that feels natural to use
 - **Streaming**: Includes `VipsSource` bindings with `io.ReadCloser` integration for streaming
@@ -20,7 +20,6 @@ vipsgen provides a pre-generated library you can import directly `github.com/csh
 Use homebrew to install vips and pkg-config:
 ```
 brew install vips pkg-config
-
 ```
 
 On MacOS, vipsgen may not compile without first setting an environment variable:
@@ -89,7 +88,6 @@ func main() {
 	// Save the result as WebP file with options
 	err = image.Webpsave("resized-gopher.webp", &vips.WebpsaveOptions{
 		Q:              85,    // Quality factor (0-100)
-		Lossless:       false, // Use lossy compression
 		Effort:         4,     // Compression effort (0-6)
 		SmartSubsample: true,  // Better chroma subsampling
 	})
@@ -135,6 +133,7 @@ Options:
 -templates string      Template directory (uses embedded templates if not specified)
 -extract               Extract embedded templates and exit
 -extract-dir string    Directory to extract templates to (default "./templates")
+-debug                 Enable debug json output
 ```
 
 ## Contributing

cmd/vipsgen/main.go

@@ -2,19 +2,18 @@ package main
 
 import (
 	"flag"
-	"fmt"
 	"github.com/cshum/vipsgen/internal/generator"
 	"github.com/cshum/vipsgen/internal/introspection"
 	"github.com/cshum/vipsgen/internal/templates"
 	"log"
 )
 
 func main() {
-	// Define flags
 	extractTemplates := flag.Bool("extract", false, "Extract embedded templates to a directory")
 	extractDir := flag.String("extract-dir", "./templates", "Directory to extract templates to")
 	outputDirFlag := flag.String("out", "./vips", "Output directory")
 	templateDirFlag := flag.String("templates", "", "Template directory (uses embedded templates if not specified)")
+	isDebug := flag.Bool("debug", false, "Enable debug json output")
 
 	flag.Parse()
 
@@ -24,7 +23,7 @@ func main() {
 			log.Fatalf("Failed to extract templates: %v", err)
 		}
 
-		fmt.Printf("Templates and static files extracted to: %s\n", *extractDir)
+		log.Printf("Templates and static files extracted to: %s\n", *extractDir)
 		return
 	}
 
@@ -40,11 +39,11 @@ func main() {
 		if err != nil {
 			log.Fatalf("Failed to create template loader: %v", err)
 		}
-		fmt.Printf("Using templates from: %s\n", *templateDirFlag)
+		log.Printf("Using templates from: %s\n", *templateDirFlag)
 	} else {
 		// Use embedded templates by default
 		loader = generator.NewFSTemplateLoader(templates.Templates, funcMap)
-		fmt.Println("Using embedded templates")
+		log.Printf("Using embedded templates\n")
 	}
 
 	// Determine output directory
@@ -57,27 +56,27 @@ func main() {
 	}
 
 	// Create operation manager for C-based introspection
-	vipsIntrospection := introspection.NewIntrospection()
+	vipsIntrospection := introspection.NewIntrospection(*isDebug)
 
 	// Extract image types from operations
 	imageTypes := vipsIntrospection.DiscoverImageTypes()
 
 	// Discover supported savers
 	supportedSavers := vipsIntrospection.DiscoverSupportedSavers()
-	fmt.Printf("Discovered supported savers:\n")
+	log.Printf("Discovered supported savers:\n")
 	for name, supported := range supportedSavers {
 		if supported {
-			fmt.Printf("  - %s: supported\n", name)
+			log.Printf("  - %s: supported\n", name)
 		}
 	}
 
 	// Convert GIR data to vipsgen.Operation format
 	operations := vipsIntrospection.DiscoverOperations()
-	fmt.Printf("Extracted %d operations from GObject Introspection\n", len(operations))
+	log.Printf("Extracted %d operations from GObject Introspection\n", len(operations))
 
 	// Get enum types
 	enumTypes := vipsIntrospection.DiscoverEnumTypes()
-	fmt.Printf("Discovered %d enum types\n", len(enumTypes))
+	log.Printf("Discovered %d enum types\n", len(enumTypes))
 
 	// Create unified template data
 	templateData := generator.NewTemplateData(operations, enumTypes, imageTypes, supportedSavers)

internal/generator/generate.go

@@ -2,6 +2,7 @@ package generator
 
 import (
 	"fmt"
+	"log"
 	"os"
 	"path/filepath"
 	"strings"
@@ -39,11 +40,9 @@ func Generate(
 		generatedFiles = append(generatedFiles, outputFile)
 	}
 
-	fmt.Printf("\nSuccessfully generated files from templates: %d\n", len(generatedFiles))
+	log.Printf("\nSuccessfully generated files from templates: %d\n", len(generatedFiles))
 	for _, file := range generatedFiles {
-		fmt.Printf("  - %s\n", file)
+		log.Printf("  - %s\n", file)
 	}
-	fmt.Println("\nAdditional static files were also copied to the output directory.")
-
 	return nil
 }

internal/generator/templateloader.go

@@ -3,6 +3,7 @@ package generator
 import (
 	"fmt"
 	"io/fs"
+	"log"
 	"os"
 	"path/filepath"
 	"strings"
@@ -166,7 +167,7 @@ func ExtractEmbeddedFS(filesystem fs.FS, destDir string) error {
 			return fmt.Errorf("failed to write file %s: %v", outPath, err)
 		}
 
-		fmt.Printf("  - Extracted: %s\n", path)
+		log.Printf("  - Extracted: %s\n", path)
 		return nil
 	})
 

internal/introspection/enum.go

@@ -4,6 +4,7 @@ package introspection
 import "C"
 import (
 	"fmt"
+	"log"
 	"strings"
 	"unsafe"
 )
@@ -62,22 +63,24 @@ func (v *Introspection) DiscoverEnumTypes() []EnumTypeInfo {
 		C.free(unsafe.Pointer(cTypeName))
 
 		if exists == 0 {
-			fmt.Printf("Warning: enum type %s not found in libvips\n", typeName.CName)
+			log.Printf("Warning: enum type %s not found in libvips\n", typeName.CName)
 			continue
 		}
 
 		// Try to get the enum values
 		enumInfo, err := v.getEnumType(typeName.CName, typeName.GoName)
 		if err != nil {
-			fmt.Printf("Warning: couldn't process enum type %s: %v\n", typeName.CName, err)
+			log.Printf("Warning: couldn't process enum type %s: %v\n", typeName.CName, err)
 			continue
 		}
 
 		// Add successfully processed enum
 		enumTypes = append(enumTypes, enumInfo)
 	}
 
-	debugJson(enumTypes, "debug_enums.json")
+	if v.isDebug {
+		debugJson(enumTypes, "debug_enums.json")
+	}
 
 	return enumTypes
 }
@@ -233,7 +236,7 @@ func (v *Introspection) addEnumType(cName, goName string) {
 			GoName: goName,
 		})
 		v.discoveredEnumTypes[cNameLower] = goName
-		fmt.Printf("Discovered enum type: %s -> %s\n", cName, goName)
+		log.Printf("Discovered enum type: %s -> %s\n", cName, goName)
 	}
 }
 

internal/introspection/imagetype.go

@@ -98,7 +98,9 @@ func (v *Introspection) DiscoverImageTypes() []ImageTypeInfo {
 		currentOrder++
 	}
 
-	debugJson(imageTypes, "debug_image_types.json")
+	if v.isDebug {
+		debugJson(imageTypes, "debug_image_types.json")
+	}
 
 	return imageTypes
 }

internal/introspection/introspection.go

@@ -14,11 +14,12 @@ type Introspection struct {
 	discoveredEnumTypes  map[string]string
 	enumTypeNames        []enumTypeName
 	discoveredImageTypes map[string]ImageTypeInfo
+	isDebug              bool
 }
 
 // NewIntrospection creates a new Introspection instance for analyzing libvips
 // operations, initializing the libvips library in the process.
-func NewIntrospection() *Introspection {
+func NewIntrospection(isDebug bool) *Introspection {
 	// Initialize libvips
 	if C.vips_init(C.CString("vipsgen")) != 0 {
 		log.Fatal("Failed to initialize libvips")
@@ -28,5 +29,6 @@ func NewIntrospection() *Introspection {
 	return &Introspection{
 		discoveredEnumTypes:  make(map[string]string),
 		discoveredImageTypes: map[string]ImageTypeInfo{},
+		isDebug:              isDebug,
 	}
 }

internal/introspection/operation.go

@@ -131,25 +131,27 @@ func (v *Introspection) DiscoverOperations() []Operation {
 		if strings.Contains(op.Name, "_target") ||
 			strings.Contains(op.Name, "_mime") ||
 			strings.Contains(op.Name, "fitsload_source") {
-			fmt.Printf("Excluded operation: vips_%s \n", op.Name)
+			log.Printf("Excluded operation: vips_%s \n", op.Name)
 			excludedCount++
 			continue
 		}
 		// Check for duplicate Go function names
 		if seenOperations[op.GoName] {
-			fmt.Printf("Skipping duplicated operation: vips_%s\n", op.Name)
+			log.Printf("Skipping duplicated operation: vips_%s\n", op.Name)
 			duplicateCount++
 			continue
 		}
 		seenOperations[op.GoName] = true
 
-		fmt.Printf("Discovered operation: vips_%s \n", op.Name)
+		log.Printf("Discovered operation: vips_%s \n", op.Name)
 		operations = append(operations, op)
 	}
-	fmt.Printf("Discovered Operations: %d (%d excluded, %d duplicates)\n",
+	log.Printf("Discovered Operations: %d (%d excluded, %d duplicates)\n",
 		len(operations), excludedCount, duplicateCount)
 
-	debugJson(operations, "debug_operations.json")
+	if v.isDebug {
+		debugJson(operations, "debug_operations.json")
+	}
 
 	return operations
 }
@@ -534,9 +536,6 @@ func (v *Introspection) mapGTypeToTypes(gtype C.GType, typeName string, isOutput
 		if cTypeNamePtr != nil {
 			actualTypeName := C.GoString(cTypeNamePtr)
 
-			// Log for debugging
-			log.Printf("Found object type: %s", actualTypeName)
-
 			if isOutput {
 				return actualTypeName, "*C." + actualTypeName, actualTypeName + "**"
 			}