update logic and tests

Author: jahvon

desktop/src-tauri/src/types/generated/workspace.rs

@@ -122,6 +122,64 @@ impl ExecutableFilter {
         Default::default()
     }
 }
+#[doc = "A map of executable verbs to valid aliases. This allows you to use custom aliases for exec commands in the workspace.\nSetting this will override all of the default flow command aliases. The verbs and its mapped aliases must be valid flow verbs.\n\nIf set to an empty object, verb aliases will be disabled.\n"]
+#[doc = r""]
+#[doc = r" <details><summary>JSON schema</summary>"]
+#[doc = r""]
+#[doc = r" ```json"]
+#[doc = "{"]
+#[doc = "  \"description\": \"A map of executable verbs to valid aliases. This allows you to use custom aliases for exec commands in the workspace.\\nSetting this will override all of the default flow command aliases. The verbs and its mapped aliases must be valid flow verbs.\\n\\nIf set to an empty object, verb aliases will be disabled.\\n\","]
+#[doc = "  \"type\": \"object\","]
+#[doc = "  \"additionalProperties\": {"]
+#[doc = "    \"type\": \"array\","]
+#[doc = "    \"items\": {"]
+#[doc = "      \"type\": \"string\""]
+#[doc = "    }"]
+#[doc = "  }"]
+#[doc = "}"]
+#[doc = r" ```"]
+#[doc = r" </details>"]
+#[derive(:: serde :: Deserialize, :: serde :: Serialize, Clone, Debug)]
+#[serde(transparent)]
+pub struct VerbAliases(
+    pub ::std::collections::HashMap<::std::string::String, ::std::vec::Vec<::std::string::String>>,
+);
+impl ::std::ops::Deref for VerbAliases {
+    type Target =
+        ::std::collections::HashMap<::std::string::String, ::std::vec::Vec<::std::string::String>>;
+    fn deref(
+        &self,
+    ) -> &::std::collections::HashMap<::std::string::String, ::std::vec::Vec<::std::string::String>>
+    {
+        &self.0
+    }
+}
+impl ::std::convert::From<VerbAliases>
+    for ::std::collections::HashMap<::std::string::String, ::std::vec::Vec<::std::string::String>>
+{
+    fn from(value: VerbAliases) -> Self {
+        value.0
+    }
+}
+impl ::std::convert::From<&VerbAliases> for VerbAliases {
+    fn from(value: &VerbAliases) -> Self {
+        value.clone()
+    }
+}
+impl
+    ::std::convert::From<
+        ::std::collections::HashMap<::std::string::String, ::std::vec::Vec<::std::string::String>>,
+    > for VerbAliases
+{
+    fn from(
+        value: ::std::collections::HashMap<
+            ::std::string::String,
+            ::std::vec::Vec<::std::string::String>,
+        >,
+    ) -> Self {
+        Self(value)
+    }
+}
 #[doc = "Configuration for a workspace in the Flow CLI.\nThis configuration is used to define the settings for a workspace.\nEvery workspace has a workspace config file named `flow.yaml` in the root of the workspace directory.\n"]
 #[doc = r""]
 #[doc = r" <details><summary>JSON schema</summary>"]
@@ -156,14 +214,7 @@ impl ExecutableFilter {
 #[doc = "      \"$ref\": \"#/definitions/CommonTags\""]
 #[doc = "    },"]
 #[doc = "    \"verbAliases\": {"]
-#[doc = "      \"description\": \"A map of executable verbs to valid aliases. This allows you to use custom aliases for exec commands in the workspace.\\nSetting this will override all of the default flow command aliases. The verbs and it's mapped aliases must be valid flow verbs.\\n\\nIf set to an empty object, verb aliases will be disabled.\\n\","]
-#[doc = "      \"type\": \"object\","]
-#[doc = "      \"additionalProperties\": {"]
-#[doc = "        \"type\": \"array\","]
-#[doc = "        \"items\": {"]
-#[doc = "          \"type\": \"string\""]
-#[doc = "        }"]
-#[doc = "      }"]
+#[doc = "      \"$ref\": \"#/definitions/VerbAliases\""]
 #[doc = "    }"]
 #[doc = "  }"]
 #[doc = "}"]
@@ -184,14 +235,12 @@ pub struct Workspace {
     pub executables: ::std::option::Option<ExecutableFilter>,
     #[serde(default = "defaults::workspace_tags")]
     pub tags: CommonTags,
-    #[doc = "A map of executable verbs to valid aliases. This allows you to use custom aliases for exec commands in the workspace.\nSetting this will override all of the default flow command aliases. The verbs and it's mapped aliases must be valid flow verbs.\n\nIf set to an empty object, verb aliases will be disabled.\n"]
     #[serde(
         rename = "verbAliases",
         default,
-        skip_serializing_if = ":: std :: collections :: HashMap::is_empty"
+        skip_serializing_if = "::std::option::Option::is_none"
     )]
-    pub verb_aliases:
-        ::std::collections::HashMap<::std::string::String, ::std::vec::Vec<::std::string::String>>,
+    pub verb_aliases: ::std::option::Option<VerbAliases>,
 }
 impl ::std::convert::From<&Workspace> for Workspace {
     fn from(value: &Workspace) -> Self {
@@ -283,13 +332,8 @@ pub mod builder {
             ::std::string::String,
         >,
         tags: ::std::result::Result<super::CommonTags, ::std::string::String>,
-        verb_aliases: ::std::result::Result<
-            ::std::collections::HashMap<
-                ::std::string::String,
-                ::std::vec::Vec<::std::string::String>,
-            >,
-            ::std::string::String,
-        >,
+        verb_aliases:
+            ::std::result::Result<::std::option::Option<super::VerbAliases>, ::std::string::String>,
     }
     impl ::std::default::Default for Workspace {
         fn default() -> Self {
@@ -359,12 +403,7 @@ pub mod builder {
         }
         pub fn verb_aliases<T>(mut self, value: T) -> Self
         where
-            T: ::std::convert::TryInto<
-                ::std::collections::HashMap<
-                    ::std::string::String,
-                    ::std::vec::Vec<::std::string::String>,
-                >,
-            >,
+            T: ::std::convert::TryInto<::std::option::Option<super::VerbAliases>>,
             T::Error: ::std::fmt::Display,
         {
             self.verb_aliases = value

desktop/src/types/generated/workspace.ts

@@ -31,16 +31,7 @@ export interface Workspace {
   displayName?: string;
   executables?: ExecutableFilter;
   tags?: CommonTags;
-  /**
-   * A map of executable verbs to valid aliases. This allows you to use custom aliases for exec commands in the workspace.
-   * Setting this will override all of the default flow command aliases. The verbs and it's mapped aliases must be valid flow verbs.
-   *
-   * If set to an empty object, verb aliases will be disabled.
-   *
-   */
-  verbAliases?: {
-    [k: string]: string[];
-  };
+  verbAliases?: VerbAliases;
   [k: string]: unknown;
 }
 export interface ExecutableFilter {
@@ -54,3 +45,13 @@ export interface ExecutableFilter {
   included?: string[];
   [k: string]: unknown;
 }
+/**
+ * A map of executable verbs to valid aliases. This allows you to use custom aliases for exec commands in the workspace.
+ * Setting this will override all of the default flow command aliases. The verbs and its mapped aliases must be valid flow verbs.
+ *
+ * If set to an empty object, verb aliases will be disabled.
+ *
+ */
+export interface VerbAliases {
+  [k: string]: string[];
+}

docs/schemas/workspace_schema.json

@@ -32,6 +32,16 @@
           }
         }
       }
+    },
+    "VerbAliases": {
+      "description": "A map of executable verbs to valid aliases. This allows you to use custom aliases for exec commands in the workspace.\nSetting this will override all of the default flow command aliases. The verbs and its mapped aliases must be valid flow verbs.\n\nIf set to an empty object, verb aliases will be disabled.\n",
+      "type": "object",
+      "additionalProperties": {
+        "type": "array",
+        "items": {
+          "type": "string"
+        }
+      }
     }
   },
   "properties": {
@@ -58,14 +68,7 @@
       "default": []
     },
     "verbAliases": {
-      "description": "A map of executable verbs to valid aliases. This allows you to use custom aliases for exec commands in the workspace.\nSetting this will override all of the default flow command aliases. The verbs and it's mapped aliases must be valid flow verbs.\n\nIf set to an empty object, verb aliases will be disabled.\n",
-      "type": "object",
-      "additionalProperties": {
-        "type": "array",
-        "items": {
-          "type": "string"
-        }
-      }
+      "$ref": "#/definitions/VerbAliases"
     }
   }
 }

docs/types/workspace.md

@@ -19,7 +19,7 @@ Every workspace has a workspace config file named `flow.yaml` in the root of the
 | `displayName` | The display name of the workspace. This is used in the interactive UI. | `string` |  |  |
 | `executables` |  | [ExecutableFilter](#ExecutableFilter) | <no value> |  |
 | `tags` |  | [CommonTags](#CommonTags) | [] |  |
-| `verbAliases` | A map of executable verbs to valid aliases. This allows you to use custom aliases for exec commands in the workspace. Setting this will override all of the default flow command aliases. The verbs and it's mapped aliases must be valid flow verbs.  If set to an empty object, verb aliases will be disabled.  | `map` (`string` -> `array` (`string`)) | <no value> |  |
+| `verbAliases` |  | [VerbAliases](#VerbAliases) | <no value> |  |
 
 
 ## Definitions
@@ -50,4 +50,17 @@ Tags can be used with list commands to filter returned data.
 | `excluded` | A list of directories to exclude from the executable search. | `array` (`string`) | [] |  |
 | `included` | A list of directories to include in the executable search. | `array` (`string`) | [] |  |
 
+### VerbAliases
+
+A map of executable verbs to valid aliases. This allows you to use custom aliases for exec commands in the workspace.
+Setting this will override all of the default flow command aliases. The verbs and its mapped aliases must be valid flow verbs.
+
+If set to an empty object, verb aliases will be disabled.
+
+
+**Type:** `map` (`string` -> `array` (`string`))
+
+
+
+
 

internal/cache/executables_cache.go

@@ -130,17 +130,23 @@ func (c *ExecutableCacheImpl) GetExecutableByRef(logger io.Logger, ref executabl
 		return exec, nil
 	}
 
+	var primaryRef executable.Ref
 	cfgPath, found := c.Data.ExecutableMap[ref]
+	//nolint:nestif
 	if !found {
-		if primaryRef, aliasFound := c.Data.AliasMap[ref]; aliasFound {
+		if aliasedPrimaryRef, aliasFound := c.Data.AliasMap[ref]; aliasFound {
+			primaryRef = aliasedPrimaryRef
 			cfgPath, found = c.Data.ExecutableMap[primaryRef]
 			if !found {
 				return nil, NewExecutableNotFoundError(ref.String())
 			}
 		} else {
 			return nil, NewExecutableNotFoundError(ref.String())
 		}
+	} else {
+		primaryRef = ref
 	}
+
 	cfg, err := filesystem.LoadFlowFile(cfgPath)
 	if err != nil {
 		return nil, errors.Wrap(err, "unable to load executable config")
@@ -165,7 +171,7 @@ func (c *ExecutableCacheImpl) GetExecutableByRef(logger io.Logger, ref executabl
 	cfg.Executables = append(cfg.Executables, generated...)
 
 	execs := cfg.Executables
-	exec, err := execs.FindByVerbAndID(ref.Verb(), ref.ID())
+	exec, err := execs.FindByVerbAndID(primaryRef.Verb(), primaryRef.ID())
 	if err != nil {
 		return nil, err
 	} else if exec == nil {
@@ -234,19 +240,26 @@ func (c *ExecutableCacheImpl) initExecutableCacheData(logger io.Logger) error {
 
 func enumerateExecutableAliasRefs(
 	exec *executable.Executable,
-	override workspace.WorkspaceVerbAliases,
+	override *workspace.WorkspaceVerbAliases,
 ) executable.RefList {
 	refs := make(executable.RefList, 0)
 
-	if override == nil {
+	switch {
+	case override == nil:
+		// use default aliases
 		for _, verb := range executable.RelatedVerbs(exec.Verb) {
 			refs = append(refs, executable.NewRef(exec.ID(), verb))
 			for _, id := range exec.AliasesIDs() {
 				refs = append(refs, executable.NewRef(id, verb))
 			}
 		}
-	} else {
-		if verbs, found := override[exec.Verb.String()]; found {
+	case len(*override) == 0:
+		// disable all aliases if override is set but empty
+		return refs
+	default:
+		// use overrides if provided
+		o := *override
+		if verbs, found := o[exec.Verb.String()]; found {
 			for _, v := range verbs {
 				vv := executable.Verb(v)
 				if err := vv.Validate(); err != nil {