golang.org/x/tools v0.0.0-20190425163242-31fd60d6bfdc: imports.Process

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/tools@v0.0.0-20190425163242-31fd60d6bfdc
Kind: HOW

Use EXACTLY these public packages and versions:
  - pkg:golang/golang.org/x/tools@v0.0.0-20190425163242-31fd60d6bfdc
Demonstrate these symbols/APIs:
  - golang.org/x/tools/imports.Process

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:2035879cd04750045945943e9cc6ff5b8b7482eed728cb77db6855e871bc59c6","contract":["imports.Process automatically inserts missing standard library imports for referenced symbols","imports.Process automatically removes unused imports from Go source code","imports.Process formats and canonicalizes Go code when nil Options is provided","imports.Process with Options.FormatOnly true formats source code without adding or removing imports","imports.Process with Options.Fragment true processes declaration fragments without requiring package declaration","imports.Process returns an error when given invalid Go syntax that cannot be parsed"],"goal":"verify pkg:golang/golang.org/x/tools@v0.0.0-20190425163242-31fd60d6bfdc","kind":"HOW","packages":["pkg:golang/golang.org/x/tools@v0.0.0-20190425163242-31fd60d6bfdc"],"schemaVersion":1,"symbols":["golang.org/x/tools/imports.Process"]},"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/tools@v0.0.0-20190425163242-31fd60d6bfdc"],"schemaVersion":1,"subject":"pkg:golang/golang.org/x/tools@v0.0.0-20190425163242-31fd60d6bfdc","symbols":["golang.org/x/tools/imports.Process"],"verifierAdapter":"golang@1"}

module sample

go 1.26.6

require golang.org/x/tools v0.0.0-20190425163242-31fd60d6bfdc

golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w=
golang.org/x/net v0.0.0-20190311183353-d8887717615a/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg=
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/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
golang.org/x/tools v0.0.0-20190425163242-31fd60d6bfdc h1:N3zlSgxkefUH/ecsl37RWTkESTB026kmXzNly8TuZCI=
golang.org/x/tools v0.0.0-20190425163242-31fd60d6bfdc/go.mod h1:RgjU9mgBXZiqYHBnxXauZ1Gv1EHHAz9KjViQ78xBX0Q=

package sample

import (
	"golang.org/x/tools/imports"
)

// FormatAndFixImports formats Go source code and resolves missing/unused imports.
func FormatAndFixImports(filename string, src []byte, opt *imports.Options) ([]byte, error) {
	return imports.Process(filename, src, opt)
}

{
  "schemaVersion": 1,
  "goal": "verify pkg:golang/golang.org/x/tools@v0.0.0-20190425163242-31fd60d6bfdc",
  "kind": "HOW",
  "packages": [
    "pkg:golang/golang.org/x/tools@v0.0.0-20190425163242-31fd60d6bfdc"
  ],
  "symbols": [
    "golang.org/x/tools/imports.Process"
  ]
}

package main

import (
	"fmt"
	"os"
	"strings"

	"golang.org/x/tools/imports"
)

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

func runTests() error {
	// 1. imports.Process automatically inserts missing standard library imports for referenced symbols
	{
		src := []byte("package main\n\nfunc main() {\n\tfmt.Println(\"test\")\n}\n")
		res, err := imports.Process("main.go", src, nil)
		if err != nil {
			return fmt.Errorf("test 1 (insert missing import) failed: %w", err)
		}
		out := string(res)
		if !strings.Contains(out, `import "fmt"`) && !strings.Contains(out, `"fmt"`) {
			return fmt.Errorf("test 1: expected 'fmt' import to be added, got:\n%s", out)
		}
	}

	// 2. imports.Process automatically removes unused imports from Go source code
	{
		src := []byte("package main\n\nimport (\n\t\"os\"\n\t\"strings\"\n)\n\nfunc main() {\n\t_ = strings.ToLower(\"abc\")\n}\n")
		res, err := imports.Process("main.go", src, nil)
		if err != nil {
			return fmt.Errorf("test 2 (remove unused import) failed: %w", err)
		}
		out := string(res)
		if strings.Contains(out, `"os"`) {
			return fmt.Errorf("test 2: expected unused 'os' import to be removed, got:\n%s", out)
		}
		if !strings.Contains(out, `"strings"`) {
			return fmt.Errorf("test 2: expected used 'strings' import to remain, got:\n%s", out)
		}
	}

	// 3. imports.Process formats and canonicalizes Go code when nil Options is provided
	{
		src := []byte("package main\n\nfunc  foo( a,b  int )int{return   a+b}\n")
		res, err := imports.Process("main.go", src, nil)
		if err != nil {
			return fmt.Errorf("test 3 (formatting with nil options) failed: %w", err)
		}
		expected := "package main\n\nfunc foo(a, b int) int { return a + b }\n"
		if string(res) != expected {
			return fmt.Errorf("test 3: unexpected formatted output.\nExpected:\n%q\nGot:\n%q", expected, string(res))
		}
	}

	// 4. imports.Process with Options.FormatOnly true formats source code without adding or removing imports
	{
		src := []byte("package main\n\nimport \"os\"\n\nfunc  main() {\n\tfmt.Println( \"unimported\" )\n}\n")
		opt := &imports.Options{
			FormatOnly: true,
			Comments:   true,
			TabIndent:  true,
			TabWidth:   8,
		}
		res, err := imports.Process("main.go", src, opt)
		if err != nil {
			return fmt.Errorf("test 4 (FormatOnly true) failed: %w", err)
		}
		out := string(res)
		if !strings.Contains(out, `import "os"`) {
			return fmt.Errorf("test 4: expected unused 'os' import not to be removed with FormatOnly=true, got:\n%s", out)
		}
		if strings.Contains(out, `"fmt"`) {
			return fmt.Errorf("test 4: expected missing 'fmt' import not to be added with FormatOnly=true, got:\n%s", out)
		}
		if !strings.Contains(out, `fmt.Println("unimported")`) {
			return fmt.Errorf("test 4: expected formatting to be applied, got:\n%s", out)
		}
	}

	// 5. imports.Process with Options.Fragment true processes declaration fragments without requiring package declaration
	{
		src := []byte("func foo() {\nfmt.Println(\"fragment\")\n}\n")
		opt := &imports.Options{
			Fragment:  true,
			Comments:  true,
			TabIndent: true,
			TabWidth:  8,
		}
		res, err := imports.Process("fragment.go", src, opt)
		if err != nil {
			return fmt.Errorf("test 5 (Fragment true) failed: %w", err)
		}
		out := string(res)
		if !strings.Contains(out, `import "fmt"`) {
			return fmt.Errorf("test 5: expected import to be added for fragment, got:\n%s", out)
		}
		if !strings.Contains(out, "func foo() {\n\tfmt.Println(\"fragment\")\n}") {
			return fmt.Errorf("test 5: unexpected fragment output:\n%s", out)
		}
	}

	// 6. imports.Process returns an error when given invalid Go syntax that cannot be parsed
	{
		src := []byte("package main\n\nfunc broken( {\n")
		_, err := imports.Process("broken.go", src, nil)
		if err == nil {
			return fmt.Errorf("test 6: expected error for invalid syntax, got nil")
		}
	}

	return nil
}