recommit: ordered plugin settings (#7919) (#7926)

model/manifest.go

@@ -31,6 +31,9 @@ type PluginOption struct {
 }
 
 type PluginSetting struct {
+	// The key that the setting will be assigned to in the configuration file.
+	Key string `json:"key" yaml:"key"`
+
 	// The display name for the setting.
 	DisplayName string `json:"display_name" yaml:"display_name"`
 
@@ -76,8 +79,8 @@ type PluginSettingsSchema struct {
 	// Optional text to display below the settings.
 	Footer string `json:"footer" yaml:"footer"`
 
-	// A mapping of setting keys to schema definitions.
+	// A list of setting definitions.
-	Settings map[string]*PluginSetting `json:"settings" yaml:"settings"`
+	Settings []*PluginSetting `json:"settings" yaml:"settings"`
 }
 
 // The plugin manifest defines the metadata required to load and present your plugin. The manifest
@@ -93,11 +96,11 @@ type PluginSettingsSchema struct {
 //         executable: myplugin
 //     settings_schema:
 //         settings:
-//             enable_extra_thing:
+//             - key: enable_extra_thing
-//                 type: bool
+//               type: bool
-//                 display_name: Enable Extra Thing
+//               display_name: Enable Extra Thing
-//                 help_text: When true, an extra thing will be enabled!
+//               help_text: When true, an extra thing will be enabled!
-//                 default: false
+//               default: false
 type Manifest struct {
 	// The id is a globally unique identifier that represents your plugin. Reverse-DNS notation
 	// using a name you control is a good option. For example, "com.mycompany.myplugin".
@@ -126,6 +129,8 @@ type Manifest struct {
 type ManifestBackend struct {
 	// The path to your executable binary. This should be relative to the root of your bundle and the
 	// location of the manifest file.
+	//
+	// On Windows, this file must have a ".exe" extension.
 	Executable string `json:"executable" yaml:"executable"`
 }
 

model/manifest_test.go

@@ -70,8 +70,9 @@ func TestManifestUnmarshal(t *testing.T) {
 		SettingsSchema: &PluginSettingsSchema{
 			Header: "theheadertext",
 			Footer: "thefootertext",
-			Settings: map[string]*PluginSetting{
+			Settings: []*PluginSetting{
-				"thesetting": &PluginSetting{
+				&PluginSetting{
+					Key:                "thesetting",
 					DisplayName:        "thedisplayname",
 					Type:               PLUGIN_CONFIG_TYPE_DROPDOWN,
 					HelpText:           "thehelptext",
@@ -100,16 +101,16 @@ settings_schema:
     header: theheadertext
     footer: thefootertext
     settings:
-        thesetting:
+        - key: thesetting
-            display_name: thedisplayname
+          display_name: thedisplayname
-            type: dropdown
+          type: dropdown
-            help_text: thehelptext
+          help_text: thehelptext
-            regenerate_help_text: theregeneratehelptext
+          regenerate_help_text: theregeneratehelptext
-            placeholder: theplaceholder
+          placeholder: theplaceholder
-            options:
+          options:
-                - display_name: theoptiondisplayname
+              - display_name: theoptiondisplayname
-                  value: thevalue
+                value: thevalue
-            default: thedefault
+          default: thedefault
 `), &yamlResult))
 	assert.Equal(t, expected, yamlResult)
 
@@ -125,22 +126,23 @@ settings_schema:
     "settings_schema": {
         "header": "theheadertext",
         "footer": "thefootertext",
-        "settings": {
+        "settings": [
-            "thesetting": {
+			{
-                "display_name": "thedisplayname",
+				"key": "thesetting",
-                "type": "dropdown",
+				"display_name": "thedisplayname",
-                "help_text": "thehelptext",
+				"type": "dropdown",
-                "regenerate_help_text": "theregeneratehelptext",
+				"help_text": "thehelptext",
-                "placeholder": "theplaceholder",
+				"regenerate_help_text": "theregeneratehelptext",
-                "options": [
+				"placeholder": "theplaceholder",
-                    {
+				"options": [
-                        "display_name": "theoptiondisplayname",
+					{
-                        "value": "thevalue"
+						"display_name": "theoptiondisplayname",
-                    }
+						"value": "thevalue"
-                ],
+					}
-                "default": "thedefault"
+				],
-            }
+				"default": "thedefault"
-        }
+			}
+		]
     }
 	}`), &jsonResult))
 	assert.Equal(t, expected, jsonResult)
@@ -175,8 +177,9 @@ func TestManifestJson(t *testing.T) {
 		SettingsSchema: &PluginSettingsSchema{
 			Header: "theheadertext",
 			Footer: "thefootertext",
-			Settings: map[string]*PluginSetting{
+			Settings: []*PluginSetting{
-				"thesetting": &PluginSetting{
+				&PluginSetting{
+					Key:                "thesetting",
 					DisplayName:        "thedisplayname",
 					Type:               PLUGIN_CONFIG_TYPE_DROPDOWN,
 					HelpText:           "thehelptext",
@@ -239,8 +242,9 @@ func TestManifestClientManifest(t *testing.T) {
 		SettingsSchema: &PluginSettingsSchema{
 			Header: "theheadertext",
 			Footer: "thefootertext",
-			Settings: map[string]*PluginSetting{
+			Settings: []*PluginSetting{
-				"thesetting": &PluginSetting{
+				&PluginSetting{
+					Key:                "thesetting",
 					DisplayName:        "thedisplayname",
 					Type:               PLUGIN_CONFIG_TYPE_DROPDOWN,
 					HelpText:           "thehelptext",