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

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/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

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:e15ea0c5d8a545f9793d9cccaa54d10785dcc28712c81379e6ed193723bf694a","contract":["linter.Lint returns no problems and nil error for clean documented code","linter.Lint detects missing comment on exported function with comments category and confidence 1.0","linter.Lint detects underscore in variable name with naming category","linter.Lint returns error on invalid Go source syntax","linter.LintFiles checks multiple files in a package and returns combined problems","Problem.String contains the problem text and reference URL"],"goal":"verify 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},"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","verifierAdapter":"golang@1"}

module 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"
	"log"

	"golang.org/x/lint"
)

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

	src := []byte(`// Package mathutil provides basic math operations.
package mathutil

// Multiply returns the product of a and b.
func Multiply(a, b int) int {
	return a * b
}
`)

	problems, err := l.Lint("mathutil.go", src)
	if err != nil {
		log.Fatalf("failed to lint source: %v", err)
	}

	fmt.Printf("Linted mathutil.go: %d problem(s) found.\n", len(problems))
	for _, p := range problems {
		fmt.Printf("- [%s] %s (confidence: %.2f)\n", p.Category, p.Text, p.Confidence)
	}
}

{
  "schemaVersion": 1,
  "goal": "verify 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"
  ]
}

package main

import (
	"fmt"
	"os"
	"strings"

	"golang.org/x/lint"
)

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

	// 1. linter.Lint returns no problems and nil error for clean documented code
	cleanSrc := []byte(`// Package sample provides utilities.
package sample

// Greet returns a greeting string.
func Greet(name string) string {
	return "hello " + name
}
`)
	problems, err := l.Lint("sample.go", cleanSrc)
	if err != nil {
		fmt.Fprintf(os.Stderr, "Assertion 1 failed: Lint returned error: %v\n", err)
		os.Exit(1)
	}
	if len(problems) != 0 {
		fmt.Fprintf(os.Stderr, "Assertion 1 failed: expected 0 problems, got %d\n", len(problems))
		os.Exit(1)
	}

	// 2. linter.Lint detects missing comment on exported function with comments category and confidence 1.0
	undocSrc := []byte(`// Package sample provides utilities.
package sample

func UndocumentedFunc() {}
`)
	problems, err = l.Lint("sample.go", undocSrc)
	if err != nil {
		fmt.Fprintf(os.Stderr, "Assertion 2 failed: Lint returned error: %v\n", err)
		os.Exit(1)
	}
	var foundMissingComment bool
	for _, p := range problems {
		if p.Category == "comments" && strings.Contains(p.Text, "exported function UndocumentedFunc should have comment") {
			if p.Confidence < 0.8 {
				fmt.Fprintf(os.Stderr, "Assertion 2 failed: expected high confidence, got %f\n", p.Confidence)
				os.Exit(1)
			}
			foundMissingComment = true
			break
		}
	}
	if !foundMissingComment {
		fmt.Fprintf(os.Stderr, "Assertion 2 failed: did not detect missing doc comment\n")
		os.Exit(1)
	}

	// 3. linter.Lint detects underscore in variable name with naming category
	namingSrc := []byte(`// Package sample provides utilities.
package sample

// Compute runs calculation.
func Compute() {
	var user_count int
	_ = user_count
}
`)
	problems, err = l.Lint("sample.go", namingSrc)
	if err != nil {
		fmt.Fprintf(os.Stderr, "Assertion 3 failed: Lint returned error: %v\n", err)
		os.Exit(1)
	}
	var foundNamingIssue bool
	for _, p := range problems {
		if p.Category == "naming" && strings.Contains(p.Text, "don't use underscores in Go names") {
			foundNamingIssue = true
			break
		}
	}
	if !foundNamingIssue {
		fmt.Fprintf(os.Stderr, "Assertion 3 failed: did not detect naming issue\n")
		os.Exit(1)
	}

	// 4. linter.Lint returns error on invalid Go source syntax
	invalidSrc := []byte(`package sample
func ( {
`)
	_, err = l.Lint("bad.go", invalidSrc)
	if err == nil {
		fmt.Fprintf(os.Stderr, "Assertion 4 failed: expected syntax error, got nil\n")
		os.Exit(1)
	}

	// 5. linter.LintFiles checks multiple files in a package and returns combined problems
	files := map[string][]byte{
		"file1.go": []byte("// Package sample provides utilities.\npackage sample\n\nfunc UndocOne() {}\n"),
		"file2.go": []byte("// Package sample provides utilities.\npackage sample\n\nfunc UndocTwo() {}\n"),
	}
	problems, err = l.LintFiles(files)
	if err != nil {
		fmt.Fprintf(os.Stderr, "Assertion 5 failed: LintFiles returned error: %v\n", err)
		os.Exit(1)
	}
	var hasFile1, hasFile2 bool
	for _, p := range problems {
		if strings.Contains(p.Text, "UndocOne") && p.Position.Filename == "file1.go" {
			hasFile1 = true
		}
		if strings.Contains(p.Text, "UndocTwo") && p.Position.Filename == "file2.go" {
			hasFile2 = true
		}
	}
	if !hasFile1 || !hasFile2 {
		fmt.Fprintf(os.Stderr, "Assertion 5 failed: expected problems from both file1 and file2, got hasFile1=%v, hasFile2=%v\n", hasFile1, hasFile2)
		os.Exit(1)
	}

	// 6. Problem.String contains the problem text and reference URL
	prob := problems[0]
	probStr := prob.String()
	if !strings.Contains(probStr, prob.Text) {
		fmt.Fprintf(os.Stderr, "Assertion 6 failed: Problem.String does not contain problem text: %s\n", probStr)
		os.Exit(1)
	}
	if len(prob.Link) > 0 && !strings.Contains(probStr, prob.Link) {
		fmt.Fprintf(os.Stderr, "Assertion 6 failed: Problem.String does not contain link: %s\n", probStr)
		os.Exit(1)
	}

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