Arch-Go 项目常见问题解决方案

Arch-Go 项目常见问题解决方案

arch-go Architecture checks for Go projects 项目地址: https://gitcode.com/gh_mirrors/ar/arch-go

Arch-Go 是一个用于对 Go 项目执行架构检查的开源项目。该项目主要使用 Go 编程语言编写。

新手常见问题及解决步骤

问题一：如何配置 Arch-Go？

问题描述： 新手在使用 Arch-Go 时，可能不知道如何配置项目的规则。

解决步骤：

1. 在项目的根目录下创建一个名为 arch-go.yml 的配置文件。
2. 根据官方文档中的示例，设置所需的规则。例如：

version: 1
threshold:
  compliance: 100
  coverage: 100
dependenciesRules:
  - package: "**/impl/*"
    shouldOnlyDependsOn:
      internal: ["**/foo/*", "*bar/*"]
    shouldNotDependsOn:
      internal: ["**/model/**"]
  - package: "**/utils/*"
    shouldOnlyDependsOn: ["**/model/*"]
  - package: "**/foobar/*"
    shouldOnlyDependsOn:
      external: ["gopkg.in/yaml.v3"]
  - package: "**/example/*"
    shouldNotDependsOn:
      external: ["github.com/foobar/example-m"]

3. 保存配置文件并运行 Arch-Go 检查。

问题二：如何运行 Arch-Go 检查？

问题描述： 新手可能不清楚如何执行 Arch-Go 的检查。

解决步骤：

1. 确保已安装 Go 语言环境。
2. 使用 Git 克隆或下载 Arch-Go 项目。
3. 在项目根目录下打开终端或命令提示符。
4. 运行以下命令：

go run main.go

或者在项目根目录下有预编译的二进制文件时，直接运行：

./arch-go

5. 检查终端或命令提示符中的输出结果。

问题三：如何解决 Arch-Go 报告的违规问题？

问题描述： 当 Arch-Go 报告违规时，新手可能不知道如何修复这些问题。

解决步骤：

1. 仔细阅读 Arch-Go 报告的违规信息，确定违规的具体内容。
2. 根据违规信息，检查对应的代码或配置文件。
3. 根据 Arch-Go 的规则调整代码或配置，确保符合规则要求。
4. 重新运行 Arch-Go 检查，验证问题是否已解决。

通过以上步骤，新手可以更好地理解和使用 Arch-Go 项目，解决在项目中遇到的基本问题。

arch-go Architecture checks for Go projects 项目地址: https://gitcode.com/gh_mirrors/ar/arch-go