/
cmd_help.go
91 lines (74 loc) · 1.88 KB
/
cmd_help.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
/*
* Turban Shell
* Copyright (C) 2016 Roland Singer <roland.singer[at]desertbit.com>
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
package turban
import (
"fmt"
"sort"
)
//#################//
//### Variables ###//
//#################//
var (
helpHeader = ""
)
//##############//
//### Public ###//
//##############//
// SetHelpHeader sets the header displayed in the help.
func SetHelpHeader(h string) {
helpHeader = h
}
//###############//
//### Private ###//
//###############//
func init() {
AddCommand("help", &Command{
Help: "Print this help text.",
Usage: "help",
Run: func(args []string) error {
// Check if any arguments are passed.
if len(args) > 0 {
return ErrInvalidUsage
}
// Get all command map keys.
i := 0
keys := make([]string, len(commands))
for k := range commands {
keys[i] = k
i++
}
// Sort the keys slice.
sort.Strings(keys)
// Header.
printASCIIArt()
if len(helpHeader) > 0 {
fmt.Printf("\n%s\n", helpHeader)
}
fmt.Print("\nAvailable commands:\n\n")
// Print all available commands with a description.
for _, key := range keys {
printc(" "+key, commands[key].Help)
}
// Flush the output.
flush()
// Print a new empty line.
fmt.Println()
return nil
},
})
}