golang.org/x/lint v0.0.0-20210508222113-6edffad5e616: 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 lint.Linter in pkg:golang/golang.org/x/lint@v0.0.0-20210508222113-6edffad5e616
Kind: HOW

Use EXACTLY these public packages and versions:
  - pkg:golang/golang.org/x/lint@v0.0.0-20210508222113-6edffad5e616
Demonstrate these symbols/APIs:
  - 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:aa714c9ef00eec298b05eb08ac1b728b35b5acbf26f21a2a51b8a4759f3761fe","contract":["lint.Linter.Lint returns zero problems on well-formed Go source with package and exported symbol comments","lint.Linter.Lint reports a naming category problem suggesting camelCase when a variable name contains underscores","lint.Linter.LintFiles lints a map of filename to source bytes for a package and attributes each reported problem to its source filename"],"goal":"verify lint.Linter in pkg:golang/golang.org/x/lint@v0.0.0-20210508222113-6edffad5e616","kind":"HOW","packages":["pkg:golang/golang.org/x/lint@v0.0.0-20210508222113-6edffad5e616"],"schemaVersion":1,"symbols":["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-20210508222113-6edffad5e616"],"schemaVersion":1,"subject":"pkg:golang/golang.org/x/lint@v0.0.0-20210508222113-6edffad5e616","symbols":["lint.Linter"],"verifierAdapter":"golang@1"}

module sample

go 1.26.6

require golang.org/x/lint v0.0.0-20210508222113-6edffad5e616

require golang.org/x/tools v0.0.0-20200130002326-2f3ba24bd6e7 // indirect

golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w=
golang.org/x/crypto v0.0.0-20191011191535-87dc89f01550/go.mod h1:yigFU9vqHzYiE8UmvKecakEJjdnWj3jj499lnFckfCI=
golang.org/x/lint v0.0.0-20210508222113-6edffad5e616 h1:VLliZ0d+/avPrXXH+OakdXhpJuEoBZuwh1m2j7U6Iug=
golang.org/x/lint v0.0.0-20210508222113-6edffad5e616/go.mod h1:3xt1FjdF8hUf6vQPIChWIBhFzV8gjjsPE/fR3IyQdNY=
golang.org/x/mod v0.1.1-0.20191105210325-c90efee705ee/go.mod h1:QqPTAvyqsEbceGzBzNggFXnrqF1CaUcvgkdR5Ot7KZg=
golang.org/x/net v0.0.0-20190404232315-eb5bcb51f2a3/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg=
golang.org/x/net v0.0.0-20190620200207-3b0461eec859/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s=
golang.org/x/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
golang.org/x/sys v0.0.0-20190412213103-97732733099d/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
golang.org/x/tools v0.0.0-20200130002326-2f3ba24bd6e7 h1:EBZoQjiKKPaLbPrbpssUfuHtwM6KV/vb4U85g/cigFY=
golang.org/x/tools v0.0.0-20200130002326-2f3ba24bd6e7/go.mod h1:TB2adYChydJhpapKDTa4BR/hXlZSLoq2Wpct/0txZ28=
golang.org/x/xerrors v0.0.0-20191011141410-1b5146add898/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=

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

package main

import (
	"fmt"
	"os"
	"strings"

	"golang.org/x/lint"
)

func main() {
	var linter lint.Linter

	cleanSrc := []byte("// Package p provides clean code.\npackage p\n\n// Value is an exported constant.\nconst Value = 1\n")
	cleanProblems, err := linter.Lint("clean.go", cleanSrc)
	if err != nil {
		fmt.Fprintf(os.Stderr, "unexpected error on clean source: %v\n", err)
		os.Exit(1)
	}
	if len(cleanProblems) != 0 {
		fmt.Fprintf(os.Stderr, "expected 0 problems for clean source, got %d\n", len(cleanProblems))
		os.Exit(1)
	}

	flawedSrc := []byte("// Package p provides clean code.\npackage p\n\nvar my_var = 42\n")
	problems, err := linter.Lint("flawed.go", flawedSrc)
	if err != nil {
		fmt.Fprintf(os.Stderr, "unexpected error on flawed source: %v\n", err)
		os.Exit(1)
	}
	if len(problems) != 1 {
		fmt.Fprintf(os.Stderr, "expected 1 problem for underscore var, got %d: %+v\n", len(problems), problems)
		os.Exit(1)
	}
	if problems[0].Category != "naming" || !strings.Contains(problems[0].Text, "myVar") {
		fmt.Fprintf(os.Stderr, "unexpected problem details: %+v\n", problems[0])
		os.Exit(1)
	}

	filesProblems, err := linter.LintFiles(map[string][]byte{
		"clean.go":  cleanSrc,
		"flawed.go": flawedSrc,
	})
	if err != nil {
		fmt.Fprintf(os.Stderr, "unexpected error on LintFiles: %v\n", err)
		os.Exit(1)
	}
	if len(filesProblems) != 1 || filesProblems[0].Category != "naming" || filesProblems[0].Position.Filename != "flawed.go" {
		fmt.Fprintf(os.Stderr, "unexpected LintFiles result: %+v\n", filesProblems)
		os.Exit(1)
	}
}