github.com/sagikazarmark/locafero v0.11.0

Clean-room public code sample — generation instructions

Write a brand-new, minimal, self-contained code sample in this clean-room directory.
Do not copy, paraphrase, or reference any existing project source. Work only from this spec.

A csx.json manifest scaffold already exists. Do not recreate it from memory. Preserve its case.goal, packages and symbols; fill its empty case.contract with exact assertions and correct its environment, commands and verifierAdapter for the files you generate.

Goal: verify pkg:golang/github.com/sagikazarmark/locafero@v0.11.0
Kind: HOW

Use EXACTLY these public packages and versions:
  - pkg:golang/github.com/sagikazarmark/locafero@v0.11.0

Rules:
  - One focused purpose; the smallest project that proves the goal.
  - Include a contract test (test/contract.*) that runs OFFLINE and exits 0 exactly when the goal behavior works.
  - Pin every dependency with a lockfile so resolution is reproducible.
  - No secrets, credentials, or tokens. No real URLs (only example.com or localhost). No absolute paths.
  - No personal names, emails, company names, or project identifiers of any kind.
  - No binaries and no generated output (node_modules, dist, target, venv, .git, .env).
  - Keep it under 200 files and 256KB packed.

{"case":{"caseId":"case:sha256:5fb7868f2e70eca57d760b2bee190fd0eb50e7c2388133d06369a44e4fc9f47e","contract":["Finder.Find locates files matching exact name in specified path using afero.Fs","Finder.Find locates files matching glob pattern in specified path using afero.Fs","Finder.Find filters results by FileTypeFile excluding directories","Finder.Find filters results by FileTypeDir excluding regular files","Finder.Find returns empty slice when no matching entries exist","NameWithExtensions generates slice of filenames with given extensions","NameWithOptionalExtensions appends base name without extension to generated filenames"],"goal":"verify pkg:golang/github.com/sagikazarmark/locafero@v0.11.0","kind":"HOW","packages":["pkg:golang/github.com/sagikazarmark/locafero@v0.11.0"],"schemaVersion":1},"contractCommand":["go","run","./test"],"environment":{"arch":"x64","distro":"ubuntu","ecosystem":"golang","libc":"glibc","libcVersion":"2.39","os":"linux","osVersionBucket":"24","packageManager":"go","schemaVersion":1},"license":"MIT-0","packages":["pkg:golang/github.com/sagikazarmark/locafero@v0.11.0"],"schemaVersion":1,"subject":"pkg:golang/github.com/sagikazarmark/locafero@v0.11.0","verifierAdapter":"golang@1"}

module example.com/sample

go 1.23.0

require (
	github.com/sagikazarmark/locafero v0.11.0
	github.com/spf13/afero v1.15.0
)

require (
	github.com/sourcegraph/conc v0.3.1-0.20240121214520-5f936abd7ae8 // indirect
	golang.org/x/text v0.28.0 // indirect
)

github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
github.com/sagikazarmark/locafero v0.11.0 h1:1iurJgmM9G3PA/I+wWYIOw/5SyBtxapeHDcg+AAIFXc=
github.com/sagikazarmark/locafero v0.11.0/go.mod h1:nVIGvgyzw595SUSUE6tvCp3YYTeHs15MvlmU87WwIik=
github.com/sourcegraph/conc v0.3.1-0.20240121214520-5f936abd7ae8 h1:+jumHNA0Wrelhe64i8F6HNlS8pkoyMv5sreGx2Ry5Rw=
github.com/sourcegraph/conc v0.3.1-0.20240121214520-5f936abd7ae8/go.mod h1:3n1Cwaq1E1/1lhQhtRK2ts/ZwZEhjcQeJQ1RuC6Q/8U=
github.com/spf13/afero v1.15.0 h1:b/YBCLWAJdFWJTN9cLhiXXcD7mzKn9Dm86dNnfyQw1I=
github.com/spf13/afero v1.15.0/go.mod h1:NC2ByUVxtQs4b3sIUphxK0NioZnmxgyCrfzeuq8lxMg=
github.com/stretchr/testify v1.10.0 h1:Xv5erBjTwe/5IxqUQTdXv5kgmIvbHo3QQyRwhJsOfJA=
github.com/stretchr/testify v1.10.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY=
golang.org/x/text v0.28.0 h1:rhazDwis8INMIwQ4tpjLDzUhx6RlXqZNPEM0huQojng=
golang.org/x/text v0.28.0/go.mod h1:U8nCwOR8jO/marOQ0QbDiOngZVEBB7MAiitBuMjXiNU=
gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=

package main

import (
	"fmt"
	"log"

	"github.com/sagikazarmark/locafero"
	"github.com/spf13/afero"
)

func main() {
	fsys := afero.NewMemMapFs()

	if err := fsys.MkdirAll("config", 0755); err != nil {
		log.Fatalf("failed to create directory: %v", err)
	}
	if err := afero.WriteFile(fsys, "config/app.yaml", []byte("name: sample\n"), 0644); err != nil {
		log.Fatalf("failed to write file: %v", err)
	}
	if err := afero.WriteFile(fsys, "config/app.json", []byte("{\"name\": \"sample\"}\n"), 0644); err != nil {
		log.Fatalf("failed to write file: %v", err)
	}

	names := locafero.NameWithExtensions("app", "yaml", "json")
	fmt.Printf("Generated search names: %v\n", names)

	finder := locafero.Finder{
		Paths: []string{"config"},
		Names: names,
		Type:  locafero.FileTypeFile,
	}

	results, err := finder.Find(fsys)
	if err != nil {
		log.Fatalf("failed to find files: %v", err)
	}
	fmt.Printf("Found config files: %v\n", results)
}

{
  "schemaVersion": 1,
  "goal": "verify pkg:golang/github.com/sagikazarmark/locafero@v0.11.0",
  "kind": "HOW",
  "packages": [
    "pkg:golang/github.com/sagikazarmark/locafero@v0.11.0"
  ]
}

package main

import (
	"fmt"
	"os"
	"sort"

	"github.com/sagikazarmark/locafero"
	"github.com/spf13/afero"
)

func assertContains(found []string, expected string, assertionName string) {
	for _, f := range found {
		if f == expected {
			return
		}
	}
	fmt.Fprintf(os.Stderr, "%s failed: %q not found in results %v\n", assertionName, expected, found)
	os.Exit(1)
}

func assertNotContains(found []string, unexpected string, assertionName string) {
	for _, f := range found {
		if f == unexpected {
			fmt.Fprintf(os.Stderr, "%s failed: %q unexpectedly found in results %v\n", assertionName, unexpected, found)
			os.Exit(1)
		}
	}
}

func assertSliceEqual(got []string, expected []string, assertionName string) {
	if len(got) != len(expected) {
		fmt.Fprintf(os.Stderr, "%s failed: length mismatch got %d (%v) expected %d (%v)\n", assertionName, len(got), got, len(expected), expected)
		os.Exit(1)
	}
	for i := range got {
		if got[i] != expected[i] {
			fmt.Fprintf(os.Stderr, "%s failed: item mismatch at %d got %q expected %q\n", assertionName, i, got[i], expected[i])
			os.Exit(1)
		}
	}
}

func main() {
	fsys := afero.NewMemMapFs()

	_ = fsys.MkdirAll("etc/subdir", 0755)
	_ = fsys.MkdirAll("config", 0755)
	_ = afero.WriteFile(fsys, "etc/app.conf", []byte("key=value\n"), 0644)
	_ = afero.WriteFile(fsys, "config/app.yaml", []byte("name: app\n"), 0644)
	_ = afero.WriteFile(fsys, "config/test.yaml", []byte("name: test\n"), 0644)
	_ = afero.WriteFile(fsys, "config/other.txt", []byte("hello\n"), 0644)

	// 1. Finder.Find locates files matching exact name in specified path using afero.Fs
	finderExact := locafero.Finder{
		Paths: []string{"etc"},
		Names: []string{"app.conf"},
		Type:  locafero.FileTypeFile,
	}
	resExact, err := finderExact.Find(fsys)
	if err != nil {
		fmt.Fprintf(os.Stderr, "assertion 1 failed with error: %v\n", err)
		os.Exit(1)
	}
	assertContains(resExact, "etc/app.conf", "assertion 1 (Finder.Find exact match)")

	// 2. Finder.Find locates files matching glob pattern in specified path using afero.Fs
	finderGlob := locafero.Finder{
		Paths: []string{"config"},
		Names: []string{"*.yaml"},
		Type:  locafero.FileTypeFile,
	}
	resGlob, err := finderGlob.Find(fsys)
	if err != nil {
		fmt.Fprintf(os.Stderr, "assertion 2 failed with error: %v\n", err)
		os.Exit(1)
	}
	assertContains(resGlob, "config/app.yaml", "assertion 2 (Finder.Find glob app.yaml)")
	assertContains(resGlob, "config/test.yaml", "assertion 2 (Finder.Find glob test.yaml)")
	assertNotContains(resGlob, "config/other.txt", "assertion 2 (Finder.Find glob other.txt)")

	// 3. Finder.Find filters results by FileTypeFile excluding directories
	finderFileOnly := locafero.Finder{
		Paths: []string{"etc"},
		Names: []string{"*"},
		Type:  locafero.FileTypeFile,
	}
	resFileOnly, err := finderFileOnly.Find(fsys)
	if err != nil {
		fmt.Fprintf(os.Stderr, "assertion 3 failed with error: %v\n", err)
		os.Exit(1)
	}
	assertContains(resFileOnly, "etc/app.conf", "assertion 3 (FileTypeFile includes file)")
	assertNotContains(resFileOnly, "etc/subdir", "assertion 3 (FileTypeFile excludes directory)")

	// 4. Finder.Find filters results by FileTypeDir excluding regular files
	finderDirOnly := locafero.Finder{
		Paths: []string{"etc"},
		Names: []string{"*"},
		Type:  locafero.FileTypeDir,
	}
	resDirOnly, err := finderDirOnly.Find(fsys)
	if err != nil {
		fmt.Fprintf(os.Stderr, "assertion 4 failed with error: %v\n", err)
		os.Exit(1)
	}
	assertContains(resDirOnly, "etc/subdir", "assertion 4 (FileTypeDir includes directory)")
	assertNotContains(resDirOnly, "etc/app.conf", "assertion 4 (FileTypeDir excludes file)")

	// 5. Finder.Find returns empty slice when no matching entries exist
	finderNone := locafero.Finder{
		Paths: []string{"config"},
		Names: []string{"nonexistent.json"},
		Type:  locafero.FileTypeFile,
	}
	resNone, err := finderNone.Find(fsys)
	if err != nil {
		fmt.Fprintf(os.Stderr, "assertion 5 failed with error: %v\n", err)
		os.Exit(1)
	}
	if len(resNone) != 0 {
		fmt.Fprintf(os.Stderr, "assertion 5 failed: expected empty results, got %v\n", resNone)
		os.Exit(1)
	}

	// 6. NameWithExtensions generates slice of filenames with given extensions
	exts := locafero.NameWithExtensions("config", "yaml", "json")
	assertSliceEqual(exts, []string{"config.yaml", "config.json"}, "assertion 6 (NameWithExtensions)")

	// 7. NameWithOptionalExtensions appends base name without extension to generated filenames
	optExts := locafero.NameWithOptionalExtensions("config", "yaml", "json")
	assertSliceEqual(optExts, []string{"config.yaml", "config.json", "config"}, "assertion 7 (NameWithOptionalExtensions)")

	sort.Strings(exts)
	if len(exts) != 2 {
		fmt.Fprintf(os.Stderr, "unexpected exts length: %d\n", len(exts))
		os.Exit(1)
	}

	fmt.Println("All contract assertions passed.")
}