FEATURE: more streamlined init and docs

Author: Florian Heinze

README.md

@@ -89,12 +89,11 @@ In your project root run `dev DSR_INIT`
 This will create the files needed to start writing your own tasks. Run `dev` and you will see
 example tasks that have been created for you. You can now start editing your `dev.sh` ;)
 
-
 ### Writing tasks
 
 ```bash
-function sometask() {
-  echo "TODO: implement sometask()"
+function sometask {
+  echo "TODO: implement sometask"
 }
 ```
 **Tasks starting with `_` are expected to be private and will be ignored**
@@ -117,7 +116,7 @@ dev sometask arg1 arg2 agr3
 ```
 
 ```bash
-function sometask() {
+function sometask {
   echo "$@" # -> "arg1 arg2 agr3"
   echo "$1" # -> "arg1"
   echo "$2" # -> "arg2"
@@ -137,7 +136,7 @@ function sometask() {
 # Some more comments giving a detailed description about your task.
 # Your description can span multiple lines. There MUST NOT be any empty lines 
 # between the comment block and your task.
-function sometask() {
+function sometask {
   echo "TODO: implement"
 }
 ```
@@ -157,11 +156,6 @@ source ./dev_tasks_testing.sh
 source ./dev_tasks_release.sh
 ```
 
-
-## Usage
-
-run `dev` for more information.
-
 ## Roadmap
 
 * parse from comments: usage, examples, flags, params, ...

cmd/init.go

@@ -13,8 +13,7 @@ func buildInitCommand() *cobra.Command {
 	var cmd = &cobra.Command{
 		// IMPORTANT: never color Use! You will not be able to run the command otherwise.
 		Use:     "DSR_INIT",
-		Short:   "creates dev.sh and dev_setup.sh in current folder",
-		Long:    "This creates an example create a dev.sh and dev_setup.sh in your current directory.",
+		Short:   "creates dev.sh and dev_utilities.sh in the current folder",
 		Args:    cobra.NoArgs,
 		GroupID: utils.GROUP_ID_UTILS,
 
@@ -24,17 +23,17 @@ func buildInitCommand() *cobra.Command {
 				log.Fatalf("Failed to execute: '%s'", err.Error())
 			}
 			devShTargetPath := filepath.Join(currentDirectory, "dev.sh")
-			devSetupShTargetPath := filepath.Join(currentDirectory, "dev_setup.sh")
+			devSetupShTargetPath := filepath.Join(currentDirectory, "dev_utilities.sh")
 
 			if !utils.FileExists(devShTargetPath) {
 				// we can access embedded assets by using the path use din the annotation
 				utils.CopyAssetToPath("templates/dev.sh", devShTargetPath)
 				if !utils.FileExists(devSetupShTargetPath) {
-					// We do not want to add dev_setup.sh if INIT was already run.
+					// We do not want to add dev_utilities if INIT was already run.
 					// The file might have been deleted on purpose.
-					utils.CopyAssetToPath("templates/dev_setup.sh", devSetupShTargetPath)
+					utils.CopyAssetToPath("templates/dev_utilities.sh", devSetupShTargetPath)
 				} else {
-					color.Yellow.Println("dev_setup.sh is already present!")
+					color.Yellow.Println("dev_utilities.sh is already present!")
 				}
 			} else {
 				color.Yellow.Println("dev.sh is already present.")

cmd/root.go

@@ -43,7 +43,6 @@ func Execute(version, commit string) {
 	})
 	addDevScriptTasksAsCommands(RootCmd)
 	RootCmd.AddCommand(buildInitCommand())
-	RootCmd.AddCommand(buildTestTaskCommand())
 	// TODO: fix autocompletion
 	if err := RootCmd.Execute(); err != nil {
 		fmt.Println(err)

cmd/test.go

@@ -17,9 +17,8 @@ set -e
 
 # install dev dependencies
 function setup() {
-  # As the setup typically is more complex we recommend using a separate
-  # file `dev_setup.sh`
-  ./dev_setup.sh
+  brew install go
+  brew install goreleaser/tap/goreleaser
 }
 
 # build
@@ -56,6 +55,8 @@ function restore-binary() {
   fi
 }
 
+_log_green "------------------------- RUNNING TASK: $1 -------------------------"
+
 # THIS NEEDS TO BE LAST!!!
 # this will run your tasks
 "$@"

dev.sh

@@ -7,5 +7,5 @@ function release() {
   run-test
   build
   goreleaser release --rm-dist
-  _log_success "Release finished successfully ;)"
+  _log_green "Release finished successfully ;)"
 }

dev_setup.sh

@@ -7,5 +7,5 @@ function run-test() {
   pushd utils
   go test "$@"
   popd
-  _log_success "All Tests finished successfully ;)"
+  _log_green "All Tests finished successfully ;)"
 }

dev_tasks_release.sh

@@ -4,12 +4,12 @@ set -e
 
 ####### Utilities #######
 
-_log_success() {
+_log_green() {
   printf "\033[0;32m${1}\033[0m\n"
 }
-_log_warning() {
+_log_yellow() {
   printf "\033[1;33m%s\033[0m\n" "${1}"
 }
-_log_error() {
+_log_red() {
   printf "\033[0;31m%s\033[0m\n" "${1}"
 }

dev_tasks_testing.sh

@@ -10,7 +10,7 @@ import (
 
 // Assets represents the embedded files.
 //
-//go:embed templates/dev.sh templates/dev_setup.sh
+//go:embed templates/dev.sh templates/dev_utilities.sh
 var Assets embed.FS
 
 func FileExists(path string) bool {