wip

Author: jahvon

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

@@ -155,9 +155,15 @@ impl ExecutableFilter {
 #[doc = "      \"default\": [],"]
 #[doc = "      \"$ref\": \"#/definitions/CommonTags\""]
 #[doc = "    },"]
-#[doc = "    \"verbAliasEnabled\": {"]
-#[doc = "      \"description\": \"If true, the executables in the workspace can be referred to by their verb aliases.\\nThis allows you to use commands like `flow run` instead of `flow exec`.\\n\","]
-#[doc = "      \"type\": \"boolean\""]
+#[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 = "    }"]
 #[doc = "  }"]
 #[doc = "}"]
@@ -178,13 +184,14 @@ pub struct Workspace {
     pub executables: ::std::option::Option<ExecutableFilter>,
     #[serde(default = "defaults::workspace_tags")]
     pub tags: CommonTags,
-    #[doc = "If true, the executables in the workspace can be referred to by their verb aliases.\nThis allows you to use commands like `flow run` instead of `flow exec`.\n"]
+    #[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 = "verbAliasEnabled",
+        rename = "verbAliases",
         default,
-        skip_serializing_if = "::std::option::Option::is_none"
+        skip_serializing_if = ":: std :: collections :: HashMap::is_empty"
     )]
-    pub verb_alias_enabled: ::std::option::Option<bool>,
+    pub verb_aliases:
+        ::std::collections::HashMap<::std::string::String, ::std::vec::Vec<::std::string::String>>,
 }
 impl ::std::convert::From<&Workspace> for Workspace {
     fn from(value: &Workspace) -> Self {
@@ -199,7 +206,7 @@ impl ::std::default::Default for Workspace {
             display_name: Default::default(),
             executables: Default::default(),
             tags: defaults::workspace_tags(),
-            verb_alias_enabled: Default::default(),
+            verb_aliases: Default::default(),
         }
     }
 }
@@ -276,8 +283,13 @@ pub mod builder {
             ::std::string::String,
         >,
         tags: ::std::result::Result<super::CommonTags, ::std::string::String>,
-        verb_alias_enabled:
-            ::std::result::Result<::std::option::Option<bool>, ::std::string::String>,
+        verb_aliases: ::std::result::Result<
+            ::std::collections::HashMap<
+                ::std::string::String,
+                ::std::vec::Vec<::std::string::String>,
+            >,
+            ::std::string::String,
+        >,
     }
     impl ::std::default::Default for Workspace {
         fn default() -> Self {
@@ -287,7 +299,7 @@ pub mod builder {
                 display_name: Ok(Default::default()),
                 executables: Ok(Default::default()),
                 tags: Ok(super::defaults::workspace_tags()),
-                verb_alias_enabled: Ok(Default::default()),
+                verb_aliases: Ok(Default::default()),
             }
         }
     }
@@ -345,17 +357,19 @@ pub mod builder {
                 .map_err(|e| format!("error converting supplied value for tags: {}", e));
             self
         }
-        pub fn verb_alias_enabled<T>(mut self, value: T) -> Self
+        pub fn verb_aliases<T>(mut self, value: T) -> Self
         where
-            T: ::std::convert::TryInto<::std::option::Option<bool>>,
+            T: ::std::convert::TryInto<
+                ::std::collections::HashMap<
+                    ::std::string::String,
+                    ::std::vec::Vec<::std::string::String>,
+                >,
+            >,
             T::Error: ::std::fmt::Display,
         {
-            self.verb_alias_enabled = value.try_into().map_err(|e| {
-                format!(
-                    "error converting supplied value for verb_alias_enabled: {}",
-                    e
-                )
-            });
+            self.verb_aliases = value
+                .try_into()
+                .map_err(|e| format!("error converting supplied value for verb_aliases: {}", e));
             self
         }
     }
@@ -370,7 +384,7 @@ pub mod builder {
                 display_name: value.display_name?,
                 executables: value.executables?,
                 tags: value.tags?,
-                verb_alias_enabled: value.verb_alias_enabled?,
+                verb_aliases: value.verb_aliases?,
             })
         }
     }
@@ -382,7 +396,7 @@ pub mod builder {
                 display_name: Ok(value.display_name),
                 executables: Ok(value.executables),
                 tags: Ok(value.tags),
-                verb_alias_enabled: Ok(value.verb_alias_enabled),
+                verb_aliases: Ok(value.verb_aliases),
             }
         }
     }

desktop/src/types/generated/workspace.ts

@@ -32,11 +32,15 @@ export interface Workspace {
   executables?: ExecutableFilter;
   tags?: CommonTags;
   /**
-   * If true, the executables in the workspace can be referred to by their verb aliases.
-   * This allows you to use commands like `flow run` instead of `flow exec`.
+   * 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.
    *
    */
-  verbAliasEnabled?: boolean;
+  verbAliases?: {
+    [k: string]: string[];
+  };
   [k: string]: unknown;
 }
 export interface ExecutableFilter {

docs/schemas/workspace_schema.json

@@ -57,9 +57,15 @@
       "$ref": "#/definitions/CommonTags",
       "default": []
     },
-    "verbAliasEnabled": {
-      "description": "If true, the executables in the workspace can be referred to by their verb aliases.\nThis allows you to use commands like `flow run` instead of `flow exec`.\n",
-      "type": "boolean"
+    "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"
+        }
+      }
     }
   }
 }

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) | [] |  |
-| `verbAliasEnabled` | If true, the executables in the workspace can be referred to by their verb aliases. This allows you to use commands like `flow run` instead of `flow exec`.  | `boolean` | <no value> |  |
+| `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> |  |
 
 
 ## Definitions

flow.yaml

@@ -4,7 +4,7 @@ description: |
    Source code for flow
    GitHub Repo: github.com/flowexec/flow
 descriptionFile: docs/development.md
-verbAliasEnabled: true
+verbAliases: {}
 executables:
   excluded:
     - node_modules

internal/cache/executables_cache.go

@@ -10,6 +10,7 @@ import (
 	"github.com/flowexec/flow/internal/filesystem"
 	"github.com/flowexec/flow/types/common"
 	"github.com/flowexec/flow/types/executable"
+	"github.com/flowexec/flow/types/workspace"
 )
 
 const execCacheKey = "executables"
@@ -90,11 +91,8 @@ func (c *ExecutableCacheImpl) Update(logger io.Logger) error { //nolint:gocognit
 					continue
 				}
 				cacheData.ExecutableMap[e.Ref()] = flowFile.ConfigPath()
-				if wsCfg.VerbAliasEnabled == nil || *wsCfg.VerbAliasEnabled {
-					// TODO: allow specifying custom alias mappings
-					for _, ref := range enumerateExecutableAliasRefs(e) {
-						cacheData.AliasMap[ref] = e.Ref()
-					}
+				for _, ref := range enumerateExecutableAliasRefs(e, wsCfg.VerbAliases) {
+					cacheData.AliasMap[ref] = e.Ref()
 				}
 				cacheData.ConfigMap[flowFile.ConfigPath()] = WorkspaceInfo{
 					WorkspaceName: wsCfg.AssignedName(),
@@ -234,13 +232,32 @@ func (c *ExecutableCacheImpl) initExecutableCacheData(logger io.Logger) error {
 	return nil
 }
 
-func enumerateExecutableAliasRefs(exec *executable.Executable) executable.RefList {
+func enumerateExecutableAliasRefs(
+	exec *executable.Executable,
+	override workspace.WorkspaceVerbAliases,
+) executable.RefList {
 	refs := make(executable.RefList, 0)
 
-	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))
+	if override == nil {
+		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 {
+			for _, v := range verbs {
+				vv := executable.Verb(v)
+				if err := vv.Validate(); err != nil {
+					// If the verb is not valid, skip it
+					continue
+				}
+				refs = append(refs, executable.NewRef(exec.ID(), vv))
+				for _, id := range exec.AliasesIDs() {
+					refs = append(refs, executable.NewRef(id, vv))
+				}
+			}
 		}
 	}
 

internal/runner/gomock_reflect_3858569983/prog.go

@@ -46,11 +46,17 @@ properties:
     type: string
     description: A path to a markdown file that contains the description of the workspace.
     default: ""
-  verbAliasEnabled:
-    type: boolean
+  verbAliases:
+    type: object
     description: |
-      If true, the executables in the workspace can be referred to by their verb aliases.
-      This allows you to use commands like `flow run` instead of `flow exec`.
+      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.
+    additionalProperties:
+      type: array
+      items:
+          type: string
   assignedName:
     type: string
     goJSONSchema: