golang.org/x/tools v0.0.0-20200825202427-b303f430e36d: imports.Options

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/tools/imports.Options in pkg:golang/golang.org/x/tools@v0.0.0-20200825202427-b303f430e36d
Kind: HOW

Use EXACTLY these public packages and versions:
  - pkg:golang/golang.org/x/tools@v0.0.0-20200825202427-b303f430e36d
Demonstrate these symbols/APIs:
  - golang.org/x/tools/imports.Options

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:690095844a3aa5aad617f14e68d1cca472791e467b54b366ebe56803a8b4639d","contract":["imports.Options struct initializes with zero values for all configuration fields","imports.Options with FormatOnly true suppresses adding missing imports and removing unused imports","imports.Options with FormatOnly false allows automatic addition of missing imports and removal of unused imports","imports.Options with Fragment true permits processing declaration fragments while Fragment false rejects them","imports.Options with Comments false strips comments from formatted output while nil Options preserves comments"],"goal":"verify golang.org/x/tools/imports.Options in pkg:golang/golang.org/x/tools@v0.0.0-20200825202427-b303f430e36d","kind":"HOW","packages":["pkg:golang/golang.org/x/tools@v0.0.0-20200825202427-b303f430e36d"],"schemaVersion":1,"symbols":["golang.org/x/tools/imports.Options"]},"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-20200825202427-b303f430e36d"],"schemaVersion":1,"subject":"pkg:golang/golang.org/x/tools@v0.0.0-20200825202427-b303f430e36d","symbols":["golang.org/x/tools/imports.Options"],"verifierAdapter":"golang@1"}

module sample

go 1.21

require golang.org/x/tools v0.0.0-20200825202427-b303f430e36d

require (
	golang.org/x/mod v0.3.0 // indirect
	golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543 // indirect
)

github.com/yuin/goldmark v1.1.32/go.mod h1:3hX8gzYuyVAZsxl0MRgGTJEmQBFcNTphYh9decYSb74=
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/crypto v0.0.0-20200622213623-75b288015ac9/go.mod h1:LzIPMQfyMNhhGPhUkYOs5KpL4U8rLKemX1yGLhDgUto=
golang.org/x/mod v0.3.0 h1:RM4zey1++hCTbCVQfnWeKs9/IEsaBLA8vTkd0WVtmH4=
golang.org/x/mod v0.3.0/go.mod h1:s0Qsj1ACt9ePp/hMypM3fl4fZqREWJwdYDEqhRiZZUA=
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/net v0.0.0-20200625001655-4c5254603344/go.mod h1:/O7V0waA8r7cgGh81Ro3o1hOxt32SMVPicZroKQ2sZA=
golang.org/x/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
golang.org/x/sync v0.0.0-20200625203802-6e8e738ad208/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/sys v0.0.0-20200323222414-85ca7c5b95cd/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
golang.org/x/tools v0.0.0-20191119224855-298f0cb1881e/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo=
golang.org/x/tools v0.0.0-20200825202427-b303f430e36d h1:W07d4xkoAUSNOkOzdzXCdFGxT7o2rW4q8M34tB2i//k=
golang.org/x/tools v0.0.0-20200825202427-b303f430e36d/go.mod h1:njjCfa9FT2d7l9Bc6FUM5FLjQPp3cFF28FI3qnDFljA=
golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
golang.org/x/xerrors v0.0.0-20191011141410-1b5146add898/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543 h1:E7g+9GITq07hpfrRu66IVDexMakfv52eLZ2CXBWiKr4=
golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=

package main

import (
	"fmt"
	"os"

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

func main() {
	src := []byte("package main\n\nfunc main() {\n\tfmt.Println(\"sample demonstration\")\n}\n")
	opt := &imports.Options{
		FormatOnly: false,
		Comments:   true,
		TabIndent:  true,
		TabWidth:   8,
	}

	res, err := imports.Process("main.go", src, opt)
	if err != nil {
		fmt.Fprintf(os.Stderr, "failed to process: %v\n", err)
		os.Exit(1)
	}

	fmt.Print(string(res))
}

{
  "schemaVersion": 1,
  "goal": "verify golang.org/x/tools/imports.Options in pkg:golang/golang.org/x/tools@v0.0.0-20200825202427-b303f430e36d",
  "kind": "HOW",
  "packages": [
    "pkg:golang/golang.org/x/tools@v0.0.0-20200825202427-b303f430e36d"
  ],
  "symbols": [
    "golang.org/x/tools/imports.Options"
  ]
}

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 assertions passed.")
}

func runTests() error {
	// 1. imports.Options struct initializes with zero values for all configuration fields
	{
		var opt imports.Options
		if opt.Fragment != false || opt.AllErrors != false || opt.Comments != false ||
			opt.TabIndent != false || opt.TabWidth != 0 || opt.FormatOnly != false {
			return fmt.Errorf("test 1: expected zero-value Options fields, got %+v", opt)
		}
	}

	// 2. imports.Options with FormatOnly true suppresses adding missing imports and removing unused imports
	{
		src := []byte("package main\n\nimport \"os\"\n\nfunc main() {\n\tfmt.Println(\"test\")\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 2 failed: %w", err)
		}
		out := string(res)
		if !strings.Contains(out, `import "os"`) {
			return fmt.Errorf("test 2: expected unused import 'os' to be retained with FormatOnly=true, got:\n%s", out)
		}
		if strings.Contains(out, `"fmt"`) {
			return fmt.Errorf("test 2: expected missing import 'fmt' not to be added with FormatOnly=true, got:\n%s", out)
		}
	}

	// 3. imports.Options with FormatOnly false allows automatic addition of missing imports and removal of unused imports
	{
		src := []byte("package main\n\nimport \"os\"\n\nfunc main() {\n\tfmt.Println(\"test\")\n}\n")
		opt := &imports.Options{
			FormatOnly: false,
			Comments:   true,
			TabIndent:  true,
			TabWidth:   8,
		}
		res, err := imports.Process("main.go", src, opt)
		if err != nil {
			return fmt.Errorf("test 3 failed: %w", err)
		}
		out := string(res)
		if strings.Contains(out, `"os"`) {
			return fmt.Errorf("test 3: expected unused import 'os' to be removed with FormatOnly=false, got:\n%s", out)
		}
		if !strings.Contains(out, `"fmt"`) {
			return fmt.Errorf("test 3: expected missing import 'fmt' to be added with FormatOnly=false, got:\n%s", out)
		}
	}

	// 4. imports.Options with Fragment true permits processing declaration fragments while Fragment false rejects them
	{
		frag := []byte("func helper() {\n\t_ = fmt.Sprintf(\"\")\n}\n")

		_, errFalse := imports.Process("fragment.go", frag, &imports.Options{Fragment: false})
		if errFalse == nil {
			return fmt.Errorf("test 4: expected error for fragment when Fragment=false, got nil")
		}

		resTrue, errTrue := imports.Process("fragment.go", frag, &imports.Options{
			Fragment:  true,
			Comments:  true,
			TabIndent: true,
			TabWidth:  8,
		})
		if errTrue != nil {
			return fmt.Errorf("test 4: expected success for fragment when Fragment=true, got error: %w", errTrue)
		}
		if !strings.Contains(string(resTrue), "func helper()") {
			return fmt.Errorf("test 4: expected formatted helper function, got:\n%s", string(resTrue))
		}
	}

	// 5. imports.Options with Comments false strips comments from formatted output while nil Options preserves comments
	{
		src := []byte("package main\n\n// Important comment explaining logic\nfunc main() {\n}\n")

		resNoComment, err := imports.Process("main.go", src, &imports.Options{
			Comments:  false,
			TabIndent: true,
			TabWidth:  8,
		})
		if err != nil {
			return fmt.Errorf("test 5 (Comments=false) failed: %w", err)
		}
		if strings.Contains(string(resNoComment), "Important comment explaining logic") {
			return fmt.Errorf("test 5: expected comment to be stripped with Comments=false, got:\n%s", string(resNoComment))
		}

		resWithComment, err := imports.Process("main.go", src, nil)
		if err != nil {
			return fmt.Errorf("test 5 (nil Options) failed: %w", err)
		}
		if !strings.Contains(string(resWithComment), "Important comment explaining logic") {
			return fmt.Errorf("test 5: expected comment to be preserved with nil Options, got:\n%s", string(resWithComment))
		}
	}

	return nil
}