Categoryhonnef.co/go/tools
module
0.6.0
Repository: https://github.com/dominikh/go-tools.git
Documentation: pkg.go.dev
Versions
1
Dependencies
0
Dependents
0
Files
0 SLOC

# README

Staticcheck logo
The advanced Go linter

Staticcheck is a state of the art linter for the Go programming language. Using static analysis, it finds bugs and performance issues, offers simplifications, and enforces style rules.

Financial support by private and corporate sponsors guarantees the tool's continued development. Please become a sponsor if you or your company rely on Staticcheck.

Documentation

You can find extensive documentation on Staticcheck on its website.

Installation

Releases

It is recommended that you run released versions of the tools. These releases can be found as git tags (e.g. 2022.1).

The easiest way of installing a release is by using go install, for example go install honnef.co/go/tools/cmd/[email protected]. Alternatively, we also offer prebuilt binaries.

You can find more information about installation and releases in the documentation.

Master

You can also run the master branch instead of a release. Note that while the master branch is usually stable, it may still contain new checks or backwards incompatible changes that break your build. By using the master branch you agree to become a beta tester.

Tools

All of the following tools can be found in the cmd/ directory. Each tool is accompanied by its own README, describing it in more detail.

ToolDescription
staticcheckGo static analysis, detecting bugs, performance issues, and much more.
structlayoutDisplays the layout (field sizes and padding) of structs.
structlayout-optimizeReorders struct fields to minimize the amount of padding.
structlayout-prettyFormats the output of structlayout with ASCII art.

Libraries

In addition to the aforementioned tools, this repository contains the libraries necessary to implement these tools.

Unless otherwise noted, none of these libraries have stable APIs. Their main purpose is to aid the implementation of the tools. You'll have to expect semiregular backwards-incompatible changes if you decide to use these libraries.

System requirements

Staticcheck can be compiled and run with the latest release of Go. It can analyze code targeting any version of Go upto the latest release.

# Packages

Package debug contains helpers for debugging static analyses.
Package knowledge contains manually collected information about Go APIs.
Package lintcmd implements the frontend of an analysis runner.
Package pattern implements a simple language for pattern matching Go ASTs.
Package printf implements a parser for fmt.Printf-style format strings.
Package quickfix contains analyzes that implement code refactorings.
Package simple contains analyzes that simplify code.
Package staticcheck contains analyzes that find bugs and performance issues.
Package stylecheck contains analyzes that enforce style rules.
Package unused contains code for finding unused code.