Support replacement capture groups

.changes/unreleased/added-20240907-150508.yaml

@@ -0,0 +1,5 @@
+kind: added
+body: Rework replacement to support grouping
+time: 2024-09-07T15:05:08.518032783-07:00
+custom:
+    Issue: "702"

.github/workflows/test.yml

@@ -40,7 +40,7 @@ jobs:
       with:
         # Required: the version of golangci-lint is required and must be specified
         # without patch version: we always use the latest patch version.
-        version: v1.58
+        version: v1.60
 
     - name: Gen
       run: go run main.go gen

.gitignore

@@ -12,7 +12,7 @@ coverage.html
 site/
 venv/
 docs/cli/
-!docs/cli/.gitkeep
+docs/config/
 
 # goreleaser builds
 dist/

Makefile

@@ -19,6 +19,9 @@ lint: # Run linters
 	goimports -w -local github.com/miniscruff/changie .
 	golangci-lint run ./...
 
+.PHONY: format
+format: lint # alias for lint
+
 .PHONY: gen
 gen: # Generate config and CLI docs
 	go run main.go gen

cmd/batch.go

@@ -180,9 +180,9 @@ func (b *Batch) getBatchData() (*core.BatchData, error) {
 		Version:         currentVersion.Original(),
 		VersionNoPrefix: currentVersion.String(),
 		PreviousVersion: previousVersion.Original(),
-		Major:           int(currentVersion.Major()),
-		Minor:           int(currentVersion.Minor()),
-		Patch:           int(currentVersion.Patch()),
+		Major:           int(currentVersion.Major()), //nolint:gosec
+		Minor:           int(currentVersion.Minor()), //nolint:gosec
+		Patch:           int(currentVersion.Patch()), //nolint:gosec
 		Prerelease:      currentVersion.Prerelease(),
 		Metadata:        currentVersion.Metadata(),
 		Changes:         allChanges,

cmd/gen.go

@@ -16,6 +16,8 @@ import (
 
 	"github.com/spf13/cobra"
 	"github.com/spf13/cobra/doc"
+
+	"github.com/miniscruff/changie/core"
 )
 
 const fmTemplate = `---
@@ -75,9 +77,19 @@ func NewGen() *Gen {
 }
 
 func (g *Gen) Run(cmd *cobra.Command, args []string) error {
+	err := os.MkdirAll(filepath.Join("docs", "config"), core.CreateDirMode)
+	if err != nil {
+		return fmt.Errorf("creating docs/config directory: %w", err)
+	}
+
+	err = os.MkdirAll(filepath.Join("docs", "cli"), core.CreateDirMode)
+	if err != nil {
+		return fmt.Errorf("creating docs/cli directory: %w", err)
+	}
+
 	file, err := os.Create(filepath.Join("docs", "config", "index.md"))
 	if err != nil {
-		return fmt.Errorf("unable to create or open config index: %w", err)
+		return fmt.Errorf("creating or opening config index: %w", err)
 	}
 
 	defer file.Close()

cmd/gen_test.go

@@ -67,15 +67,6 @@ func TestCanGetFiles(t *testing.T) {
 	then.FileExists(t, configDocsPath)
 }
 
-func TestErrorGenIfContentPathIsMissing(t *testing.T) {
-	cmd := RootCmd()
-
-	then.WithTempDir(t)
-
-	cmd.SetArgs([]string{"gen"})
-	then.NotNil(t, cmd.Execute())
-}
-
 func TestErrorGenBadWriteTypesWriter(t *testing.T) {
 	w := then.NewErrWriter()
 	parent := TypeProps{

cmd/merge.go

@@ -167,9 +167,9 @@ func (m *Merge) mergeProject(
 	replaceData := core.ReplaceData{
 		Version:         version.Original(),
 		VersionNoPrefix: version.String(),
-		Major:           int(version.Major()),
-		Minor:           int(version.Minor()),
-		Patch:           int(version.Patch()),
+		Major:           int(version.Major()), //nolint:gosec
+		Minor:           int(version.Minor()), //nolint:gosec
+		Patch:           int(version.Patch()), //nolint:gosec
 		Prerelease:      version.Prerelease(),
 		Metadata:        version.Metadata(),
 	}

core/replacement.go

@@ -6,9 +6,6 @@ import (
 	"os"
 	"regexp"
 	"text/template"
-
-	"github.com/icholy/replace"
-	"golang.org/x/text/transform"
 )
 
 // Template data used for replacing version values.
@@ -44,6 +41,7 @@ type Replacement struct {
 	// Path of the file to find and replace in.
 	Path string `yaml:"path" required:"true"`
 	// Regular expression to search for in the file.
+	// Capture groups are supported and can be used in the replace value.
 	Find string `yaml:"find" required:"true"`
 	// Template string to replace the line with.
 	Replace string `yaml:"replace" required:"true" templateType:"ReplaceData"`
@@ -79,9 +77,12 @@ func (r Replacement) Execute(data ReplaceData) error {
 		flags = "m"
 	}
 
-	regexString := fmt.Sprintf("(?%s)%s", flags, r.Find)
-	transformer := replace.Regexp(regexp.MustCompile(regexString), buf.Bytes())
-	newData, _, _ := transform.Bytes(transformer, fileData)
+	regex, err := regexp.Compile(fmt.Sprintf("(?%s)%s", flags, r.Find))
+	if err != nil {
+		return err
+	}
+
+	newData := regex.ReplaceAll(fileData, buf.Bytes())
 
 	err = os.WriteFile(r.Path, newData, CreateFileMode)
 	if err != nil {

core/replacement_test.go

@@ -146,6 +146,31 @@ func TestErrorBadTemplateParse(t *testing.T) {
 	then.NotNil(t, err)
 }
 
+func TestErrorBadRegex(t *testing.T) {
+	then.WithTempDir(t)
+
+	filepath := "insensitive.txt"
+	startData := `# yaml file
+Version: 0.0.1
+level1:
+	level2:
+		version: 0.0.1
+`
+
+	err := os.WriteFile(filepath, []byte(startData), os.ModePerm)
+	then.Nil(t, err)
+
+	rep := Replacement{
+		Path:  filepath,
+		Find:  "a(b",
+		Flags: "im",
+	}
+	err = rep.Execute(ReplaceData{
+		VersionNoPrefix: "1.2.3",
+	})
+	then.NotNil(t, err)
+}
+
 func TestErrorBadTemplateExec(t *testing.T) {
 	then.WithTempDir(t)