FEATURE: parse tasks from source files

Author: Florian Heinze

README.md

@@ -10,6 +10,7 @@ script directly `./dev.sh some-task`.
 * easy initialization of your project
 * autocompletion
 * documentation of your tasks will be used to provide help
+* structure your tasks in different files
 
 ## Motivation
 
@@ -112,6 +113,22 @@ function sometask() {
 }
 ```
 
+### Structuring tasks into different files
+
+```bash
+#!/bin/bash
+############################## DEV_SCRIPT_MARKER ##############################
+
+# You can structure your tasks into different files using `source`. We will also
+# parse these files. The order will be: 
+#   1. tasks of the dev.sh
+#   2. tasks of sourced files
+source ./dev_utilities.sh
+source ./dev_tasks_testing.sh
+source ./dev_tasks_release.sh
+```
+
+
 ## Usage
 
 run `dev` for more information.

dev.sh

@@ -7,13 +7,29 @@
 # nested folder using `dev run some-task`.                                    #
 ###############################################################################
 
+source ./dev_utilities.sh
+source ./dev_tasks_testing.sh
+source ./dev_tasks_release.sh
+
 set -e
 
 ######### TASKS #########
 
+# install dev dependencies
+function setup() {
+  # As the setup typically is more complex we recommend using a separate
+  # file `dev_setup.sh`
+  ./dev_setup.sh
+}
+
+# build
+function build() {
+  go build main
+}
+
 # exposes ./main binary globally
 # we rename the original file and copy a fresh build to `/usr/local/bin/`
-function switch-dev-binary() {
+function switch-binary() {
     echo "-----------> creating build"
     build
     echo "-----------> replacing binary"
@@ -29,7 +45,7 @@ function switch-dev-binary() {
 #
 # we check if the dev binary was backed up and replace the current dev with
 # this backup ;)
-function restore-dev-binary() {
+function restore-binary() {
   if test -f "/usr/local/bin/dev_back"; then
       echo "/usr/local/bin/dev_back exists."
       echo "restoring /usr/local/bin/dev "
@@ -39,45 +55,6 @@ function restore-dev-binary() {
       echo "no /usr/local/bin/dev_back found. Nothing to restore!"
   fi
 }
-# build
-function build() {
-  go build main
-}
-
-# install dev dependencies
-function setup() {
-  # As the setup typically is more complex we recommend using a separate
-  # file `dev_setup.sh`
-  ./dev_setup.sh
-}
-
-# running tests
-function run-test() {
-  pushd utils
-  go test "$@"
-  popd
-  _log_success "All Tests finished successfully ;)"
-}
-
-# releasing a new version
-function release() {
-  run-test
-  build
-  goreleaser release --rm-dist
-  _log_success "Release finished successfully ;)"
-}
-
-####### Utilities #######
-
-_log_success() {
-  printf "\033[0;32m${1}\033[0m\n"
-}
-_log_warning() {
-  printf "\033[1;33m%s\033[0m\n" "${1}"
-}
-_log_error() {
-  printf "\033[0;31m%s\033[0m\n" "${1}"
-}
 
 # THIS NEEDS TO BE LAST!!!
 # this will run your tasks

dev_tasks_release.sh

@@ -0,0 +1,11 @@
+#!/bin/bash
+
+set -e
+
+# releasing a new version
+function release() {
+  run-test
+  build
+  goreleaser release --rm-dist
+  _log_success "Release finished successfully ;)"
+}

dev_tasks_testing.sh

@@ -0,0 +1,11 @@
+#!/bin/bash
+
+set -e
+
+# running tests
+function run-test() {
+  pushd utils
+  go test "$@"
+  popd
+  _log_success "All Tests finished successfully ;)"
+}

dev_utilities.sh

@@ -0,0 +1,15 @@
+#!/bin/bash
+
+set -e
+
+####### Utilities #######
+
+_log_success() {
+  printf "\033[0;32m${1}\033[0m\n"
+}
+_log_warning() {
+  printf "\033[1;33m%s\033[0m\n" "${1}"
+}
+_log_error() {
+  printf "\033[0;31m%s\033[0m\n" "${1}"
+}

utils/fixtures/nested_imports/tasks_from_imports__import3.sh

@@ -0,0 +1,14 @@
+#!/bin/bash
+############################## DEV_SCRIPT_MARKER ##############################
+
+set -e
+
+######### TASKS #########
+
+function nested-import-task1 {
+    echo "Some Code"
+}
+
+function nested-import-task2 {
+    echo "Some Code"
+}

utils/fixtures/tasks_from_imports.sh

@@ -0,0 +1,14 @@
+#!/bin/bash
+############################## DEV_SCRIPT_MARKER ##############################
+
+source ./tasks_from_imports__import1.sh
+source ./tasks_from_imports__import2.sh
+source ./nested_imports/tasks_from_imports__import3.sh
+
+set -e
+
+######### TASKS #########
+
+function task() {
+    echo "Some Code"
+}

utils/fixtures/tasks_from_imports__import1.sh

@@ -0,0 +1,14 @@
+#!/bin/bash
+############################## DEV_SCRIPT_MARKER ##############################
+
+set -e
+
+######### TASKS #########
+
+function import1-task1 {
+    echo "Some Code"
+}
+
+function import1-task2 {
+    echo "Some Code"
+}

utils/fixtures/tasks_from_imports__import2.sh

@@ -0,0 +1,14 @@
+#!/bin/bash
+############################## DEV_SCRIPT_MARKER ##############################
+
+set -e
+
+######### TASKS #########
+
+function import2-task1 {
+    echo "Some Code"
+}
+
+function import2-task2 {
+    echo "Some Code"
+}

utils/parse_dev_script_tasks.go

@@ -3,24 +3,57 @@ package utils
 import (
 	"log"
 	"os"
+	"path"
+	"path/filepath"
 	"regexp"
 	"sort"
 	"strings"
 )
 
-func ParseDevScriptTasks(devScriptPath string) []DevScriptTask {
-	// https://regex101.com/r/ZFB8ml/1
+func getSourcedScriptContent(sourcePath string, devScriptPath string) string {
+	absolutePath := ""
+	if filepath.IsAbs(sourcePath) {
+		// sourcePath is absolute, we can ignore the devScriptPath
+		absolutePath = sourcePath
+	} else {
+		// sourcePath is relative
+		absolutePath = path.Join(path.Dir(devScriptPath), sourcePath)
+	}
+	sourceBytes, err := os.ReadFile(absolutePath)
+	if err != nil {
+		return ""
+	}
+	return string(sourceBytes)
+}
+
+func collectSourcedScripts(devScriptPath string) string {
 	devScriptBytes, err := os.ReadFile(devScriptPath)
 	if err != nil {
 		log.Fatalf("Failed to execute: '%s'", err.Error())
 	}
+	result := string(devScriptBytes)
+	// https://regex101.com/r/POMvPQ/1
+	compiledRegex := regexp.MustCompile(`source (.*\.sh)`)
+	matches := compiledRegex.FindAllStringSubmatch(result, -1)
 
-	devScriptString := string(devScriptBytes)
+	for _, match := range matches {
+		if len(match) > 1 {
+			// capture group `(.*\.sh)`
+			result += "\n"
+			result += getSourcedScriptContent(match[1], devScriptPath)
+		}
+	}
+
+	return result
+}
+
+func ParseDevScriptTasks(devScriptPath string) []DevScriptTask {
+	// https://regex101.com/r/ZFB8ml/1
 	compiledRegex := regexp.MustCompile(`(?m)(?P<comments>(?:^#.*(?:\n|\r\n|\r))*)^(?:function )?(?P<name>[a-zA-Z0-9_-]+)\s?(?:\(\))?\s?{`)
 	captureGroupNames := compiledRegex.SubexpNames()
 	commentsIndex := sort.StringSlice(captureGroupNames).Search("comments")
 	taskIndex := sort.StringSlice(captureGroupNames).Search("name")
-	matches := compiledRegex.FindAllStringSubmatch(devScriptString, -1)
+	matches := compiledRegex.FindAllStringSubmatch(collectSourcedScripts(devScriptPath), -1)
 
 	var results = []DevScriptTask{}
 	for _, match := range matches {