go - 如何将 cobra 子命令源放入单独的文件夹中

Question

我是一名 Go 初学者，我正在尝试使用 Cobra 创建一个 CLI .为了引导项目，我使用了 Cobra Generator ，生成了一个命令，一个子命令，一切正常。

我现在有这种类型的布局:

cli
├── cmd
│   ├── command.go
│   ├── root.go
│   ├── subcommand.go
├── go.mod
├── go.sum
└── main.go

这不适合我，假设我的项目打算有很多命令，或者很多命令命名空间，每个都由不同的团队拥有，它会变得非常困惑且难以维护。我更喜欢这样的布局:

cli
├── cmd
│   ├── command
│   │   ├── command.go
│   │   └── subcommand.go
│   └── root.go
├── go.mod
├── go.sum
└── main.go

现在，我对在 Go 中完成包和导入的方式缺乏一些了解(即使在阅读文档 here 和 there 之后)，但据我所知，可以跨多个 Go 源访问资源文件，只要它们属于同一个包。但是正如文档中所说，“一个实现可能需要一个包的所有源文件都位于同一目录中。”，所以要实现我想要的布局，我需要有多个包，即每个命令一个命名空间，我认为这很好(或者至少，我不明白这样做有什么问题)。所以这就是我尝试过的:

• 在cmd里面创建一个command目录
• 将command.go文件移动到command目录
• 将 command.go 文件中的 package 子句更改为 command
• 对 subcommand.go 做同样的事情

这构建正常，但找不到命令(错误:“cli”的未知命令“command”)。我以为是因为我从来没有导入那个新的command包，所以我在main.go文件中导入了它，其中cmd包是进口。

构建失败，告诉我 command.go 文件中的 undefined: rootCmd。我猜 command 包无法从 cmd 中看到资源，所以我在 command 中导入了 cmd 包。 go 文件，并将 rootCmd 替换为 cmd.rootCmd (rootCmd 是在 cli/cmd/root.go 文件，Cobra Generator 提供的文件的一部分)。这次我真的抱有希望，但结果还是一样(undefined: cmd.rootCmd)，现在我迷路了。

我是否正在尝试做 Cobra 无法做到的事情？

我是否正在尝试使用 Cobra 做一些可能的事情，但不使用 Cobra 生成器？

我是否正在尝试做一些根本不应该做的事情(比如 Go 试图保护我免受糟糕的设计)？

如果没有，我应该如何进行？

Answer 1

您无法使用 cobra-cli 命令获得所需的布局，但您当然可以手动设置。让我们从 cobra-cli layou 开始:

$ go mod init example
$ cobra-cli init

然后添加几个命令:

$ cobra-cli add foo
$ cobra-cli add bar

这让我们:

.
├── cmd
│   ├── bar.go
│   ├── foo.go
│   └── root.go
├── go.mod
├── go.sum
├── LICENSE
└── main.go

让我们首先将命令移动到子目录中，以便我们拥有所需的布局。这让我们:

.
├── cmd
│   ├── bar
│   │   └── bar.go
│   ├── foo
│   │   └── foo.go
│   └── root.go
├── go.mod
├── go.sum
├── LICENSE
└── main.go

现在我们需要对代码进行一些更改以使其正常工作。

1. 因为我们的子命令现在位于单独的包中，所以我们需要重命名 rootCmd 以便它可以导出。

   find cmd -name '*.go' -print | xargs sed -i 's/rootCmd/RootCmd/g'
   

2. 我们需要每个子命令都在自己的包中，因此我们将 cmd/foo/foo.go 顶部的 package cmd 替换为package foo，以及 cmd/bar/bar.go 中的 package bar。

3. 我们需要子命令来导入根命令，以便它们可以调用 RootCmd.AddCommand。这意味着在 cmd/foo/foo.go 和 cmd/bar/bar.go 中我们需要添加 example/cmd 到我们的 import 部分(回想一下，我们通过 go mod init 命令将顶级包命名为 example)。这意味着每个文件都将以:

   package foo
   
   import (
           "fmt"
   
           "example/cmd"
           "github.com/spf13/cobra"
   )
   

   作为此更改的一部分，我们还需要更新对 AddCommand 的引用以使用显式包名称:

   func init() {
     cmd.RootCmd.AddCommand(fooCmd)
   }
   

4. 最后，我们需要在某处导入子命令。现在我们从不导入 foo 或 bar 包，所以代码实际上是不可见的(尝试在其中一个文件中引入严重的语法错误——你会看到go build 将成功，因为这些文件未在任何地方引用)。

   我们可以在顶级 main.go 文件中执行此操作:

   package main
   
   import (
     "example/cmd"
     _ "example/cmd/bar"
     _ "example/cmd/foo"
   )
   
   func main() {
     cmd.Execute()
   }
   

现在，如果我们构建并运行代码，我们会看到我们的 foo 和 bar 命令可用:

$ go build
$ ./example
A longer description that spans multiple lines and likely contains
examples and usage of using your application. For example:

Cobra is a CLI library for Go that empowers applications.
This application is a tool to generate the needed files
to quickly create a Cobra application.

Usage:
  example [command]

Available Commands:
  bar         A brief description of your command
  completion  Generate the autocompletion script for the specified shell
  foo         A brief description of your command
  help        Help about any command

Flags:
  -h, --help     help for example
  -t, --toggle   Help message for toggle

Use "example [command] --help" for more information about a command.