feat: support the .yaml ext for flow files (#260)

jahvon · web-flow · commit 95ba4c2c8cac · 2025-07-08T13:30:14.000-04:00
diff --git a/desktop/src-tauri/src/types/generated/flowfile.rs b/desktop/src-tauri/src/types/generated/flowfile.rs
@@ -2182,15 +2182,15 @@ impl ::std::default::Default for ExecutableVerb {
         ExecutableVerb::Exec
     }
 }
-#[doc = "Configuration for a group of Flow CLI executables. The file must have the extension `.flow` in order to be discovered \nby the CLI. It's configuration is used to define a group of executables with shared metadata (namespace, tags, etc).\nA workspace can have multiple flow files located anywhere in the workspace directory\n"]
+#[doc = "Configuration for a group of Flow CLI executables. The file must have the extension `.flow`, `.flow.yaml`, or `.flow.yml` \nin order to be discovered by the CLI. It's configuration is used to define a group of executables with shared metadata \n(namespace, tags, etc). A workspace can have multiple flow files located anywhere in the workspace directory\n"]
 #[doc = r""]
 #[doc = r" <details><summary>JSON schema</summary>"]
 #[doc = r""]
 #[doc = r" ```json"]
 #[doc = "{"]
 #[doc = "  \"$id\": \"https://flowexec.io/schemas/flowfile_schema.json\","]
 #[doc = "  \"title\": \"FlowFile\","]
-#[doc = "  \"description\": \"Configuration for a group of Flow CLI executables. The file must have the extension `.flow` in order to be discovered \\nby the CLI. It's configuration is used to define a group of executables with shared metadata (namespace, tags, etc).\\nA workspace can have multiple flow files located anywhere in the workspace directory\\n\","]
+#[doc = "  \"description\": \"Configuration for a group of Flow CLI executables. The file must have the extension `.flow`, `.flow.yaml`, or `.flow.yml` \\nin order to be discovered by the CLI. It's configuration is used to define a group of executables with shared metadata \\n(namespace, tags, etc). A workspace can have multiple flow files located anywhere in the workspace directory\\n\","]
 #[doc = "  \"type\": \"object\","]
 #[doc = "  \"properties\": {"]
 #[doc = "    \"description\": {"]
diff --git a/desktop/src/types/generated/flowfile.ts b/desktop/src/types/generated/flowfile.ts
@@ -44,9 +44,9 @@ export type CommonVisibility = 'public' | 'private' | 'internal' | 'hidden';
 export type FromFile = string[];
 
 /**
- * Configuration for a group of Flow CLI executables. The file must have the extension `.flow` in order to be discovered
- * by the CLI. It's configuration is used to define a group of executables with shared metadata (namespace, tags, etc).
- * A workspace can have multiple flow files located anywhere in the workspace directory
+ * Configuration for a group of Flow CLI executables. The file must have the extension `.flow`, `.flow.yaml`, or `.flow.yml`
+ * in order to be discovered by the CLI. It's configuration is used to define a group of executables with shared metadata
+ * (namespace, tags, etc). A workspace can have multiple flow files located anywhere in the workspace directory
  *
  */
 export interface FlowFile {
diff --git a/docs/guide/executable.md b/docs/guide/executable.md
@@ -71,7 +71,7 @@ flow build my-project/
 ## Flowfile
 
 The flowfile is the primary configuration file that defines what an executable should do. The file is written in YAML but
-should have a `.flow` extension.
+should have a `.flow`, `.flow.yaml`, or `.flow.yml` extension.
 
 The [flow sync](../cli/flow_sync.md) command is used to trigger a discovery of executables within workspaces. This 
 command should be run whenever an executable is created, moved, or deleted from a flowfile.
diff --git a/docs/quickstart.md b/docs/quickstart.md
@@ -22,7 +22,7 @@ workspace's configurations. For more information on workspaces see the [workspac
 
 **Create an executable**
 
-Executables are the core of flow. Each executable is driven by its definition within a flow file (`*.flow`).
+Executables are the core of flow. Each executable is driven by its definition within a flow file (`*.flow`, `*.flow.yaml`, or `*.flow.yml`).
 There are several types of executables that can be defined. For more information on executables and the flow file, see the [executable guide](guide/executable.md).
 
 To get started, create a new flow file in the workspace directory.
diff --git a/docs/schemas/flowfile_schema.json b/docs/schemas/flowfile_schema.json
@@ -2,7 +2,7 @@
   "$schema": "http://json-schema.org/draft-07/schema#",
   "$id": "https://flowexec.io/schemas/flowfile_schema.json",
   "title": "FlowFile",
-  "description": "Configuration for a group of Flow CLI executables. The file must have the extension `.flow` in order to be discovered \nby the CLI. It's configuration is used to define a group of executables with shared metadata (namespace, tags, etc).\nA workspace can have multiple flow files located anywhere in the workspace directory\n",
+  "description": "Configuration for a group of Flow CLI executables. The file must have the extension `.flow`, `.flow.yaml`, or `.flow.yml` \nin order to be discovered by the CLI. It's configuration is used to define a group of executables with shared metadata \n(namespace, tags, etc). A workspace can have multiple flow files located anywhere in the workspace directory\n",
   "type": "object",
   "definitions": {
     "CommonAliases": {
diff --git a/docs/types/README.md b/docs/types/README.md
@@ -16,4 +16,4 @@ You can add the following comment to the top of your flow files to enable this:
 
 See the [schemas directory on GitHub](https://github.com/jahvon/flow/tree/main/docs/schemas) for all available schemas.
 
-Note: If using the flow file schema, you will need to make sure your IDE is configured to treat `*.flow` files as YAML files.
+Note: If using the flow file schema, you will need to make sure your IDE is configured to treat `*.flow`, `*.flow.yaml`, and `*.flow.yml` files as YAML files.
diff --git a/docs/types/flowfile.md b/docs/types/flowfile.md
@@ -2,9 +2,9 @@
 
 # FlowFile
 
-Configuration for a group of Flow CLI executables. The file must have the extension `.flow` in order to be discovered 
-by the CLI. It's configuration is used to define a group of executables with shared metadata (namespace, tags, etc).
-A workspace can have multiple flow files located anywhere in the workspace directory
+Configuration for a group of Flow CLI executables. The file must have the extension `.flow`, `.flow.yaml`, or `.flow.yml` 
+in order to be discovered by the CLI. It's configuration is used to define a group of executables with shared metadata 
+(namespace, tags, etc). A workspace can have multiple flow files located anywhere in the workspace directory
 
 
 ## Properties
diff --git a/internal/filesystem/executables.go b/internal/filesystem/executables.go
@@ -116,7 +116,7 @@ func findFlowFiles(logger io.Logger, workspaceCfg *workspace.Workspace) ([]strin
 				return filepath.SkipDir
 			}
 
-			if filepath.Ext(entry.Name()) == executable.FlowFileExt {
+			if executable.HasFlowFileExt(entry.Name()) {
 				cfgPaths = append(cfgPaths, path)
 			}
 		}
diff --git a/internal/templates/templates.go b/internal/templates/templates.go
@@ -36,7 +36,7 @@ func ProcessTemplate(
 		flowfileName = fmt.Sprintf("executables_%s", time.Now().Format("20060102150405"))
 	}
 	flowfileName = strings.ReplaceAll(strings.ToLower(flowfileName), " ", "_")
-	if !strings.HasSuffix(flowfileName, executable.FlowFileExt) {
+	if !executable.HasFlowFileExt(flowfileName) {
 		flowfileName += executable.FlowFileExt
 	}
 
diff --git a/types/executable/executables_test.go b/types/executable/executables_test.go
@@ -309,3 +309,22 @@ var _ = Describe("ExecutableList", func() {
 		})
 	})
 })
+
+var _ = DescribeTable("HasFlowFileExt", func(file string, expected bool) {
+	Expect(executable.HasFlowFileExt(file)).To(Equal(expected))
+},
+	Entry("ends with .flow", "development.flow", true),
+	Entry("ends with .flow.yaml", "development.flow.yaml", true),
+	Entry("ends with .flow.yml", "development.flow.yml", true),
+	Entry("ends with something else", "development.txt", false),
+)
+
+var _ = DescribeTable("HasFlowFileTemplateExt", func(file string, expected bool) {
+	Expect(executable.HasFlowFileTemplateExt(file)).To(Equal(expected))
+},
+	Entry("ends with .flow.tmpl", "development.flow.tmpl", true),
+	Entry("ends with .flow.tmpl.yaml", "development.flow.tmpl.yaml", true),
+	Entry("ends with .flow.tmpl.yml", "development.flow.tmpl.yml", true),
+	Entry("ends with .flow", "development.flow", false),
+	Entry("ends with something else", "development.flow.txt", false),
+)
diff --git a/types/executable/flowfile.gen.go b/types/executable/flowfile.gen.go
diff --git a/types/executable/flowfile.go b/types/executable/flowfile.go
@@ -2,6 +2,7 @@ package executable
 
 import (
 	"fmt"
+	"regexp"
 
 	"gopkg.in/yaml.v3"
 
@@ -12,6 +13,8 @@ import (
 
 const FlowFileExt = ".flow"
 
+var FlowFileExtRegex = regexp.MustCompile(fmt.Sprintf(`%s(\.yaml|\.yml)?`, regexp.QuoteMeta(FlowFileExt)))
+
 type FlowFileList []*FlowFile
 
 func (f *FlowFile) SetContext(workspaceName, workspacePath, configPath string) {
@@ -72,3 +75,7 @@ func (l *FlowFileList) FilterByTag(tag string) FlowFileList {
 	}
 	return filteredCfgs
 }
+
+func HasFlowFileExt(file string) bool {
+	return FlowFileExtRegex.MatchString(file)
+}
diff --git a/types/executable/flowfile_schema.yaml b/types/executable/flowfile_schema.yaml
@@ -3,9 +3,9 @@ $id: "https://raw.githubusercontent.com/jahvon/flow/HEAD/types/executable/flowfi
 
 title: FlowFile
 description: |
-  Configuration for a group of Flow CLI executables. The file must have the extension `.flow` in order to be discovered 
-  by the CLI. It's configuration is used to define a group of executables with shared metadata (namespace, tags, etc).
-  A workspace can have multiple flow files located anywhere in the workspace directory
+  Configuration for a group of Flow CLI executables. The file must have the extension `.flow`, `.flow.yaml`, or `.flow.yml` 
+  in order to be discovered by the CLI. It's configuration is used to define a group of executables with shared metadata 
+  (namespace, tags, etc). A workspace can have multiple flow files located anywhere in the workspace directory
 
 definitions:
   FromFile:
diff --git a/types/executable/template.go b/types/executable/template.go
@@ -5,6 +5,7 @@ import (
 	"errors"
 	"fmt"
 	"path/filepath"
+	"regexp"
 	"strings"
 
 	"github.com/flowexec/tuikit/types"
@@ -15,6 +16,9 @@ import (
 
 const FlowFileTemplateExt = ".flow.tmpl"
 
+//nolint:lll
+var FlowFileTemplateExtRegex = regexp.MustCompile(fmt.Sprintf(`%s(\.yaml|\.yml)?`, regexp.QuoteMeta(FlowFileTemplateExt)))
+
 type TemplateList []*Template
 
 func (f *Field) Set(value string) {
@@ -75,10 +79,10 @@ func (t *Template) SetContext(name, location string) {
 	if name == "" {
 		fn := filepath.Base(location)
 		switch {
-		case strings.HasSuffix(fn, FlowFileTemplateExt):
-			fn = strings.TrimSuffix(fn, FlowFileTemplateExt)
-		case strings.HasSuffix(fn, FlowFileExt):
-			fn = strings.TrimSuffix(fn, FlowFileExt)
+		case HasFlowFileTemplateExt(fn):
+			fn, _, _ = strings.Cut(fn, FlowFileTemplateExt)
+		case HasFlowFileExt(fn):
+			fn, _, _ = strings.Cut(fn, FlowFileExt)
 		default:
 			fn = strings.TrimSuffix(fn, filepath.Ext(fn))
 		}
@@ -164,3 +168,7 @@ func (t TemplateList) Find(name string) *Template {
 	}
 	return nil
 }
+
+func HasFlowFileTemplateExt(file string) bool {
+	return FlowFileTemplateExtRegex.MatchString(file)
+}

Original file line number	Diff line number	Diff line change
`@@ -16,4 +16,4 @@ You can add the following comment to the top of your flow files to enable this:`
`16`	`16`
`17`	`17`	`See the [schemas directory on GitHub](https://github.com/jahvon/flow/tree/main/docs/schemas) for all available schemas.`
`18`	`18`
`19`		-Note: If using the flow file schema, you will need to make sure your IDE is configured to treat `*.flow` files as YAML files.
	`19`	+Note: If using the flow file schema, you will need to make sure your IDE is configured to treat `.flow`, `.flow.yaml`, and `*.flow.yml` files as YAML files.
Original file line number	Diff line number	Diff line change
`@@ -116,7 +116,7 @@ func findFlowFiles(logger io.Logger, workspaceCfg *workspace.Workspace) ([]strin`
`116`	`116`	`return filepath.SkipDir`
`117`	`117`	`}`
`118`	`118`
`119`		`- if filepath.Ext(entry.Name()) == executable.FlowFileExt {`
	`119`	`+ if executable.HasFlowFileExt(entry.Name()) {`
`120`	`120`	`cfgPaths = append(cfgPaths, path)`
`121`	`121`	`}`
`122`	`122`	`}`
Original file line number	Diff line number	Diff line change
`@@ -36,7 +36,7 @@ func ProcessTemplate(`
`36`	`36`	`flowfileName = fmt.Sprintf("executables_%s", time.Now().Format("20060102150405"))`
`37`	`37`	`}`
`38`	`38`	`flowfileName = strings.ReplaceAll(strings.ToLower(flowfileName), " ", "_")`
`39`		`- if !strings.HasSuffix(flowfileName, executable.FlowFileExt) {`
	`39`	`+ if !executable.HasFlowFileExt(flowfileName) {`
`40`	`40`	`flowfileName += executable.FlowFileExt`
`41`	`41`	`}`
`42`	`42`