go-linting

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

Go Linting

Go代码检查

Source: Uber Go Style Guide

来源：Uber Go风格指南

Core Principle

核心原则

More important than any "blessed" set of linters: lint consistently across a codebase.

Consistent linting helps catch common issues and establishes a high bar for code quality without being unnecessarily prescriptive.

比任何“官方推荐”的代码检查工具集合更重要的是：在整个代码库中保持一致的代码检查标准。

一致的代码检查有助于发现常见问题，并在不过度约束的前提下为代码质量设定高标准。

Minimum Recommended Linters

Linter	Purpose
errcheck	Ensure errors are handled
goimports	Format code and manage imports
revive	Common style mistakes (modern replacement for golint)
govet	Analyze code for common mistakes
staticcheck	Various static analysis checks

检查工具	用途
errcheck	确保错误被正确处理
goimports	格式化代码并管理导入语句
revive	检查常见风格问题（golint的现代替代工具）
govet	分析代码中的常见错误
staticcheck	各类静态分析检查

Lint Runner: golangci-lint

代码检查运行器：golangci-lint

Source: Uber Go Style Guide

Use golangci-lint as your lint runner:

Performance: Optimized for large codebases
Unified config: Configure many linters at once
Extensible: Add linters as needed for your project

See the example .golangci.yml from uber-go/guide.

来源：Uber Go风格指南

使用golangci-lint作为你的代码检查运行器：

性能：针对大型代码库优化
统一配置：可同时配置多个检查工具
可扩展：可根据项目需要添加检查工具

可参考uber-go/guide中的示例.golangci.yml。

Example Configuration

示例配置

Create

.golangci.yml

in your project root:

yaml

linters:
  enable:
    - errcheck
    - goimports
    - revive
    - govet
    - staticcheck

linters-settings:
  goimports:
    local-prefixes: github.com/your-org/your-repo
  revive:
    rules:
      - name: blank-imports
      - name: context-as-argument
      - name: error-return
      - name: error-strings
      - name: exported

run:
  timeout: 5m

在项目根目录创建

.golangci.yml

文件：

yaml

linters:
  enable:
    - errcheck
    - goimports
    - revive
    - govet
    - staticcheck

linters-settings:
  goimports:
    local-prefixes: github.com/your-org/your-repo
  revive:
    rules:
      - name: blank-imports
      - name: context-as-argument
      - name: error-return
      - name: error-strings
      - name: exported

run:
  timeout: 5m

Running

运行方式

bash

undefined

bash

undefined

Install

安装

go install github.com/golangci/golangci-lint/cmd/golangci-lint@latest

Run all linters

运行所有检查工具

golangci-lint run

Run on specific paths

在指定路径运行

golangci-lint run ./pkg/...

---