登录
首页 >  Golang >  Go问答

如何将两个 Cobra CLI 合并为一个?

来源:stackoverflow

时间:2024-03-09 18:21:23 496浏览 收藏

一分耕耘,一分收获!既然都打开这篇《如何将两个 Cobra CLI 合并为一个?》,就坚持看下去,学下去吧!本文主要会给大家讲到等等知识点,如果大家对本文有好的建议或者看到有不足之处,非常欢迎大家积极提出!在后续文章我会继续更新Golang相关的内容,希望对大家都有所帮助!

问题内容

我有以下 cli a 命令(请参阅真实存储库):

$ cli-a -h

usage:
  cli-a [command]

available commands:
  command-a1       command description
  command-a2       command description
  command-a3       command description

flags:
      --config string   config file (default is $home/.cli-a.json)
  -h, --help            help for cli-a

use "cli-a [command] --help" for more information about a command.

对于 cli b,我有以下命令(请参阅真实的存储库):

$ cli-b -h

usage:
  cli-b [command]

available commands:
  command-b1       command description
  command-b2       command description
  command-b3       command description

flags:
      --kubeconfig string   path to kubeconfig file
  -h, --help                help for cli-b

use "cli-b [command] --help" for more information about a command.

我现在想做的是,我希望 cli b(及其所有子命令)成为 cli a 的子命令,如下所示:

$ cli-a -h

usage:
  cli-a [command]

available commands:
  command-a1       command description
  command-a2       command description
  command-a3       command description
  cli-b            description about cli-b

flags:
      --config string   config file (default is $home/.cli-a.json)
  -h, --help            help for cli-a

use "cli-a [command] --help" for more information about a command.

因此,当用户运行 $ cli-a cli-b -h 时,他们会看到:

$ cli-a cli-b -h

Usage:
  cli-a cli-b [command]

Available Commands:
  command-b1       command description
  command-b2       command description
  command-b3       command description

Flags:
      --kubeconfig string   path to kubeconfig file
  -h, --help                help for cli-b

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

两个存储库都位于不同的 go 模块名称/存储库中。如果用户不喜欢下载和使用 cli a 中的所有功能,我仍然想向他们提供 cli b 供他们下载。

cli b 的大部分工作(功能、错误修复等)将在 cli b 存储库中完成,我正在考虑将它们两个合并到我的 cli a 的 ci 管道中(需要考虑如何做)这也是)。

如果可能的话,我不想每次更改 cli b 代码库(业务逻辑、cli 标志等)时都更改/更新 cli a 代码库中的任何内容。我希望 cli a 就像 cli b 的代理服务器一样(我在这里使用类比) - 所有业务逻辑都保存在 cli b 代码库中。

而且,如果您仔细查看上面的示例输出,当用户运行 $ cli-a cli-b -h$ cli-a cli-b command-bn [-h] 时,我不希望cli a 的根标志 (--config) 出现并生效。相反,我希望 cli b 的根标志 (--kubeconfig) 显示并生效。

问题

  1. 这对于 cobra 可行吗?
  2. 在 cli a 的存储库中不添加太多代码的情况下实现此目标的最佳方法是什么?
  3. 项目结构/树应该是什么样子?
  4. 有什么好的例子可供我参考吗?
  5. 从总体上来说,我应该在 cli a 的构建/ci 管道中做什么才能实现这一点?

我非常感谢这里的所有输入、指针、示例和外部资源。预先感谢您。


正确答案


我已经做了类似的事情,您可以将两个 cli 维护为不同的模块,无需合并代码。

您在 cli-a 的 root 命令中所需要做的就是

cliarootcommand.addcommand(
       clibpackage.newrootcommand(),
)

对于问题的第二部分,clia 的持久标志不是 clib 的一部分。我们在clib中禁用标志解析​​,并在clib根命令的prerune中,我们可以将所有父标志标记为隐藏,然后解析标志。

func NewRootCommand() *cobra.Command {
    rootCommand := &cobra.Command{
        Use: "cli-b",
        PersistentPreRunE: func(cmd *cobra.Command, args []string) error {
            // marking all parent flag hidden
            cmd.Parent().Flags().VisitAll(
                func(f *pflag.Flag) {
                    cmd.Flags().MarkHidden(f.Name)
                },
            )

            // enabling flag parsing
            cmd.DisableFlagParsing = false

            if err := cmd.ParseFlags(args); err != nil {
                return err
            }
            if cmd.Flag("help").Changed {
                err := cmd.Help()
                if err != nil {
                    return err
                }
                os.Exit(0)
            }
            return nil
        },
        RunE: func(cmd *cobra.Command, args []string) error {
            return cmd.help()
        },
    }
    
    //Diasbling flag parsing
    rootCommand.DisableFlagParsing = true

    return rootCommand
}

今天带大家了解了的相关知识,希望对你有所帮助;关于Golang的技术知识我们会一点点深入介绍,欢迎大家关注golang学习网公众号,一起学习编程~

声明:本文转载于:stackoverflow 如有侵犯,请联系study_golang@163.com删除
相关阅读
更多>
最新阅读
更多>
课程推荐
更多>