feat(config): allow inline include

resolves #191

Author: JanDeDobbeleer

src/config/config_test.go

@@ -54,6 +54,17 @@ func TestLoadConfig(t *testing.T) {
 			config:      "aliae.invalid.yaml",
 			expectError: true,
 		},
+		{
+			name:   "Valid with generic",
+			config: "aliae.valid_generic.yaml",
+			expected: &Aliae{
+				Aliae: shell.Aliae{
+					{Name: "test", Value: shell.Template("test")},
+					{Name: "test2", Value: shell.Template("test2")},
+					{Name: "test3", Value: shell.Template("test3")},
+				},
+			},
+		},
 	}
 
 	for _, tc := range tests {

src/config/test/aliae.valid_generic.yaml

@@ -0,0 +1,4 @@
+alias:
+  - !include_dir ./aliases
+  - name: test3
+    value: test3

src/config/unmarshal.go

@@ -86,7 +86,17 @@ func includeUnmarshaler(b []byte) ([]byte, error) {
 
 			indented := bytes.Join(splitted, newline)
 
-			result := append(parts[0][0:], newline...) //nolint:gocritic
+			result := parts[0][0:]
+
+			switch string(result) {
+			case "-":
+				// check if we're in the list instead of the key
+				// if so, drop the dash and start with a newline
+				result = newline
+			default:
+				result = append(result, newline...)
+			}
+
 			result = append(result, indented...)
 
 			s[i] = result

website/docs/setup/include.mdx

@@ -1,27 +1,68 @@
----
-id: include
-title: Include
-sidebar_label: ➕ Include files
----
-
-## Example
-
-```yaml title=".aliae.yaml"
-aliae: !include "{{ .Home }}/.aliae/aliases.yaml"
-env: !include_dir "{{ .Home }}/.aliae/envs"
-```
-
-```yaml title="$HOME/.aliae/aliases.yaml"
-- name: g
-  value: git
-- name: k
-  value: kubectl
-```
-
-## Description
-
-The `!include` and `!include_dir` yaml tags allow you to include a single file or a directory of .yaml files respectively.
-This allows for clean organization of aliae, envs, and all other things handled by Aliae.
-File/Directory paths support [templating][templates]
-
-[templates]: templates.mdx
+---
+id: include
+title: Include
+sidebar_label: ➕ Include files
+---
+
+## Example
+
+```yaml title=".aliae.yaml"
+aliae: !include "{{ .Home }}/.aliae/aliases.yaml"
+env: !include_dir "{{ .Home }}/.aliae/envs"
+```
+
+```yaml title="$HOME/.aliae/aliases.yaml"
+- name: g
+  value: git
+- name: k
+  value: kubectl
+```
+
+## Description
+
+The `!include` and `!include_dir` yaml tags allow you to include a single file or a directory of .yaml files respectively.
+This allows for clean organization of aliae, envs, and all other things handled by Aliae.
+File/Directory paths support [templating][templates].
+
+## Inline Include
+
+If you want to have a more fine grained control over the included file, you can use the `!include` tag inline in combination
+with other defined aliases.
+
+```yaml title=".aliae.yaml"
+aliae:
+  - !include "{{ .Home }}/.aliae/kubernetes.yaml"
+  - name: g
+    value: git
+```
+
+```yaml title="$HOME/.aliae/kubernetes.yaml"
+- name: k
+  value: kubectl
+- name: kg
+  value: kubectl get
+- name: kgpo
+  value: kubectl get pod
+- name: ksysgpo
+  value: kubectl --namespace=kube-system get pod
+- name: krm
+  value: kubectl delete
+- name: krmf
+  value: kubectl delete -f
+- name: krming
+  value: kubectl delete ingress
+- name: krmingl
+  value: kubectl delete ingress -l
+- name: krmingall
+  value: kubectl delete ingress --all-namespaces
+- name: kgsvcoyaml
+  value: kubectl get service -o=yaml
+- name: kgsvcwn
+  value: kubectl get service --watch --namespace
+- name: kgsvcslwn
+  value: kubectl get service --show-labels --watch --namespace
+- name: kgwf
+  value: kubectl get --watch -f
+```
+
+[templates]: templates.mdx