cscli refact - rename item types for consistency

crowdsecurity · Dec 11, 2023 · 35f984f · 35f984f
1 parent 7e3f512
commit 35f984f
Show file tree

Hide file tree

Showing 8 changed files with 33 additions and 33 deletions.
diff --git a/cmd/crowdsec-cli/hubappsec.go b/cmd/crowdsec-cli/hubappsec.go
@@ -13,8 +13,8 @@ import (
 	"github.com/crowdsecurity/crowdsec/pkg/cwhub"
 )
 
-func NewAppsecConfigCLI() *itemCLI {
-	return &itemCLI{
+func NewCLIAppsecConfig() *cliItem {
+	return &cliItem{
 		name:      cwhub.APPSEC_CONFIGS,
 		singular:  "appsec-config",
 		oneOrMore: "appsec-config(s)",
@@ -46,7 +46,7 @@ cscli appsec-configs list crowdsecurity/vpatch`,
 	}
 }
 
-func NewAppsecRuleCLI() *itemCLI {
+func NewCLIAppsecRule() *cliItem {
 	inspectDetail := func(item *cwhub.Item) error {
 		appsecRule := appsec.AppsecCollectionConfig{}
 		yamlContent, err := os.ReadFile(item.State.LocalPath)
@@ -71,7 +71,7 @@ func NewAppsecRuleCLI() *itemCLI {
 		return nil
 	}
 
-	return &itemCLI{
+	return &cliItem{
 		name:      "appsec-rules",
 		singular:  "appsec-rule",
 		oneOrMore: "appsec-rule(s)",

diff --git a/cmd/crowdsec-cli/hubcollection.go b/cmd/crowdsec-cli/hubcollection.go
@@ -4,8 +4,8 @@ import (
 	"github.com/crowdsecurity/crowdsec/pkg/cwhub"
 )
 
-func NewCollectionCLI() *itemCLI {
-	return &itemCLI{
+func NewCLICollection() *cliItem {
+	return &cliItem{
 		name:      cwhub.COLLECTIONS,
 		singular:  "collection",
 		oneOrMore: "collection(s)",

diff --git a/cmd/crowdsec-cli/hubcontext.go b/cmd/crowdsec-cli/hubcontext.go
@@ -4,8 +4,8 @@ import (
 	"github.com/crowdsecurity/crowdsec/pkg/cwhub"
 )
 
-func NewContextCLI() *itemCLI {
-	return &itemCLI{
+func NewCLIContext() *cliItem {
+	return &cliItem{
 		name:      cwhub.CONTEXTS,
 		singular:  "context",
 		oneOrMore: "context(s)",

diff --git a/cmd/crowdsec-cli/hubparser.go b/cmd/crowdsec-cli/hubparser.go
@@ -4,8 +4,8 @@ import (
 	"github.com/crowdsecurity/crowdsec/pkg/cwhub"
 )
 
-func NewParserCLI() *itemCLI {
-	return &itemCLI{
+func NewCLIParser() *cliItem {
+	return &cliItem{
 		name:      cwhub.PARSERS,
 		singular:  "parser",
 		oneOrMore: "parser(s)",

diff --git a/cmd/crowdsec-cli/hubpostoverflow.go b/cmd/crowdsec-cli/hubpostoverflow.go
@@ -4,8 +4,8 @@ import (
 	"github.com/crowdsecurity/crowdsec/pkg/cwhub"
 )
 
-func NewPostOverflowCLI() *itemCLI {
-	return &itemCLI{
+func NewCLIPostOverflow() *cliItem {
+	return &cliItem{
 		name:      cwhub.POSTOVERFLOWS,
 		singular:  "postoverflow",
 		oneOrMore: "postoverflow(s)",

diff --git a/cmd/crowdsec-cli/hubscenario.go b/cmd/crowdsec-cli/hubscenario.go
@@ -4,8 +4,8 @@ import (
 	"github.com/crowdsecurity/crowdsec/pkg/cwhub"
 )
 
-func NewScenarioCLI() *itemCLI {
-	return &itemCLI{
+func NewCLIScenario() *cliItem {
+	return &cliItem{
 		name:      cwhub.SCENARIOS,
 		singular:  "scenario",
 		oneOrMore: "scenario(s)",

diff --git a/cmd/crowdsec-cli/itemcli.go b/cmd/crowdsec-cli/itemcli.go
@@ -22,7 +22,7 @@ type cliHelp struct {
 	example string
 }
 
-type itemCLI struct {
+type cliItem struct {
 	name          string // plural, as used in the hub index
 	singular      string
 	oneOrMore     string // parenthetical pluralizaion: "parser(s)"
@@ -35,7 +35,7 @@ type itemCLI struct {
 	listHelp      cliHelp
 }
 
-func (it itemCLI) NewCommand() *cobra.Command {
+func (it cliItem) NewCommand() *cobra.Command {
 	cmd := &cobra.Command{
 		Use:               coalesce.String(it.help.use, fmt.Sprintf("%s <action> [item]...", it.name)),
 		Short:             coalesce.String(it.help.short, fmt.Sprintf("Manage hub %s", it.name)),
@@ -55,7 +55,7 @@ func (it itemCLI) NewCommand() *cobra.Command {
 	return cmd
 }
 
-func (it itemCLI) Install(cmd *cobra.Command, args []string) error {
+func (it cliItem) Install(cmd *cobra.Command, args []string) error {
 	flags := cmd.Flags()
 
 	downloadOnly, err := flags.GetBool("download-only")
@@ -103,7 +103,7 @@ func (it itemCLI) Install(cmd *cobra.Command, args []string) error {
 	return nil
 }
 
-func (it itemCLI) NewInstallCmd() *cobra.Command {
+func (it cliItem) NewInstallCmd() *cobra.Command {
 	cmd := &cobra.Command{
 		Use:               coalesce.String(it.installHelp.use, "install [item]..."),
 		Short:             coalesce.String(it.installHelp.short, fmt.Sprintf("Install given %s", it.oneOrMore)),
@@ -138,7 +138,7 @@ func istalledParentNames(item *cwhub.Item) []string {
 	return ret
 }
 
-func (it itemCLI) Remove(cmd *cobra.Command, args []string) error {
+func (it cliItem) Remove(cmd *cobra.Command, args []string) error {
 	flags := cmd.Flags()
 
 	purge, err := flags.GetBool("purge")
@@ -232,7 +232,7 @@ func (it itemCLI) Remove(cmd *cobra.Command, args []string) error {
 	return nil
 }
 
-func (it itemCLI) NewRemoveCmd() *cobra.Command {
+func (it cliItem) NewRemoveCmd() *cobra.Command {
 	cmd := &cobra.Command{
 		Use:               coalesce.String(it.removeHelp.use, "remove [item]..."),
 		Short:             coalesce.String(it.removeHelp.short, fmt.Sprintf("Remove given %s", it.oneOrMore)),
@@ -254,7 +254,7 @@ func (it itemCLI) NewRemoveCmd() *cobra.Command {
 	return cmd
 }
 
-func (it itemCLI) Upgrade(cmd *cobra.Command, args []string) error {
+func (it cliItem) Upgrade(cmd *cobra.Command, args []string) error {
 	flags := cmd.Flags()
 
 	force, err := flags.GetBool("force")
@@ -328,7 +328,7 @@ func (it itemCLI) Upgrade(cmd *cobra.Command, args []string) error {
 	return nil
 }
 
-func (it itemCLI) NewUpgradeCmd() *cobra.Command {
+func (it cliItem) NewUpgradeCmd() *cobra.Command {
 	cmd := &cobra.Command{
 		Use:               coalesce.String(it.upgradeHelp.use, "upgrade [item]..."),
 		Short:             coalesce.String(it.upgradeHelp.short, fmt.Sprintf("Upgrade given %s", it.oneOrMore)),
@@ -348,7 +348,7 @@ func (it itemCLI) NewUpgradeCmd() *cobra.Command {
 	return cmd
 }
 
-func (it itemCLI) Inspect(cmd *cobra.Command, args []string) error {
+func (it cliItem) Inspect(cmd *cobra.Command, args []string) error {
 	flags := cmd.Flags()
 
 	url, err := flags.GetString("url")
@@ -389,7 +389,7 @@ func (it itemCLI) Inspect(cmd *cobra.Command, args []string) error {
 	return nil
 }
 
-func (it itemCLI) NewInspectCmd() *cobra.Command {
+func (it cliItem) NewInspectCmd() *cobra.Command {
 	cmd := &cobra.Command{
 		Use:               coalesce.String(it.inspectHelp.use, "inspect [item]..."),
 		Short:             coalesce.String(it.inspectHelp.short, fmt.Sprintf("Inspect given %s", it.oneOrMore)),
@@ -410,7 +410,7 @@ func (it itemCLI) NewInspectCmd() *cobra.Command {
 	return cmd
 }
 
-func (it itemCLI) List(cmd *cobra.Command, args []string) error {
+func (it cliItem) List(cmd *cobra.Command, args []string) error {
 	flags := cmd.Flags()
 
 	all, err := flags.GetBool("all")
@@ -437,7 +437,7 @@ func (it itemCLI) List(cmd *cobra.Command, args []string) error {
 	return nil
 }
 
-func (it itemCLI) NewListCmd() *cobra.Command {
+func (it cliItem) NewListCmd() *cobra.Command {
 	cmd := &cobra.Command{
 		Use:               coalesce.String(it.listHelp.use, "list [item... | -a]"),
 		Short:             coalesce.String(it.listHelp.short, fmt.Sprintf("List %s", it.oneOrMore)),

diff --git a/cmd/crowdsec-cli/main.go b/cmd/crowdsec-cli/main.go
@@ -243,13 +243,13 @@ It is meant to allow you to manage bans, parsers/scenarios/etc, api and generall
 	rootCmd.AddCommand(NewCLINotifications().NewCommand())
 	rootCmd.AddCommand(NewCLISupport().NewCommand())
 	rootCmd.AddCommand(NewCLIPapi().NewCommand())
-	rootCmd.AddCommand(NewCollectionCLI().NewCommand())
-	rootCmd.AddCommand(NewParserCLI().NewCommand())
-	rootCmd.AddCommand(NewScenarioCLI().NewCommand())
-	rootCmd.AddCommand(NewPostOverflowCLI().NewCommand())
-	rootCmd.AddCommand(NewContextCLI().NewCommand())
-	rootCmd.AddCommand(NewAppsecConfigCLI().NewCommand())
-	rootCmd.AddCommand(NewAppsecRuleCLI().NewCommand())
+	rootCmd.AddCommand(NewCLICollection().NewCommand())
+	rootCmd.AddCommand(NewCLIParser().NewCommand())
+	rootCmd.AddCommand(NewCLIScenario().NewCommand())
+	rootCmd.AddCommand(NewCLIPostOverflow().NewCommand())
+	rootCmd.AddCommand(NewCLIContext().NewCommand())
+	rootCmd.AddCommand(NewCLIAppsecConfig().NewCommand())
+	rootCmd.AddCommand(NewCLIAppsecRule().NewCommand())
 
 	if fflag.CscliSetup.IsEnabled() {
 		rootCmd.AddCommand(NewSetupCmd())