mirror of
https://github.com/opentofu/opentofu.git
synced 2024-12-30 10:47:14 -06:00
04d00cec9f
These flags are presented as POSIX/GNU-style long-form flags (double-dash), whereas the rest of our CLI flags as seen in sub-commands are presented as single-dash options. While both work in both cases (on part of the flag package allowing double dashes as well), we converge around the single-dash form, so the basic help text here should be consistent.
91 lines
2.4 KiB
Go
91 lines
2.4 KiB
Go
package main
|
|
|
|
import (
|
|
"bytes"
|
|
"fmt"
|
|
"log"
|
|
"sort"
|
|
"strings"
|
|
|
|
"github.com/mitchellh/cli"
|
|
)
|
|
|
|
// helpFunc is a cli.HelpFunc that can is used to output the help for Terraform.
|
|
func helpFunc(commands map[string]cli.CommandFactory) string {
|
|
// Determine the maximum key length, and classify based on type
|
|
porcelain := make(map[string]cli.CommandFactory)
|
|
plumbing := make(map[string]cli.CommandFactory)
|
|
maxKeyLen := 0
|
|
for key, f := range commands {
|
|
if len(key) > maxKeyLen {
|
|
maxKeyLen = len(key)
|
|
}
|
|
|
|
if _, ok := PlumbingCommands[key]; ok {
|
|
plumbing[key] = f
|
|
} else {
|
|
porcelain[key] = f
|
|
}
|
|
}
|
|
|
|
// The output produced by this is included in the docs at
|
|
// website/source/docs/commands/index.html.markdown; if you
|
|
// change this then consider updating that to match.
|
|
helpText := fmt.Sprintf(`
|
|
Usage: terraform [-version] [-help] <command> [args]
|
|
|
|
The available commands for execution are listed below.
|
|
The most common, useful commands are shown first, followed by
|
|
less common or more advanced commands. If you're just getting
|
|
started with Terraform, stick with the common commands. For the
|
|
other commands, please read the help and docs before usage.
|
|
|
|
Common commands:
|
|
%s
|
|
All other commands:
|
|
%s
|
|
`, listCommands(porcelain, maxKeyLen), listCommands(plumbing, maxKeyLen))
|
|
|
|
return strings.TrimSpace(helpText)
|
|
}
|
|
|
|
// listCommands just lists the commands in the map with the
|
|
// given maximum key length.
|
|
func listCommands(commands map[string]cli.CommandFactory, maxKeyLen int) string {
|
|
var buf bytes.Buffer
|
|
|
|
// Get the list of keys so we can sort them, and also get the maximum
|
|
// key length so they can be aligned properly.
|
|
keys := make([]string, 0, len(commands))
|
|
for key, _ := range commands {
|
|
// This is an internal command that users should never call directly so
|
|
// we will hide it from the command listing.
|
|
if key == "internal-plugin" {
|
|
continue
|
|
}
|
|
keys = append(keys, key)
|
|
}
|
|
sort.Strings(keys)
|
|
|
|
for _, key := range keys {
|
|
commandFunc, ok := commands[key]
|
|
if !ok {
|
|
// This should never happen since we JUST built the list of
|
|
// keys.
|
|
panic("command not found: " + key)
|
|
}
|
|
|
|
command, err := commandFunc()
|
|
if err != nil {
|
|
log.Printf("[ERR] cli: Command '%s' failed to load: %s",
|
|
key, err)
|
|
continue
|
|
}
|
|
|
|
key = fmt.Sprintf("%s%s", key, strings.Repeat(" ", maxKeyLen-len(key)))
|
|
buf.WriteString(fmt.Sprintf(" %s %s\n", key, command.Synopsis()))
|
|
}
|
|
|
|
return buf.String()
|
|
}
|