Code Style Guidelines

# Check if formatting is needed
make fmtcheck

# Or run the script directly
./scripts/gofmtcheck.sh

# Format all files
go fmt ./...

# Format specific package
go fmt ./internal/command

# Check import formatting
make importscheck

# Or run the script directly
./scripts/goimportscheck.sh

# Fix imports in a specific file
go tool golang.org/x/tools/cmd/goimports -w -l path/to/file.go

# Fix imports in all changed files
go tool golang.org/x/tools/cmd/goimports -w -l $(git diff --name-only origin/main | grep ".go")

import (
    "context"
    "fmt"
    
    "github.com/hashicorp/hcl/v2"
    "github.com/zclconf/go-cty/cty"
    
    "github.com/hashicorp/terraform/internal/addrs"
    "github.com/hashicorp/terraform/internal/configs"
)

# Run go vet
make vetcheck

# Or run directly
go vet ./...

# Run staticcheck
make staticcheck

# Or run the script directly
./scripts/staticcheck.sh

make exhaustive

# Or run directly
./scripts/exhaustive.sh

# Check headers (dry run)
make copyright

# Or run the script
./scripts/copyright.sh --plan

# Apply copyright headers
make copyrightfix

# Or run the script
./scripts/copyright.sh

// Package addrs contains types that represent "addresses" of objects
// in Terraform's configuration and state.
package addrs

// ParseResourceAddress parses a string representation of a resource
// address into a ResourceAddress struct.
func ParseResourceAddress(s string) (ResourceAddress, error) {
    // ...
}

// Good: Explains why
// We need to copy the slice here because the caller might mutate it.
newSlice := make([]string, len(oldSlice))
copy(newSlice, oldSlice)

// Bad: Explains what (obvious from code)
// Copy the slice
newSlice := make([]string, len(oldSlice))
copy(newSlice, oldSlice)

// Good
return nil, fmt.Errorf("invalid resource address %q: must include resource type", addr)

// Bad
return nil, errors.New("Invalid address.")

if err := doSomething(); err != nil {
    return fmt.Errorf("failed to do something: %w", err)
}

func TestResourceAddress_Parse(t *testing.T)
func TestResourceAddress_String(t *testing.T)
func TestConfig_Build_WithModules(t *testing.T)

func TestParseName(t *testing.T) {
    tests := map[string]struct {
        input   string
        want    string
        wantErr string
    }{
        "valid name": {
            input: "example",
            want:  "example",
        },
        "invalid empty": {
            input:   "",
            wantErr: "name cannot be empty",
        },
    }
    
    for name, tc := range tests {
        t.Run(name, func(t *testing.T) {
            got, err := ParseName(tc.input)
            // assertions...
        })
    }
}

func testConfig(t *testing.T) *Config {
    t.Helper()
    // ...
}

// Code generated by "tool-name". DO NOT EDIT.

# Most generated code
go generate ./...

# Protocol buffers
make protobuf

# Format code
go fmt ./...

# Organize imports (for changed files)
go tool golang.org/x/tools/cmd/goimports -w -l $(git diff --cached --name-only --diff-filter=ACM | grep '.go$')

# Run all checks
make fmtcheck
make importscheck
make vetcheck
make staticcheck
make copyright

# Run tests
go test ./...

{
    "go.formatTool": "goimports",
    "go.lintTool": "staticcheck",
    "go.lintOnSave": "workspace",
    "editor.formatOnSave": true,
    "go.vetOnSave": "workspace",
    "go.buildOnSave": "workspace"
}