mirror of
https://gitea.com/Lydanne/buildx.git
synced 2025-06-04 20:05:46 +08:00
53 lines
1.6 KiB
Go
53 lines
1.6 KiB
Go
// Copyright 2017 cli-docs-tool authors
|
|
//
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
// you may not use this file except in compliance with the License.
|
|
// You may obtain a copy of the License at
|
|
//
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
// See the License for the specific language governing permissions and
|
|
// limitations under the License.
|
|
|
|
package clidocstool
|
|
|
|
import (
|
|
"github.com/spf13/cobra"
|
|
)
|
|
|
|
// GenTree creates yaml and markdown structured ref files for this command
|
|
// and all descendants in the directory given. This function will just
|
|
// call GenMarkdownTree and GenYamlTree functions successively.
|
|
func GenTree(cmd *cobra.Command, dir string) error {
|
|
var err error
|
|
if err = GenMarkdownTree(cmd, dir); err != nil {
|
|
return err
|
|
}
|
|
if err = GenYamlTree(cmd, dir); err != nil {
|
|
return err
|
|
}
|
|
return nil
|
|
}
|
|
|
|
// VisitAll will traverse all commands from the root.
|
|
// This is different from the VisitAll of cobra.Command where only parents
|
|
// are checked.
|
|
func VisitAll(root *cobra.Command, fn func(*cobra.Command)) {
|
|
for _, cmd := range root.Commands() {
|
|
VisitAll(cmd, fn)
|
|
}
|
|
fn(root)
|
|
}
|
|
|
|
// DisableFlagsInUseLine sets the DisableFlagsInUseLine flag on all
|
|
// commands within the tree rooted at cmd.
|
|
func DisableFlagsInUseLine(cmd *cobra.Command) {
|
|
VisitAll(cmd, func(ccmd *cobra.Command) {
|
|
// do not add a `[flags]` to the end of the usage line.
|
|
ccmd.DisableFlagsInUseLine = true
|
|
})
|
|
}
|