(fix) update doc links, broken import, and flowfile schema (#134)

Author: jahvon

README.md

@@ -59,13 +59,21 @@ flow init workspace <name> <path>
 ```
 
 This command will register the Workspace and create the root config file for you.
-For more information on Workspaces and it's config, see [Workspaces](docs/config/workspace_config.md).
+For more information on Workspaces and it's config, see [Workspaces](docs/types/workspace.md).
 
 #### Defining Executables
 
-Executables are the core of flow. Each executable is driven by its definition within an executable definition file 
-(`*.flow` file). There are several types of executables that can be defined.
-For more information on Executables and it's config, see [Executables](docs/config/executables.md).
+Executables are the core of flow. Each executable is driven by its definition within a flow file (`*.flow`).
+There are several types of executables that can be defined. For more information on Executables and the flow file, see [FlowFile.md](docs/types/flowfile.md).
+
+There is also a JSON Schema that can be used in IDEs with the Language Server Protocol (LSP) to perform intelligent 
+suggestions. You can add the following comment to the top of your flow files to enable this:
+
+```yaml
+# yaml-language-server: $schema=https://raw.githubusercontent.com/jahvon/flow/HEAD/schemas/flowfile_schema.json
+```
+
+See the [schemas](schemas/) directory all available schemas.
 
 #### Running and managing workflows
 

cmd/internal/exec.go

@@ -32,9 +32,12 @@ func RegisterExecCmd(ctx *context.Context, rootCmd *cobra.Command) {
 		Use:     "exec EXECUTABLE_ID [args...]",
 		Aliases: executable.SortedValidVerbs(),
 		Short:   "Execute a flow by ID.",
-		Long: execDocumentation + "\n\n" + execExamples + "\n\n" +
-			"See " + io.ConfigDocsURL("executables", "Verb") + "for more information on executable verbs." +
-			"See " + io.ConfigDocsURL("executables", "Ref") + "for more information on executable IDs.",
+		Long: execDocumentation + fmt.Sprintf(
+			"\n\n%s\n\nSee %s for more information on executable verbs."+
+				"See %s for more information on executable IDs.",
+			execExamples, io.TypesDocsURL("flowfile", "ExecutableVerb"),
+			io.TypesDocsURL("flowfile", "ExecutableRef"),
+		),
 		Args: cobra.MinimumNArgs(1),
 		ValidArgsFunction: func(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective) {
 			execList, err := ctx.ExecutableCache.GetExecutableList(ctx.Logger)

cmd/internal/get.go

@@ -1,6 +1,8 @@
 package internal
 
 import (
+	"fmt"
+
 	"github.com/jahvon/tuikit/components"
 	"github.com/pkg/errors"
 	"github.com/spf13/cobra"
@@ -109,8 +111,12 @@ func registerGetExecCmd(ctx *context.Context, getCmd *cobra.Command) {
 		Short:   "Print an executable flow by reference.",
 		Long: "Print an executable by the executable's verb and ID.\nThe target executable's ID should be in the  " +
 			"form of 'ws/ns:name' and the verb should match the target executable's verb or one of its aliases.\n\n" +
-			"See" + io.ConfigDocsURL("executables", "Verb") + "for more information on executable verbs." +
-			"See" + io.ConfigDocsURL("executable", "Ref") + "for more information on executable IDs.",
+			fmt.Sprintf(
+				"See %s for more information on executable verbs.\n"+
+					"See %s for more information on executable IDs.",
+				io.TypesDocsURL("flowfile", "ExecutableVerb"),
+				io.TypesDocsURL("flowfile", "ExecutableRef"),
+			),
 		Args:    cobra.ExactArgs(2),
 		PreRun:  func(cmd *cobra.Command, args []string) { interactive.InitInteractiveContainer(ctx, cmd) },
 		PostRun: func(cmd *cobra.Command, args []string) { interactive.WaitForExit(ctx, cmd) },

development.flow

@@ -1,3 +1,4 @@
+# yaml-language-server: $schema=https://raw.githubusercontent.com/jahvon/flow/HEAD/schemas/flowfile_schema.json
 visibility: private
 tags: [development]
 executables:

docs/cli/flow_exec.md

@@ -27,7 +27,7 @@ flow exec ws/ns:build
 flow exec ws/ns:build flag1=value1 flag2=value2 value3 value4
 
 
-See https://github.com/jahvon/flow/blob/main/docs/config/executables.md#Verbfor more information on executable verbs.See https://github.com/jahvon/flow/blob/main/docs/config/executables.md#Reffor more information on executable IDs.
+See https://github.com/jahvon/flow/blob/main/docs/types/flowfile.md#ExecutableVerb for more information on executable verbs.See https://github.com/jahvon/flow/blob/main/docs/types/flowfile.md#ExecutableRef for more information on executable IDs.
 
 ```
 flow exec EXECUTABLE_ID [args...] [flags]

docs/cli/flow_get_executable.md

@@ -7,7 +7,8 @@ Print an executable flow by reference.
 Print an executable by the executable's verb and ID.
 The target executable's ID should be in the  form of 'ws/ns:name' and the verb should match the target executable's verb or one of its aliases.
 
-Seehttps://github.com/jahvon/flow/blob/main/docs/config/executables.md#Verbfor more information on executable verbs.Seehttps://github.com/jahvon/flow/blob/main/docs/config/executable.md#Reffor more information on executable IDs.
+See https://github.com/jahvon/flow/blob/main/docs/types/flowfile.md#ExecutableVerb for more information on executable verbs.
+See https://github.com/jahvon/flow/blob/main/docs/types/flowfile.md#ExecutableRef for more information on executable IDs.
 
 ```
 flow get executable VERB ID [flags]

docs/docs.flow

@@ -1,3 +1,4 @@
+# yaml-language-server: $schema=https://raw.githubusercontent.com/jahvon/flow/HEAD/schemas/flowfile_schema.json
 visibility: public
 namespace: docs
 tags: [documentation]

docs/types/config.md

@@ -27,9 +27,9 @@ Alternatively, a custom path can be set using the `FLOW_CONFIG_PATH` environment
 | `currentWorkspace` | The name of the current workspace. This should match a key in the `workspaces` or `remoteWorkspaces` map. | `string` |  | [] |
 | `defaultLogMode` | The default log mode to use when running executables. This can either be `hidden`, `json`, `logfmt` or `text`  `hidden` will not display any logs. `json` will display logs in JSON format. `logfmt` will display logs with a log level, timestamp, and message. `text` will just display the log message.  | `string` | logfmt | [] |
 | `interactive` |  | [Interactive](#Interactive) | <no value> | [] |
-| `templates` | A map of flowfile template names to their paths. | map (`string -> string`) | map[] | [] |
+| `templates` | A map of flowfile template names to their paths. | `map` (`string` -> `string`) | map[] | [] |
 | `workspaceMode` | The mode of the workspace. This can be either `fixed` or `dynamic`. In `fixed` mode, the current workspace used at runtime is always the one set in the currentWorkspace config field. In `dynamic` mode, the current workspace used at runtime is determined by the current directory. If the current directory is within a workspace, that workspace is used.  | `string` | dynamic | [] |
-| `workspaces` | Map of workspace names to their paths. The path should be a valid absolute path to the workspace directory.  | map (`string -> string`) | <no value> | [] |
+| `workspaces` | Map of workspace names to their paths. The path should be a valid absolute path to the workspace directory.  | `map` (`string` -> `string`) | <no value> | [] |
 
 
 ## Definitions

docs/types/flowfile.md

@@ -15,10 +15,10 @@ A workspace can have multiple flow files located anywhere in the workspace direc
 | Field | Description | Type | Default | Required |
 | ----- | ----------- | ---- | ------- | -------- |
 | `description` | A description of the executables defined within the flow file. This description will be set as the executables' description if not defined at the executable level.  | `string` |  | [] |
-| `executables` |  | [Executable](#Executable) | [] | [] |
+| `executables` |  | `array` ([Executable](#Executable)) | [] | [] |
 | `fromFile` |  | [FromFile](#FromFile) | [] | [] |
 | `namespace` | The namespace to be given to all executables in the flow file. If not set, the executables in the file will be grouped into the root (*) namespace.  Namespaces can be reused across multiple flow files.  Namespaces are used to reference executables in the CLI using the format `workspace:namespace/name`.  | `string` |  | [] |
-| `tags` | Tags to be applied to all executables defined within the flow file. | array (``string``) | [] | [] |
+| `tags` | Tags to be applied to all executables defined within the flow file. | `array` (`string`) | [] | [] |
 | `visibility` |  | [CommonVisibility](#CommonVisibility) | <no value> | [] |
 
 
@@ -28,7 +28,7 @@ A workspace can have multiple flow files located anywhere in the workspace direc
 
 Alternate names that can be used to reference the executable in the CLI.
 
-**Type:** array (``string``)
+**Type:** `array` (`string`)
 
 
 
@@ -39,7 +39,7 @@ A list of tags.
 Tags can be used with list commands to filter returned data.
 
 
-**Type:** array (``string``)
+**Type:** `array` (`string`)
 
 
 
@@ -116,7 +116,7 @@ Executables are the building blocks of workflows and are used to define the acti
 
 
 
-**Type:** array (`[ExecutableArgument](#ExecutableArgument)`)
+**Type:** `array` ([ExecutableArgument](#ExecutableArgument))
 
 
 
@@ -214,7 +214,7 @@ Only one of `text`, `secretRef`, or `prompt` must be set. Specifying more than o
 
 
 
-**Type:** array (`[ExecutableParameter](#ExecutableParameter)`)
+**Type:** `array` ([ExecutableParameter](#ExecutableParameter))
 
 
 
@@ -239,7 +239,7 @@ If the namespace is not specified, the current namespace will be used.
 
 
 
-**Type:** array (`[ExecutableRef](#ExecutableRef)`)
+**Type:** `array` ([ExecutableRef](#ExecutableRef))
 
 
 
@@ -276,15 +276,15 @@ Makes an HTTP request.
 | ----- | ----------- | ---- | ------- | -------- |
 | `args` |  | [ExecutableArgumentList](#ExecutableArgumentList) | <no value> | [] |
 | `body` | The body of the request. | `string` |  | [] |
-| `headers` | A map of headers to include in the request. | map (`string -> string`) | map[] | [] |
+| `headers` | A map of headers to include in the request. | `map` (`string` -> `string`) | map[] | [] |
 | `logResponse` | If set to true, the response will be logged as program output. | `boolean` | false | [] |
 | `method` | The HTTP method to use when making the request. | `string` | GET | [] |
 | `params` |  | [ExecutableParameterList](#ExecutableParameterList) | <no value> | [] |
 | `responseFile` |  | [ExecutableRequestResponseFile](#ExecutableRequestResponseFile) | <no value> | [] |
 | `timeout` | The timeout for the request in Go duration format (e.g. 30s, 5m, 1h). | `string` | 30m0s | [] |
 | `transformResponse` | JQ query to transform the response before saving it to a file or outputting it. | `string` |  | [] |
 | `url` | The URL to make the request to. | `string` |  | [] |
-| `validStatusCodes` | A list of valid status codes. If the response status code is not in this list, the executable will fail. If not set, the response status code will not be checked.  | array (``integer``) | [] | [] |
+| `validStatusCodes` | A list of valid status codes. If the response status code is not in this list, the executable will fail. If not set, the response status code will not be checked.  | `array` (`integer`) | [] | [] |
 
 ### ExecutableRequestResponseFile
 
@@ -377,7 +377,7 @@ This allows users to use the verb that best describes the action they are perfor
 
 A list of `.sh` files to convert into generated executables in the file's executable group.
 
-**Type:** array (``string``)
+**Type:** `array` (`string`)
 
 
 

docs/types/workspace.md

@@ -28,7 +28,7 @@ A list of tags.
 Tags can be used with list commands to filter returned data.
 
 
-**Type:** array (``string``)
+**Type:** `array` (`string`)
 
 
 
@@ -45,7 +45,7 @@ Tags can be used with list commands to filter returned data.
 
 | Field | Description | Type | Default | Required |
 | ----- | ----------- | ---- | ------- | -------- |
-| `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``) | [] | [] |
+| `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`) | [] | [] |
 
 

examples/dirs.flow

@@ -1,3 +1,4 @@
+# yaml-language-server: $schema=https://raw.githubusercontent.com/jahvon/flow/HEAD/schemas/flowfile_schema.json
 visibility: private
 namespace: examples
 executables:

examples/env.flow

@@ -1,3 +1,4 @@
+# yaml-language-server: $schema=https://raw.githubusercontent.com/jahvon/flow/HEAD/schemas/flowfile_schema.json
 visibility: private
 namespace: examples
 executables:

examples/exec.flow

@@ -1,3 +1,4 @@
+# yaml-language-server: $schema=https://raw.githubusercontent.com/jahvon/flow/HEAD/schemas/flowfile_schema.json
 visibility: private
 namespace: examples
 executables:

examples/generated.flow

@@ -1,3 +1,4 @@
+# yaml-language-server: $schema=https://raw.githubusercontent.com/jahvon/flow/HEAD/schemas/flowfile_schema.json
 visibility: private
 namespace: examples
 fromFile:

examples/launch.flow

@@ -1,3 +1,4 @@
+# yaml-language-server: $schema=https://raw.githubusercontent.com/jahvon/flow/HEAD/schemas/flowfile_schema.json
 visibility: private
 namespace: examples
 executables:

examples/parallel.flow

@@ -1,3 +1,4 @@
+# yaml-language-server: $schema=https://raw.githubusercontent.com/jahvon/flow/HEAD/schemas/flowfile_schema.json
 visibility: private
 namespace: examples
 executables:

examples/render.flow

@@ -1,3 +1,4 @@
+# yaml-language-server: $schema=https://raw.githubusercontent.com/jahvon/flow/HEAD/schemas/flowfile_schema.json
 visibility: private
 namespace: examples
 executables:

examples/request.flow

@@ -1,3 +1,4 @@
+# yaml-language-server: $schema=https://raw.githubusercontent.com/jahvon/flow/HEAD/schemas/flowfile_schema.json
 visibility: private
 namespace: examples
 executables:

examples/serial.flow

@@ -1,3 +1,4 @@
+# yaml-language-server: $schema=https://raw.githubusercontent.com/jahvon/flow/HEAD/schemas/flowfile_schema.json
 visibility: private
 namespace: examples
 executables:

flow.yaml

@@ -1,3 +1,4 @@
+# yaml-language-server: $schema=https://raw.githubusercontent.com/jahvon/flow/HEAD/schemas/workspace_schema.json
 displayName: flow
 git:
     enabled: false

internal/cache/executables_cache.go

@@ -177,7 +177,7 @@ func (c *ExecutableCacheImpl) GetExecutableByRef(logger io.Logger, ref executabl
 	}
 	cfg.Executables = append(cfg.Executables, generated...)
 
-	execs := executable.ExecutableList(cfg.Executables)
+	execs := cfg.Executables
 	exec, err := execs.FindByVerbAndID(ref.GetVerb(), ref.GetID())
 	if err != nil {
 		return nil, err

internal/cache/executables_cache_test.go

@@ -48,7 +48,7 @@ var _ = Describe("ExecutableCacheImpl", func() {
 		execCfg := &executable.FlowFile{
 			Namespace:  "testdata",
 			Visibility: &v,
-			Executables: executable.FlowFileExecutables{
+			Executables: executable.ExecutableList{
 				{Verb: "run", Name: "exec"},
 			},
 		}

internal/filesystem/executables_test.go

@@ -41,7 +41,7 @@ var _ = Describe("Executables", func() {
 		It("writes and reads executable definition correctly", func() {
 			executableDefinition := &executable.FlowFile{
 				Namespace: "test",
-				Executables: executable.FlowFileExecutables{
+				Executables: executable.ExecutableList{
 					{
 						Verb: "exec",
 						Name: "test-executable",
@@ -62,7 +62,7 @@ var _ = Describe("Executables", func() {
 		It("loads all executable definitions if no paths are set", func() {
 			executableDefinition := &executable.FlowFile{
 				Namespace: "test",
-				Executables: executable.FlowFileExecutables{
+				Executables: executable.ExecutableList{
 					{
 						Verb: "exec",
 						Name: "test-executable",
@@ -88,7 +88,7 @@ var _ = Describe("Executables", func() {
 		It("loads executable definitions from the included path", func() {
 			executableDefinition := &executable.FlowFile{
 				Namespace: "test",
-				Executables: executable.FlowFileExecutables{
+				Executables: executable.ExecutableList{
 					{
 						Verb: "exec",
 						Name: "test-executable",
@@ -120,7 +120,7 @@ var _ = Describe("Executables", func() {
 		It("does not load executable definitions from excluded paths", func() {
 			executableDefinition := &executable.FlowFile{
 				Namespace: "test",
-				Executables: executable.FlowFileExecutables{
+				Executables: executable.ExecutableList{
 					{
 						Verb: "exec",
 						Name: "test-executable",

internal/filesystem/templates_test.go

@@ -32,7 +32,7 @@ var _ = Describe("Templates", func() {
 			definitionTemplate := &executable.FlowFileTemplate{
 				FlowFile: &executable.FlowFile{
 					Namespace: "test",
-					Executables: executable.FlowFileExecutables{
+					Executables: executable.ExecutableList{
 						{Verb: "run", Name: "test-executable", Description: "{{ .key }}"},
 					},
 				},
@@ -53,7 +53,7 @@ var _ = Describe("Templates", func() {
 			definitionTemplate := &executable.FlowFileTemplate{
 				FlowFile: &executable.FlowFile{
 					Namespace: "test",
-					Executables: executable.FlowFileExecutables{
+					Executables: executable.ExecutableList{
 						{Verb: "run", Name: "test-executable", Description: "{{ .key }}"},
 					},
 				},
@@ -83,7 +83,7 @@ var _ = Describe("Templates", func() {
 			definitionTemplate := &executable.FlowFileTemplate{
 				FlowFile: &executable.FlowFile{
 					Namespace: "test",
-					Executables: executable.FlowFileExecutables{
+					Executables: executable.ExecutableList{
 						{Verb: "exec", Name: "test-executable", Description: "{{ .key }}"},
 					},
 				},

internal/io/output.go

@@ -4,9 +4,9 @@ import (
 	"fmt"
 )
 
-func ConfigDocsURL(docID, anchor string) string {
+func TypesDocsURL(docID, anchor string) string {
 	if anchor != "" {
 		anchor = "#" + anchor
 	}
-	return fmt.Sprintf("https://github.com/jahvon/flow/blob/main/docs/config/%s.md%s", docID, anchor)
+	return fmt.Sprintf("https://github.com/jahvon/flow/blob/main/docs/types/%s.md%s", docID, anchor)
 }

internal/io/secret/views.go

@@ -5,7 +5,6 @@ import (
 
 	"github.com/jahvon/tuikit/components"
 	"github.com/jahvon/tuikit/styles"
-	"github.com/samber/lo"
 
 	"github.com/jahvon/flow/internal/context"
 	"github.com/jahvon/flow/internal/io"
@@ -90,9 +89,15 @@ func NewSecretListView(
 	}
 
 	selectFunc := func(filterVal string) error {
-		secret, found := lo.Find(secrets, func(s vault.Secret) bool {
-			return s.Reference == filterVal
-		})
+		var secret vault.Secret
+		var found bool
+		for _, s := range secrets {
+			if s.Reference == filterVal {
+				secret = s
+				found = true
+				break
+			}
+		}
 		if !found {
 			return fmt.Errorf("secret not found")
 		}

schemas/flowfile_schema.json

@@ -483,8 +483,11 @@
       "default": ""
     },
     "executables": {
-      "$ref": "#/definitions/Executable",
-      "default": []
+      "type": "array",
+      "default": [],
+      "items": {
+        "$ref": "#/definitions/Executable"
+      }
     },
     "fromFile": {
       "$ref": "#/definitions/FromFile",