refactor!: add init command, update cli flags, support a config file (open-feature#71)

Signed-off-by: Michael Beemer <beeme1mr@users.noreply.github.com>

Author: beeme1mr

.github/workflows/pr-lint.yml

@@ -27,5 +27,5 @@ jobs:
       - name: golangci-lint
         uses: golangci/golangci-lint-action@v6
         with:
-          version: v1.60
+          version: v1.64
           only-new-issues: true

.gitignore

@@ -24,3 +24,6 @@ go.work.sum
 # env file
 .env
 dist
+
+# openfeature cli config
+.openfeature.yaml

CONTRIBUTING.md

@@ -0,0 +1,96 @@
+TODO: Add contributing guidelines
+
+## Templates
+
+### Data
+
+The `TemplateData` struct is used to pass data to the templates.
+
+### Built-in template functions
+
+The following functions are automatically included in the templates:
+
+#### ToPascal
+
+Converts a string to `PascalCase`
+
+```go
+{{ "hello world" | ToPascal }} // HelloWorld
+```
+
+#### ToCamel
+
+Converts a string to `camelCase`
+
+```go
+{{ "hello world" | ToCamel }} // helloWorld
+```
+
+#### ToKebab
+
+Converts a string to `kebab-case`
+
+```go
+{{ "hello world" | ToKebab }} // hello-world
+```
+
+#### ToSnake
+
+Converts a string to `snake_case`
+
+```go
+{{ "hello world" | ToSnake }} // hello_world
+```
+
+#### ToScreamingSnake
+
+Converts a string to `SCREAMING_SNAKE_CASE`
+
+```go
+{{ "hello world" | ToScreamingSnake }} // HELLO_WORLD
+```
+
+#### ToUpper
+
+Converts a string to `UPPER CASE`
+
+```go
+{{ "hello world" | ToUpper }} // HELLO WORLD
+```
+
+#### ToLower
+
+Converts a string to `lower case`
+
+```go
+{{ "HELLO WORLD" | ToLower }} // hello world
+```
+
+#### ToTitle
+
+Converts a string to `Title Case`
+
+```go
+{{ "hello world" | ToTitle }} // Hello World
+```
+
+#### Quote
+
+Wraps a string in double quotes
+
+```go
+{{ "hello world" | Quote }} // "hello world"
+```
+
+#### QuoteString
+
+Wraps only strings in double quotes
+
+```go
+{{ "hello world" | QuoteString }} // "hello world"
+{{ 123 | QuoteString }} // 123
+```
+
+### Custom template functions
+
+You can add custom template functions by passing a `FuncMap` to the `GenerateFile` function.

Makefile

@@ -2,10 +2,15 @@
 .PHONY: test
 test: 
 	@echo "Running tests..."
-	go test -v ./...
+	@go test -v ./...
 	@echo "Tests passed successfully!"
 
 generate-docs:
 	@echo "Generating documentation..."
-	go run ./docs/generate-commands.go
-	@echo "Documentation generated successfully!"
+	@go run ./docs/generate-commands.go
+	@echo "Documentation generated successfully!"
+
+generate-schema:
+	@echo "Generating schema..."
+	@go run ./schema/generate-schema.go
+	@echo "Schema generated successfully!"

cmd/config.go

@@ -0,0 +1,71 @@
+package cmd
+
+import (
+	"fmt"
+	"strings"
+
+	"github.com/spf13/cobra"
+	"github.com/spf13/pflag"
+	"github.com/spf13/viper"
+)
+
+// initializeConfig reads in config file and ENV variables if set.
+// It applies configuration values to command flags based on hierarchical priority.
+func initializeConfig(cmd *cobra.Command, bindPrefix string) error {
+	v := viper.New()
+
+	// Set the config file name and path
+	v.SetConfigName(".openfeature")
+	v.AddConfigPath(".")
+
+	// Read the config file
+	if err := v.ReadInConfig(); err != nil {
+		// It's okay if there isn't a config file
+		if _, ok := err.(viper.ConfigFileNotFoundError); !ok {
+			return err
+		}
+	}
+
+	// Track which flags were set directly via command line
+	cmdLineFlags := make(map[string]bool)
+	cmd.Flags().Visit(func(f *pflag.Flag) {
+		cmdLineFlags[f.Name] = true
+	})
+
+	// Apply the configuration values
+	cmd.Flags().VisitAll(func(f *pflag.Flag) {
+		// Skip if flag was set on command line
+		if cmdLineFlags[f.Name] {
+			return
+		}
+
+		// Build configuration paths from most specific to least specific
+		configPaths := []string{}
+		
+		// Check the most specific path (e.g., generate.go.package-name)
+		if bindPrefix != "" {
+			configPaths = append(configPaths, bindPrefix + "." + f.Name)
+			
+			// Check parent paths (e.g., generate.package-name)
+			parts := strings.Split(bindPrefix, ".")
+			for i := len(parts) - 1; i > 0; i-- {
+				parentPath := strings.Join(parts[:i], ".") + "." + f.Name
+				configPaths = append(configPaths, parentPath)
+			}
+		}
+		
+		// Check the base path (e.g., package-name)
+		configPaths = append(configPaths, f.Name)
+		
+		// Try each path in order until we find a match
+		for _, path := range configPaths {
+			if v.IsSet(path) {
+				val := v.Get(path)
+				_ = f.Value.Set(fmt.Sprintf("%v", val))
+				break
+			}
+		}
+	})
+
+	return nil
+}

cmd/config_test.go

@@ -0,0 +1,172 @@
+package cmd
+
+import (
+	"os"
+	"path/filepath"
+	"testing"
+
+	"github.com/spf13/cobra"
+	"github.com/stretchr/testify/assert"
+)
+
+func setupTestCommand() *cobra.Command {
+	cmd := &cobra.Command{
+		Use: "test",
+	}
+
+	// Add some test flags
+	cmd.Flags().String("output", "", "output path")
+	cmd.Flags().String("package-name", "default", "package name")
+
+	return cmd
+}
+
+// setupConfigFileForTest creates a temporary directory with a config file
+// and changes the working directory to it.
+// Returns the original working directory and temp directory path for cleanup.
+func setupConfigFileForTest(t *testing.T, configContent string) (string, string) {
+	// Create a temporary config file
+	tmpDir, err := os.MkdirTemp("", "config-test")
+	if err != nil {
+		t.Fatal(err)
+	}
+
+	configPath := filepath.Join(tmpDir, ".openfeature.yaml")
+	err = os.WriteFile(configPath, []byte(configContent), 0644)
+	if err != nil {
+		t.Fatal(err)
+	}
+
+	// Change to the temporary directory so the config file can be found
+	originalDir, _ := os.Getwd()
+	err = os.Chdir(tmpDir)
+	if err != nil {
+		t.Fatal(err)
+	}
+
+	return originalDir, tmpDir
+}
+
+func TestRootCommandIgnoresUnrelatedConfig(t *testing.T) {
+	configContent := `
+generate:
+  output: output-from-generate
+`
+	originalDir, tmpDir := setupConfigFileForTest(t, configContent)
+	defer func() {
+		_ = os.Chdir(originalDir)
+		_ = os.RemoveAll(tmpDir)
+	}()
+
+	rootCmd := setupTestCommand()
+	err := initializeConfig(rootCmd, "")
+
+	assert.NoError(t, err)
+	assert.Equal(t, "", rootCmd.Flag("output").Value.String(),
+		"Root command should not get output config from unrelated sections")
+}
+
+func TestGenerateCommandGetsGenerateConfig(t *testing.T) {
+	configContent := `
+generate:
+  output: output-from-generate
+`
+	originalDir, tmpDir := setupConfigFileForTest(t, configContent)
+	defer func() {
+		_ = os.Chdir(originalDir)
+		_ = os.RemoveAll(tmpDir)
+	}()
+
+	generateCmd := setupTestCommand()
+	err := initializeConfig(generateCmd, "generate")
+
+	assert.NoError(t, err)
+	assert.Equal(t, "output-from-generate", generateCmd.Flag("output").Value.String(),
+		"Generate command should get generate.output value")
+}
+
+func TestSubcommandGetsSpecificConfig(t *testing.T) {
+	configContent := `
+generate:
+  output: output-from-generate
+  go:
+    output: output-from-go
+    package-name: fromconfig
+`
+	originalDir, tmpDir := setupConfigFileForTest(t, configContent)
+	defer func() {
+		_ = os.Chdir(originalDir)
+		_ = os.RemoveAll(tmpDir)
+	}()
+
+	goCmd := setupTestCommand()
+	err := initializeConfig(goCmd, "generate.go")
+
+	assert.NoError(t, err)
+	assert.Equal(t, "output-from-go", goCmd.Flag("output").Value.String(),
+		"Go command should get generate.go.output, not generate.output")
+	assert.Equal(t, "fromconfig", goCmd.Flag("package-name").Value.String(),
+		"Go command should get generate.go.package-name")
+}
+
+func TestSubcommandInheritsFromParent(t *testing.T) {
+	configContent := `
+generate:
+  output: output-from-generate
+`
+	originalDir, tmpDir := setupConfigFileForTest(t, configContent)
+	defer func() {
+		_ = os.Chdir(originalDir)
+		_ = os.RemoveAll(tmpDir)
+	}()
+
+	otherCmd := setupTestCommand()
+	err := initializeConfig(otherCmd, "generate.other")
+
+	assert.NoError(t, err)
+	assert.Equal(t, "output-from-generate", otherCmd.Flag("output").Value.String(),
+		"Other command should inherit generate.output when no specific config exists")
+}
+
+func TestCommandLineOverridesConfig(t *testing.T) {
+	// Create a temporary config file
+	tmpDir, err := os.MkdirTemp("", "config-test")
+	if err != nil {
+		t.Fatal(err)
+	}
+	defer func() {
+		_ = os.RemoveAll(tmpDir)
+	}()
+
+	configPath := filepath.Join(tmpDir, ".openfeature.yaml")
+	configContent := `
+generate:
+  output: output-from-config
+`
+	err = os.WriteFile(configPath, []byte(configContent), 0644)
+	if err != nil {
+		t.Fatal(err)
+	}
+
+	// Change to the temporary directory so the config file can be found
+	originalDir, _ := os.Getwd()
+	err = os.Chdir(tmpDir)
+	if err != nil {
+		t.Fatal(err)
+	}
+	defer func() {
+		_ = os.Chdir(originalDir)
+	}()
+
+	// Set up a command with a flag value already set via command line
+	cmd := setupTestCommand()
+	_ = cmd.Flags().Set("output", "output-from-cmdline")
+
+	// Initialize config
+	err = initializeConfig(cmd, "generate")
+	assert.NoError(t, err)
+
+	// Command line value should take precedence
+	assert.Equal(t, "output-from-cmdline", cmd.Flag("output").Value.String(),
+		"Command line value should override config file")
+}