refactor(base): rename Experimental to Configure (#1438)

phm07 · web-flow · commit 3551b7ef8839 · 2026-06-24T18:10:24.000+02:00
For some commands we might want to do more than just mark them as
experimental, e.g. change their generated description. This PR renames
`Experimental` to `Configure` to make it clear that the function can be
used to configure all aspects of the command, not only to mark it as
experimental.
diff --git a/internal/cmd/base/change_protection.go b/internal/cmd/base/change_protection.go
@@ -53,8 +53,8 @@ type ChangeProtectionCmds[T, Opts any] struct {
 	// IDOrName is used to retrieve a string representation of the resource
 	IDOrName func(resource T) string
 
-	// Experimental is a function that will be used to mark the command as experimental.
-	Experimental func(state.State, *cobra.Command) *cobra.Command
+	// Configure is a function that can be used to configure the command directly.
+	Configure func(state.State, *cobra.Command) *cobra.Command
 }
 
 func (cpc *ChangeProtectionCmds[T, Opts]) newChangeProtectionCmd(s state.State, enable bool) *cobra.Command {
@@ -133,8 +133,8 @@ func (cpc *ChangeProtectionCmds[T, Opts]) newChangeProtectionCmd(s state.State,
 		cpc.AdditionalFlags(cmd)
 	}
 
-	if cpc.Experimental != nil {
-		cmd = cpc.Experimental(s, cmd)
+	if cpc.Configure != nil {
+		cmd = cpc.Configure(s, cmd)
 	}
 
 	return cmd
diff --git a/internal/cmd/base/create.go b/internal/cmd/base/create.go
@@ -19,8 +19,8 @@ type CreateCmd[T any] struct {
 	// It should return the created resource, the schema of the resource and an error.
 	Run           func(state.State, *cobra.Command, []string) (T, any, error)
 	PrintResource func(state.State, *cobra.Command, T)
-	// Experimental is a function that will be used to mark the command as experimental.
-	Experimental func(state.State, *cobra.Command) *cobra.Command
+	// Configure is a function that can be used to configure the command directly.
+	Configure func(state.State, *cobra.Command) *cobra.Command
 }
 
 // CobraCommand creates a command that can be registered with cobra.
@@ -78,8 +78,8 @@ func (cc *CreateCmd[T]) CobraCommand(s state.State) *cobra.Command {
 		return nil
 	}
 
-	if cc.Experimental != nil {
-		cmd = cc.Experimental(s, cmd)
+	if cc.Configure != nil {
+		cmd = cc.Configure(s, cmd)
 	}
 	return cmd
 }
diff --git a/internal/cmd/base/delete.go b/internal/cmd/base/delete.go
@@ -44,8 +44,8 @@ type DeleteCmd[T any] struct {
 	// [DeleteCmd.FetchWithArgs] and [DeleteCmd.PositionalArgumentOverride] is being used.
 	ValidArgsFunction func(client hcapi2.Client) []cobra.CompletionFunc
 
-	// Experimental is a function that will be used to mark the command as experimental.
-	Experimental func(state.State, *cobra.Command) *cobra.Command
+	// Configure is a function that can be used to configure the command directly.
+	Configure func(state.State, *cobra.Command) *cobra.Command
 }
 
 type FetchFunc[T any] func(s state.State, cmd *cobra.Command, idOrName string) (T, *hcloud.Response, error)
@@ -84,8 +84,8 @@ func (dc *DeleteCmd[T]) CobraCommand(s state.State) *cobra.Command {
 	if dc.AdditionalFlags != nil {
 		dc.AdditionalFlags(cmd)
 	}
-	if dc.Experimental != nil {
-		cmd = dc.Experimental(s, cmd)
+	if dc.Configure != nil {
+		cmd = dc.Configure(s, cmd)
 	}
 	return cmd
 }
diff --git a/internal/cmd/base/describe.go b/internal/cmd/base/describe.go
@@ -47,8 +47,8 @@ type DescribeCmd[T any] struct {
 	// [DescribeCmd.FetchWithArgs] and [DescribeCmd.PositionalArgumentOverride] is being used.
 	ValidArgsFunction func(client hcapi2.Client) []cobra.CompletionFunc
 
-	// Experimental is a function that will be used to mark the command as experimental.
-	Experimental func(state.State, *cobra.Command) *cobra.Command
+	// Configure is a function that can be used to configure the command directly.
+	Configure func(state.State, *cobra.Command) *cobra.Command
 }
 
 // CobraCommand creates a command that can be registered with cobra.
@@ -84,8 +84,8 @@ func (dc *DescribeCmd[T]) CobraCommand(s state.State) *cobra.Command {
 		dc.AdditionalFlags(cmd)
 	}
 
-	if dc.Experimental != nil {
-		cmd = dc.Experimental(s, cmd)
+	if dc.Configure != nil {
+		cmd = dc.Configure(s, cmd)
 	}
 
 	return cmd
diff --git a/internal/cmd/base/labels.go b/internal/cmd/base/labels.go
@@ -46,8 +46,8 @@ type LabelCmds[T any] struct {
 	// provided as part of the [LabelCmds.ValidArgsFunction].
 	ValidArgsFunction func(client hcapi2.Client) []cobra.CompletionFunc
 
-	// Experimental is a function that will be used to mark the command as experimental.
-	Experimental func(state.State, *cobra.Command) *cobra.Command
+	// Configure is a function that can be used to configure the command directly.
+	Configure func(state.State, *cobra.Command) *cobra.Command
 }
 
 // AddCobraCommand creates a command that can be registered with cobra.
@@ -79,8 +79,8 @@ func (lc *LabelCmds[T]) AddCobraCommand(s state.State) *cobra.Command {
 
 	cmd.Flags().BoolP("overwrite", "o", false, "Overwrite label if it exists already (true, false)")
 
-	if lc.Experimental != nil {
-		cmd = lc.Experimental(s, cmd)
+	if lc.Configure != nil {
+		cmd = lc.Configure(s, cmd)
 	}
 
 	return cmd
@@ -177,8 +177,8 @@ func (lc *LabelCmds[T]) RemoveCobraCommand(s state.State) *cobra.Command {
 
 	cmd.Flags().BoolP("all", "a", false, "Remove all labels")
 
-	if lc.Experimental != nil {
-		cmd = lc.Experimental(s, cmd)
+	if lc.Configure != nil {
+		cmd = lc.Configure(s, cmd)
 	}
 
 	return cmd
diff --git a/internal/cmd/base/list.go b/internal/cmd/base/list.go
@@ -56,8 +56,8 @@ type ListCmd[T any, S any] struct {
 	// Can be set if auto-completion is needed (usually if [ListCmd.FetchWithArgs] is used)
 	ValidArgsFunction func(client hcapi2.Client) cobra.CompletionFunc
 
-	// Experimental is a function that will be used to mark the command as experimental.
-	Experimental func(state.State, *cobra.Command) *cobra.Command
+	// Configure is a function that can be used to configure the command directly.
+	Configure func(state.State, *cobra.Command) *cobra.Command
 }
 
 // CobraCommand creates a command that can be registered with cobra.
@@ -92,8 +92,8 @@ func (lc *ListCmd[T, S]) CobraCommand(s state.State) *cobra.Command {
 		lc.AdditionalFlags(cmd)
 	}
 	cmd.Flags().StringSliceP("sort", "s", []string{}, "Determine the sorting of the result")
-	if lc.Experimental != nil {
-		cmd = lc.Experimental(s, cmd)
+	if lc.Configure != nil {
+		cmd = lc.Configure(s, cmd)
 	}
 	return cmd
 }
diff --git a/internal/cmd/base/set_rdns.go b/internal/cmd/base/set_rdns.go
@@ -22,8 +22,8 @@ type SetRdnsCmd[T hcloud.RDNSSupporter] struct {
 	Fetch                func(s state.State, cmd *cobra.Command, idOrName string) (T, *hcloud.Response, error)
 	GetDefaultIP         func(resource T) net.IP
 
-	// Experimental is a function that will be used to mark the command as experimental.
-	Experimental func(state.State, *cobra.Command) *cobra.Command
+	// Configure is a function that can be used to configure the command directly.
+	Configure func(state.State, *cobra.Command) *cobra.Command
 }
 
 // CobraCommand creates a command that can be registered with cobra.
@@ -45,8 +45,8 @@ func (rc *SetRdnsCmd[T]) CobraCommand(s state.State) *cobra.Command {
 
 	cmd.Flags().IPP("ip", "i", net.IP{}, "IP address for which the reverse DNS entry should be set")
 
-	if rc.Experimental != nil {
-		cmd = rc.Experimental(s, cmd)
+	if rc.Configure != nil {
+		cmd = rc.Configure(s, cmd)
 	}
 	return cmd
 }
diff --git a/internal/cmd/base/update.go b/internal/cmd/base/update.go
@@ -41,8 +41,8 @@ type UpdateCmd[T any] struct {
 	// [UpdateCmd.FetchWithArgs] and [UpdateCmd.PositionalArgumentOverride] is being used.
 	ValidArgsFunction func(client hcapi2.Client) []cobra.CompletionFunc
 
-	// Experimental is a function that will be used to mark the command as experimental.
-	Experimental func(state.State, *cobra.Command) *cobra.Command
+	// Configure is a function that can be used to configure the command directly.
+	Configure func(state.State, *cobra.Command) *cobra.Command
 }
 
 // CobraCommand creates a command that can be registered with cobra.
@@ -72,8 +72,8 @@ func (uc *UpdateCmd[T]) CobraCommand(s state.State) *cobra.Command {
 		},
 	}
 	uc.DefineFlags(cmd)
-	if uc.Experimental != nil {
-		cmd = uc.Experimental(s, cmd)
+	if uc.Configure != nil {
+		cmd = uc.Configure(s, cmd)
 	}
 	return cmd
 }

Original file line number	Diff line number	Diff line change
`@@ -53,8 +53,8 @@ type ChangeProtectionCmds[T, Opts any] struct {`
`53`	`53`	`// IDOrName is used to retrieve a string representation of the resource`
`54`	`54`	`IDOrName func(resource T) string`
`55`	`55`
`56`		`- // Experimental is a function that will be used to mark the command as experimental.`
`57`		`- Experimental func(state.State, cobra.Command) cobra.Command`
	`56`	`+ // Configure is a function that can be used to configure the command directly.`
	`57`	`+ Configure func(state.State, cobra.Command) cobra.Command`
`58`	`58`	`}`
`59`	`59`
`60`	`60`	`func (cpc ChangeProtectionCmds[T, Opts]) newChangeProtectionCmd(s state.State, enable bool) cobra.Command {`
`@@ -133,8 +133,8 @@ func (cpc *ChangeProtectionCmds[T, Opts]) newChangeProtectionCmd(s state.State,`
`133`	`133`	`cpc.AdditionalFlags(cmd)`
`134`	`134`	`}`
`135`	`135`
`136`		`- if cpc.Experimental != nil {`
`137`		`- cmd = cpc.Experimental(s, cmd)`
	`136`	`+ if cpc.Configure != nil {`
	`137`	`+ cmd = cpc.Configure(s, cmd)`
`138`	`138`	`}`
`139`	`139`
`140`	`140`	`return cmd`
Original file line number	Diff line number	Diff line change
`@@ -19,8 +19,8 @@ type CreateCmd[T any] struct {`
`19`	`19`	`// It should return the created resource, the schema of the resource and an error.`
`20`	`20`	`Run func(state.State, *cobra.Command, []string) (T, any, error)`
`21`	`21`	`PrintResource func(state.State, *cobra.Command, T)`
`22`		`- // Experimental is a function that will be used to mark the command as experimental.`
`23`		`- Experimental func(state.State, cobra.Command) cobra.Command`
	`22`	`+ // Configure is a function that can be used to configure the command directly.`
	`23`	`+ Configure func(state.State, cobra.Command) cobra.Command`
`24`	`24`	`}`
`25`	`25`
`26`	`26`	`// CobraCommand creates a command that can be registered with cobra.`
`@@ -78,8 +78,8 @@ func (cc CreateCmd[T]) CobraCommand(s state.State) cobra.Command {`
`78`	`78`	`return nil`
`79`	`79`	`}`
`80`	`80`
`81`		`- if cc.Experimental != nil {`
`82`		`- cmd = cc.Experimental(s, cmd)`
	`81`	`+ if cc.Configure != nil {`
	`82`	`+ cmd = cc.Configure(s, cmd)`
`83`	`83`	`}`
`84`	`84`	`return cmd`
`85`	`85`	`}`
Original file line number	Diff line number	Diff line change
`@@ -44,8 +44,8 @@ type DeleteCmd[T any] struct {`
`44`	`44`	`// [DeleteCmd.FetchWithArgs] and [DeleteCmd.PositionalArgumentOverride] is being used.`
`45`	`45`	`ValidArgsFunction func(client hcapi2.Client) []cobra.CompletionFunc`
`46`	`46`
`47`		`- // Experimental is a function that will be used to mark the command as experimental.`
`48`		`- Experimental func(state.State, cobra.Command) cobra.Command`
	`47`	`+ // Configure is a function that can be used to configure the command directly.`
	`48`	`+ Configure func(state.State, cobra.Command) cobra.Command`
`49`	`49`	`}`
`50`	`50`
`51`	`51`	`type FetchFunc[T any] func(s state.State, cmd cobra.Command, idOrName string) (T, hcloud.Response, error)`
`@@ -84,8 +84,8 @@ func (dc DeleteCmd[T]) CobraCommand(s state.State) cobra.Command {`
`84`	`84`	`if dc.AdditionalFlags != nil {`
`85`	`85`	`dc.AdditionalFlags(cmd)`
`86`	`86`	`}`
`87`		`- if dc.Experimental != nil {`
`88`		`- cmd = dc.Experimental(s, cmd)`
	`87`	`+ if dc.Configure != nil {`
	`88`	`+ cmd = dc.Configure(s, cmd)`
`89`	`89`	`}`
`90`	`90`	`return cmd`
`91`	`91`	`}`
Original file line number	Diff line number	Diff line change
`@@ -47,8 +47,8 @@ type DescribeCmd[T any] struct {`
`47`	`47`	`// [DescribeCmd.FetchWithArgs] and [DescribeCmd.PositionalArgumentOverride] is being used.`
`48`	`48`	`ValidArgsFunction func(client hcapi2.Client) []cobra.CompletionFunc`
`49`	`49`
`50`		`- // Experimental is a function that will be used to mark the command as experimental.`
`51`		`- Experimental func(state.State, cobra.Command) cobra.Command`
	`50`	`+ // Configure is a function that can be used to configure the command directly.`
	`51`	`+ Configure func(state.State, cobra.Command) cobra.Command`
`52`	`52`	`}`
`53`	`53`
`54`	`54`	`// CobraCommand creates a command that can be registered with cobra.`
`@@ -84,8 +84,8 @@ func (dc DescribeCmd[T]) CobraCommand(s state.State) cobra.Command {`
`84`	`84`	`dc.AdditionalFlags(cmd)`
`85`	`85`	`}`
`86`	`86`
`87`		`- if dc.Experimental != nil {`
`88`		`- cmd = dc.Experimental(s, cmd)`
	`87`	`+ if dc.Configure != nil {`
	`88`	`+ cmd = dc.Configure(s, cmd)`
`89`	`89`	`}`
`90`	`90`
`91`	`91`	`return cmd`
Original file line number	Diff line number	Diff line change
`@@ -56,8 +56,8 @@ type ListCmd[T any, S any] struct {`
`56`	`56`	`// Can be set if auto-completion is needed (usually if [ListCmd.FetchWithArgs] is used)`
`57`	`57`	`ValidArgsFunction func(client hcapi2.Client) cobra.CompletionFunc`
`58`	`58`
`59`		`- // Experimental is a function that will be used to mark the command as experimental.`
`60`		`- Experimental func(state.State, cobra.Command) cobra.Command`
	`59`	`+ // Configure is a function that can be used to configure the command directly.`
	`60`	`+ Configure func(state.State, cobra.Command) cobra.Command`
`61`	`61`	`}`
`62`	`62`
`63`	`63`	`// CobraCommand creates a command that can be registered with cobra.`
`@@ -92,8 +92,8 @@ func (lc ListCmd[T, S]) CobraCommand(s state.State) cobra.Command {`
`92`	`92`	`lc.AdditionalFlags(cmd)`
`93`	`93`	`}`
`94`	`94`	`cmd.Flags().StringSliceP("sort", "s", []string{}, "Determine the sorting of the result")`
`95`		`- if lc.Experimental != nil {`
`96`		`- cmd = lc.Experimental(s, cmd)`
	`95`	`+ if lc.Configure != nil {`
	`96`	`+ cmd = lc.Configure(s, cmd)`
`97`	`97`	`}`
`98`	`98`	`return cmd`
`99`	`99`	`}`
Original file line number	Diff line number	Diff line change
`@@ -22,8 +22,8 @@ type SetRdnsCmd[T hcloud.RDNSSupporter] struct {`
`22`	`22`	`Fetch func(s state.State, cmd cobra.Command, idOrName string) (T, hcloud.Response, error)`
`23`	`23`	`GetDefaultIP func(resource T) net.IP`
`24`	`24`
`25`		`- // Experimental is a function that will be used to mark the command as experimental.`
`26`		`- Experimental func(state.State, cobra.Command) cobra.Command`
	`25`	`+ // Configure is a function that can be used to configure the command directly.`
	`26`	`+ Configure func(state.State, cobra.Command) cobra.Command`
`27`	`27`	`}`
`28`	`28`
`29`	`29`	`// CobraCommand creates a command that can be registered with cobra.`
`@@ -45,8 +45,8 @@ func (rc SetRdnsCmd[T]) CobraCommand(s state.State) cobra.Command {`
`45`	`45`
`46`	`46`	`cmd.Flags().IPP("ip", "i", net.IP{}, "IP address for which the reverse DNS entry should be set")`
`47`	`47`
`48`		`- if rc.Experimental != nil {`
`49`		`- cmd = rc.Experimental(s, cmd)`
	`48`	`+ if rc.Configure != nil {`
	`49`	`+ cmd = rc.Configure(s, cmd)`
`50`	`50`	`}`
`51`	`51`	`return cmd`
`52`	`52`	`}`
Original file line number	Diff line number	Diff line change
`@@ -41,8 +41,8 @@ type UpdateCmd[T any] struct {`
`41`	`41`	`// [UpdateCmd.FetchWithArgs] and [UpdateCmd.PositionalArgumentOverride] is being used.`
`42`	`42`	`ValidArgsFunction func(client hcapi2.Client) []cobra.CompletionFunc`
`43`	`43`
`44`		`- // Experimental is a function that will be used to mark the command as experimental.`
`45`		`- Experimental func(state.State, cobra.Command) cobra.Command`
	`44`	`+ // Configure is a function that can be used to configure the command directly.`
	`45`	`+ Configure func(state.State, cobra.Command) cobra.Command`
`46`	`46`	`}`
`47`	`47`
`48`	`48`	`// CobraCommand creates a command that can be registered with cobra.`
`@@ -72,8 +72,8 @@ func (uc UpdateCmd[T]) CobraCommand(s state.State) cobra.Command {`
`72`	`72`	`},`
`73`	`73`	`}`
`74`	`74`	`uc.DefineFlags(cmd)`
`75`		`- if uc.Experimental != nil {`
`76`		`- cmd = uc.Experimental(s, cmd)`
	`75`	`+ if uc.Configure != nil {`
	`76`	`+ cmd = uc.Configure(s, cmd)`
`77`	`77`	`}`
`78`	`78`	`return cmd`
`79`	`79`	`}`