开源项目 `revive` 使用教程

1. 项目的目录结构及介绍

revive 项目的目录结构如下：

revive/
├── .github/
│   └── workflows/
├── defaults/
│   ├── config.toml
│   └── severity.toml
├── formatter/
│   ├── checkstyle.go
│   ├── default.go
│   ├── json.go
│   ├── junit.go
│   ├── ndjson.go
│   ├── raw.go
│   ├── output.go
│   └── teamcity.go
├── lint/
│   ├── linter.go
│   ├── package.go
│   ├── pattern.go
│   ├── rule.go
│   └── runner.go
├── main.go
├── pkg/
│   ├── config/
│   ├── formatter/
│   ├── lint/
│   ├── log/
│   ├── runner/
│   └── testutil/
├── rules/
│   ├── atomic.go
│   ├── cognitive.go
│   ├── complexity.go
│   ├── errors.go
│   ├── import.go
│   ├── naming.go
│   ├── performance.go
│   ├── readability.go
│   ├── redundancy.go
│   ├── security.go
│   ├── simple.go
│   ├── structure.go
│   ├── tests.go
│   ├── unhandled.go
│   ├── unused.go
│   └── whitespace.go
├── testdata/
│   ├── simple/
│   └── unused/
├── .gitignore
├── .travis.yml
├── CHANGELOG.md
├── CONTRIBUTING.md
├── LICENSE
├── Makefile
├── README.md
└── revive.toml

目录结构介绍

• .github/：包含 GitHub 工作流配置文件。
• defaults/：包含默认的配置文件。
• formatter/：包含不同格式的输出器。
• lint/：包含代码检查的核心逻辑。
• main.go：项目的启动文件。
• pkg/：包含项目的各个包。
• rules/：包含各种代码检查规则。
• testdata/：包含测试数据。
• .gitignore：Git 忽略文件配置。
• .travis.yml：Travis CI 配置文件。
• CHANGELOG.md：项目变更日志。
• CONTRIBUTING.md：贡献指南。
• LICENSE：项目许可证。
• Makefile：Makefile 文件。
• README.md：项目说明文档。
• revive.toml：项目的配置文件。

2. 项目的启动文件介绍

项目的启动文件是 main.go，它负责启动和配置 revive 工具。以下是 main.go 的主要内容：

package main

import (
    "fmt"
    "os"

    "github.com/mgechev/revive/cli"
)

func main() {
    if err := cli.Run(os.Args); err != nil {
        fmt.Fprintln(os.Stderr, err)
        os.Exit(1)
    }
}

启动文件介绍

• main 函数：程序的入口点，调用 cli.Run 函数处理命令行参数并启动 revive 工具。
• cli 包：包含命令行接口的实现。

3. 项目的配置文件介绍

revive 的配置文件是 revive.toml，它用于配置代码检查的规则和选项。以下是一个示例配置文件的内容：

# revive.toml

ignoreGeneratedHeader = false
severity = "warning"
confidence = 0.8
errorCode = 0
warningCode = 0

[rule.defer]
  arguments = ["unused"]

[rule.unreachable-code]
  severity = "error"

[rule.exported]
  severity = "warning"
  arguments = ["^Test", "^Example"]

[rule.error-strings]
  severity = "warning"

[rule.string-of-int]
  severity = "warning"

[rule.unhandled-error]
  severity = "error"

配置文件介绍

• ignoreGeneratedHeader：是否忽略生成的文件头。
• severity：默认的规则严重级别。
• confidence：默认的置信度阈值。
• errorCode：错误代码。
• warningCode：警告代码。
• rule：各个规则的配置项。