https://github.com/dominikh/go-tools

Staticcheck - The advanced Go linter
https://github.com/dominikh/go-tools

linter linters sponsor static-analysis staticcheck

Last synced: 5 days ago
JSON representation

Staticcheck - The advanced Go linter

• Host: GitHub
• URL: https://github.com/dominikh/go-tools
• Owner: dominikh
• License: mit
• Created: 2017-01-24T21:11:01.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2024-10-24T12:32:51.000Z (3 months ago)
• Last Synced: 2024-10-29T19:59:28.580Z (2 months ago)
• Topics: linter, linters, sponsor, static-analysis, staticcheck
• Language: Go
• Homepage: https://staticcheck.dev
• Size: 4.87 MB
• Stars: 6,171
• Watchers: 78
• Forks: 376
• Open Issues: 567
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

• awesome-repositories - dominikh/go-tools - Staticcheck - The advanced Go linter (Go)
• awesome-github-star - go-tools - The advanced Go linter | dominikh | 5584 | (Go)
• awesome-list - go-tools - The advanced Go linter | dominikh | 4075 | (Go)
• go-awesome - Staticcheck - A set of static Go code analysis tools (Open source library / Code Analysis)
• awesome-go-extra - go-tools - The advanced Go linter|4905|321|503|2017-01-24T21:11:01Z|2022-08-24T15:59:08Z| (Code Analysis / Routers)
• awesome-security-collection - **2967**星
• my-awesome - dominikh/go-tools - analysis,staticcheck pushed_at:2024-11 star:6.3k fork:0.4k Staticcheck - The advanced Go linter (Go)

README

        


	





		The advanced Go linter

	



Staticcheck is a state of the art linter for the [Go programming

language](https://go.dev/). Using static analysis, it finds bugs and performance issues,

offers simplifications, and enforces style rules.

**Financial support by [private and corporate sponsors](https://staticcheck.dev/sponsors) guarantees the tool's continued development.

Please [become a sponsor](https://github.com/users/dominikh/sponsorship) if you or your company rely on Staticcheck.**

## Documentation

You can find extensive documentation on Staticcheck on [its website](https://staticcheck.dev/docs/).

## 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](https://github.com/dominikh/go-tools/releases).

You can find more information about installation and releases in the [documentation](https://staticcheck.dev/docs/getting-started/).

### 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](cmd/staticcheck/)                    | Go static analysis, detecting bugs, performance issues, and much more. |

| [structlayout](cmd/structlayout/)                  | Displays the layout (field sizes and padding) of structs.               |

| [structlayout-optimize](cmd/structlayout-optimize) | Reorders struct fields to minimize the amount of padding.               |

| [structlayout-pretty](cmd/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.