Skip to content

dominikh/go-tools

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Sep 20, 2024
9c18844 · Sep 20, 2024
Sep 20, 2024
Dec 14, 2020
Aug 13, 2024
May 22, 2024
Jul 1, 2024
May 16, 2024
Mar 30, 2022
Jun 26, 2023
Aug 14, 2024
Aug 22, 2020
Aug 14, 2024
Jun 24, 2024
Sep 20, 2024
Aug 14, 2024
Dec 8, 2022
Jun 3, 2024
Nov 11, 2021
Sep 20, 2024
Jun 28, 2024
Jan 24, 2017
Jun 16, 2024
Sep 20, 2024
Sep 20, 2024
Apr 25, 2022
Jul 1, 2024
Oct 29, 2021
Jan 24, 2017
May 25, 2021
May 22, 2024
Jun 3, 2024
Nov 19, 2023
Jun 24, 2024
Jun 16, 2024
Oct 15, 2023

Repository files navigation

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/staticcheck@2022.1. 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.

Tool Description
staticcheck Go static analysis, detecting bugs, performance issues, and much more.
structlayout Displays the layout (field sizes and padding) of structs.
structlayout-optimize Reorders struct fields to minimize the amount of padding.
structlayout-pretty Formats 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.