Refactor plugin config constants

Author: vcheung-stripe

pkg/cmd/plugin/config.go

@@ -7,6 +7,7 @@ import (
 	"github.com/spf13/cobra"
 
 	"github.com/stripe/stripe-cli/pkg/config"
+	"github.com/stripe/stripe-cli/pkg/plugins"
 )
 
 // ConfigCmd handles `stripe plugin config` for reading and writing plugin settings.
@@ -55,30 +56,30 @@ func (cc *ConfigCmd) run(cmd *cobra.Command, args []string) error {
 		return cc.setUpdates(args[0], args[1], args[2])
 	case cc.unset != "" && len(args) == 0:
 		// stripe plugin config --unset updates  (global)
-		return cc.cfg.DeleteConfigField(fmt.Sprintf("plugin_configs.__global.%s", cc.unset))
+		return cc.cfg.DeleteConfigField(plugins.PluginConfigKey(plugins.PluginConfigGlobalScope, cc.unset))
 	case cc.unset != "" && len(args) == 1:
 		// stripe plugin config <plugin> --unset updates
 		pluginName := args[0]
 		if !slices.Contains(cc.cfg.GetInstalledPlugins(), pluginName) {
 			return fmt.Errorf("plugin %q is not installed", pluginName)
 		}
-		return cc.cfg.DeleteConfigField(fmt.Sprintf("plugin_configs.%s.%s", pluginName, cc.unset))
+		return cc.cfg.DeleteConfigField(plugins.PluginConfigKey(pluginName, cc.unset))
 	default:
 		return cmd.Help()
 	}
 }
 
 func (cc *ConfigCmd) setUpdates(scope, field, value string) error {
-	if field != "updates" {
+	if field != plugins.PluginConfigUpdatesField {
 		return fmt.Errorf("unknown config field %q", field)
 	}
 	if value != "on" && value != "off" {
 		return fmt.Errorf("invalid value %q for updates — must be \"on\" or \"off\"", value)
 	}
-	if scope != "__global" {
+	if scope != plugins.PluginConfigGlobalScope {
 		if !slices.Contains(cc.cfg.GetInstalledPlugins(), scope) {
 			return fmt.Errorf("plugin %q is not installed", scope)
 		}
 	}
-	return cc.cfg.WriteConfigField(fmt.Sprintf("plugin_configs.%s.%s", scope, field), value)
+	return cc.cfg.WriteConfigField(plugins.PluginConfigKey(scope, field), value)
 }

pkg/cmd/plugin/config_test.go

@@ -10,6 +10,7 @@ import (
 	"github.com/stretchr/testify/require"
 
 	"github.com/stripe/stripe-cli/pkg/config"
+	"github.com/stripe/stripe-cli/pkg/plugins"
 )
 
 func setupPluginConfigTest(t *testing.T) (*config.Config, func()) {
@@ -46,7 +47,7 @@ func TestGlobalSet_UpdatesOn(t *testing.T) {
 
 	err := cc.run(cc.Cmd, []string{"updates", "on"})
 	require.NoError(t, err)
-	assert.Equal(t, "on", viper.GetString("plugin_configs.__global.updates"))
+	assert.Equal(t, "on", viper.GetString(plugins.PluginConfigKey(plugins.PluginConfigGlobalScope, plugins.PluginConfigUpdatesField)))
 }
 
 func TestGlobalSet_UpdatesOff(t *testing.T) {
@@ -58,7 +59,7 @@ func TestGlobalSet_UpdatesOff(t *testing.T) {
 
 	err := cc.run(cc.Cmd, []string{"updates", "off"})
 	require.NoError(t, err)
-	assert.Equal(t, "off", viper.GetString("plugin_configs.__global.updates"))
+	assert.Equal(t, "off", viper.GetString(plugins.PluginConfigKey(plugins.PluginConfigGlobalScope, plugins.PluginConfigUpdatesField)))
 }
 
 func TestGlobalSet_InvalidValue(t *testing.T) {
@@ -91,14 +92,14 @@ func TestGlobalUnset_Updates(t *testing.T) {
 	cfg, cleanup := setupPluginConfigTest(t)
 	defer cleanup()
 
-	require.NoError(t, cfg.WriteConfigField("plugin_configs.__global.updates", "off"))
+	require.NoError(t, cfg.WriteConfigField(plugins.PluginConfigKey(plugins.PluginConfigGlobalScope, plugins.PluginConfigUpdatesField), "off"))
 
 	cc := newTestConfigCmd(cfg)
-	cc.unset = "updates"
+	cc.unset = plugins.PluginConfigUpdatesField
 
 	err := cc.run(cc.Cmd, []string{})
 	require.NoError(t, err)
-	assert.False(t, viper.IsSet("plugin_configs.__global.updates"))
+	assert.False(t, viper.IsSet(plugins.PluginConfigKey(plugins.PluginConfigGlobalScope, plugins.PluginConfigUpdatesField)))
 }
 
 // -- per-plugin --set -------------------------------------------------------
@@ -114,7 +115,7 @@ func TestPluginSet_UpdatesOff(t *testing.T) {
 
 	err := cc.run(cc.Cmd, []string{"apps", "updates", "off"})
 	require.NoError(t, err)
-	assert.Equal(t, "off", viper.GetString("plugin_configs.apps.updates"))
+	assert.Equal(t, "off", viper.GetString(plugins.PluginConfigKey("apps", plugins.PluginConfigUpdatesField)))
 }
 
 func TestPluginSet_NotInstalled(t *testing.T) {
@@ -150,14 +151,14 @@ func TestPluginUnset_Updates(t *testing.T) {
 	defer cleanup()
 
 	require.NoError(t, cfg.WriteConfigField("installed_plugins", []string{"apps"}))
-	require.NoError(t, cfg.WriteConfigField("plugin_configs.apps.updates", "off"))
+	require.NoError(t, cfg.WriteConfigField(plugins.PluginConfigKey("apps", plugins.PluginConfigUpdatesField), "off"))
 
 	cc := newTestConfigCmd(cfg)
-	cc.unset = "updates"
+	cc.unset = plugins.PluginConfigUpdatesField
 
 	err := cc.run(cc.Cmd, []string{"apps"})
 	require.NoError(t, err)
-	assert.False(t, viper.IsSet("plugin_configs.apps.updates"))
+	assert.False(t, viper.IsSet(plugins.PluginConfigKey("apps", plugins.PluginConfigUpdatesField)))
 }
 
 func TestPluginUnset_NotInstalled(t *testing.T) {

pkg/plugins/plugin_configs.go

@@ -0,0 +1,18 @@
+package plugins
+
+const (
+	// PluginConfigGlobalScope is used as the scope when a setting applies to all plugins.
+	PluginConfigGlobalScope = "__global"
+
+	// PluginConfigUpdatesField is the config field name controlling automatic updates.
+	PluginConfigUpdatesField = "updates"
+)
+
+// PluginConfigKey returns the key for a plugin config field.
+// Use PluginConfigGlobalScope as scope to target all plugins.
+// Use the plugin name as scope to target a specific plugin.
+// Example: PluginConfigKey("__global", "updates") to read or set the global updates setting
+// Example: PluginConfigKey("apps", "updates") to read or set the updates setting for the "apps" plugin
+func PluginConfigKey(scope, field string) string {
+	return "plugin_configs." + scope + "." + field
+}