-
Notifications
You must be signed in to change notification settings - Fork 787
/
deprecated.go
120 lines (111 loc) · 3.3 KB
/
deprecated.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
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
package deprecation
import (
"fmt"
"strings"
"github.com/jenkins-x/jx/v2/pkg/util"
"github.com/spf13/cobra"
)
// deprecatedCommands list of deprecated commands along with some more deprecation details
var deprecatedCommands = map[string]deprecationInfo{
"install": {
replacement: "jx boot",
date: "Sep 1 2020",
info: fmt.Sprintf("Please check %s for more details.",
util.ColorStatus("https://jenkins-x.io/docs/getting-started/setup/boot/")),
},
// Todo: Implementation is very tightly coupled with jx install, better to remove it once we remove jx install
"init": {
replacement: "jx boot",
date: "Sep 1 2020",
info: fmt.Sprintf("Please check %s for more details.",
util.ColorStatus("https://jenkins-x.io/docs/getting-started/setup/boot/")),
},
"create spring": {
replacement: "jx create project",
date: "Sep 1 2020",
info: fmt.Sprintf("Please check %s for more details.",
util.ColorStatus("https://jenkins-x.io/commands/jx_create_project/")),
},
"upgrade ingress": {
replacement: "jx boot",
date: "Sep 1 2020",
info: fmt.Sprintf("Please check %s for more details.",
util.ColorStatus("https://jenkins-x.io/docs/getting-started/setup/boot/")),
},
"create vault": {
date: "Sep 1 2020",
info: "This commands will have no replacement.",
},
"delete vault": {
date: "Sep 1 2020",
info: "This commands will have no replacement.",
},
"create addon kubeless": {
replacement: "jx add app jx-app-kubeless",
date: "Sep 1 2020",
},
}
// deprecateInfo keeps some deprecation details related to a command
type deprecationInfo struct {
replacement string
date string
info string
}
// DeprecateCommands runs recursively over all commands and set the deprecation message
// on every command defined the deprecated commands map.
func DeprecateCommands(cmd *cobra.Command) {
path := commandPath(cmd)
if deprecation, ok := deprecatedCommands[path]; ok {
cmd.Deprecated = deprecationMessage(deprecation)
}
if !cmd.HasSubCommands() {
return
}
for _, c := range cmd.Commands() {
DeprecateCommands(c)
}
}
// GetRemovalDate returns the date when the command is planned to be removed
func GetRemovalDate(cmd *cobra.Command) string {
path := commandPath(cmd)
if deprecation, ok := deprecatedCommands[path]; ok {
return deprecation.date
}
return ""
}
// GetReplacement returns the command replacement if any available
func GetReplacement(cmd *cobra.Command) string {
path := commandPath(cmd)
if deprecation, ok := deprecatedCommands[path]; ok {
return deprecation.replacement
}
return ""
}
func deprecationMessage(dep deprecationInfo) string {
var date string
if dep.date != "" {
date = fmt.Sprintf("it will be removed on %s.", util.ColorInfo(dep.date))
} else {
date = "it will be soon removed."
}
var replacement string
if dep.replacement != "" {
replacement = fmt.Sprintf("We now highly recommend you use %s instead.", util.ColorInfo(dep.replacement))
}
msg := fmt.Sprintf("%s %s", date, replacement)
if dep.info != "" {
return fmt.Sprintf("%s %s", msg, dep.info)
}
return msg
}
func commandPath(cmd *cobra.Command) string {
parentText := ""
parent := cmd.Parent()
if parent != nil {
parentText = commandPath(parent)
if parentText != "" {
parentText += " "
}
}
return strings.TrimPrefix(parentText, "jx ") + cmd.Name()
}