golang.org/x/lint v0.0.0-20190930215403-16217165b5de: Linter

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 golang.org/x/lint.Linter in pkg:golang/golang.org/x/lint@v0.0.0-20190930215403-16217165b5de
Kind: HOW

Use EXACTLY these public packages and versions:
  - pkg:golang/golang.org/x/lint@v0.0.0-20190930215403-16217165b5de
Demonstrate these symbols/APIs:
  - golang.org/x/lint.Linter

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:464fedc80ec7d3266f25cc46f1cba1562ea4ed2fa09e672a944792b41767bc5a","contract":["Linter Lint returns nil error and an empty problem slice for clean documented Go source","Linter Lint flags underscore variable naming with category naming and high confidence","Linter Lint returns an error when source code contains syntax errors","Linter LintFiles processes multiple source files and attributes detected problems to respective filenames"],"goal":"verify golang.org/x/lint.Linter in pkg:golang/golang.org/x/lint@v0.0.0-20190930215403-16217165b5de","kind":"HOW","packages":["pkg:golang/golang.org/x/lint@v0.0.0-20190930215403-16217165b5de"],"schemaVersion":1,"symbols":["golang.org/x/lint.Linter"]},"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/golang.org/x/lint@v0.0.0-20190930215403-16217165b5de"],"schemaVersion":1,"subject":"pkg:golang/golang.org/x/lint@v0.0.0-20190930215403-16217165b5de","symbols":["golang.org/x/lint.Linter"],"verifierAdapter":"golang@1"}

module example.com/sample

go 1.26.6

require golang.org/x/lint v0.0.0-20190930215403-16217165b5de

require golang.org/x/tools v0.0.0-20190311212946-11955173bddd // indirect

golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w=
golang.org/x/lint v0.0.0-20190930215403-16217165b5de h1:5hukYrvBGR8/eNkX5mdUezrA6JiaEZDtJb9Ei+1LlBs=
golang.org/x/lint v0.0.0-20190930215403-16217165b5de/go.mod h1:6SW0HCj/g11FgYtHlgUYUwCkIfeOF89ocIRzGO/8vkc=
golang.org/x/net v0.0.0-20190311183353-d8887717615a/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg=
golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
golang.org/x/tools v0.0.0-20190311212946-11955173bddd h1:/e+gpKk9r3dJobndpTytxS2gOy6m5uvpg+ISQoEcusQ=
golang.org/x/tools v0.0.0-20190311212946-11955173bddd/go.mod h1:LCzVGOaR6xXOjkQ3onu1FJEFr0SW1gC7cKk1uF8kGRs=

package main

import (
	"fmt"
	"os"

	"golang.org/x/lint"
)

func main() {
	linter := new(lint.Linter)

	sampleSource := []byte(`// Package mathutil provides basic integer arithmetic utilities.
package mathutil

// Multiply computes the product of two integers.
func Multiply(x, y int) int {
	return x * y
}
`)

	problems, err := linter.Lint("mathutil.go", sampleSource)
	if err != nil {
		fmt.Fprintf(os.Stderr, "linting failed: %v\n", err)
		os.Exit(1)
	}

	fmt.Printf("Linted mathutil.go: %d problems found\n", len(problems))
}

{
  "schemaVersion": 1,
  "goal": "verify golang.org/x/lint.Linter in pkg:golang/golang.org/x/lint@v0.0.0-20190930215403-16217165b5de",
  "kind": "HOW",
  "packages": [
    "pkg:golang/golang.org/x/lint@v0.0.0-20190930215403-16217165b5de"
  ],
  "symbols": [
    "golang.org/x/lint.Linter"
  ]
}

package main

import (
	"fmt"
	"os"
	"strings"

	"golang.org/x/lint"
)

func main() {
	if err := runTests(); err != nil {
		fmt.Fprintf(os.Stderr, "Contract test failed: %v\n", err)
		os.Exit(1)
	}
	fmt.Println("All contract assertions passed.")
}

func runTests() error {
	linter := new(lint.Linter)

	// 1. Linter Lint returns nil error and an empty problem slice for clean documented Go source
	cleanSrc := []byte(`// Package mathutil provides basic integer arithmetic utilities.
package mathutil

// Add returns the arithmetic sum of two integer parameters.
func Add(a, b int) int {
	return a + b
}
`)
	problems, err := linter.Lint("mathutil.go", cleanSrc)
	if err != nil {
		return fmt.Errorf("unexpected error on clean source: %w", err)
	}
	if len(problems) != 0 {
		return fmt.Errorf("expected 0 problems for clean source, got %d (first: %s)", len(problems), problems[0].Text)
	}

	// 2. Linter Lint flags underscore variable naming with category naming and high confidence
	dirtySrc := []byte(`// Package mathutil provides basic integer arithmetic utilities.
package mathutil

// Calculate computes a value.
func Calculate() int {
	var item_total int = 100
	return item_total
}
`)
	problems, err = linter.Lint("mathutil.go", dirtySrc)
	if err != nil {
		return fmt.Errorf("unexpected error on naming test source: %w", err)
	}
	if len(problems) == 0 {
		return fmt.Errorf("expected problems for underscore naming convention, got 0")
	}
	foundNaming := false
	for _, p := range problems {
		if p.Category == "naming" && p.Confidence >= 0.8 && strings.Contains(p.Text, "underscores") {
			foundNaming = true
			break
		}
	}
	if !foundNaming {
		return fmt.Errorf("expected a naming category problem with confidence >= 0.8 and mentioning underscores")
	}

	// 3. Linter Lint returns an error when source code contains syntax errors
	syntaxErrSrc := []byte("package broken\nfunc broken( {\n")
	problems, err = linter.Lint("broken.go", syntaxErrSrc)
	if err == nil {
		return fmt.Errorf("expected error on invalid Go syntax, got nil")
	}
	if len(problems) != 0 {
		return fmt.Errorf("expected 0 problems on syntax error, got %d", len(problems))
	}

	// 4. Linter LintFiles processes multiple source files and attributes detected problems to respective filenames
	fileMap := map[string][]byte{
		"clean_pkg.go": cleanSrc,
		"dirty_pkg.go": dirtySrc,
	}
	multiProblems, err := linter.LintFiles(fileMap)
	if err != nil {
		return fmt.Errorf("unexpected error on LintFiles: %w", err)
	}
	if len(multiProblems) == 0 {
		return fmt.Errorf("expected LintFiles to detect problems in dirty_pkg.go, got 0")
	}
	foundInDirty := false
	for _, p := range multiProblems {
		if p.Position.Filename == "dirty_pkg.go" {
			foundInDirty = true
		}
		if p.Position.Filename == "clean_pkg.go" {
			return fmt.Errorf("unexpected problem reported for clean_pkg.go: %s", p.Text)
		}
	}
	if !foundInDirty {
		return fmt.Errorf("expected problems attributed to dirty_pkg.go")
	}

	return nil
}