Merge pull request #13 from stuartleeks/sl/template-config-hint

Show message if not template paths configured

Author: stuartleeks

.vscode/launch.json

@@ -0,0 +1,26 @@
+{
+    // Use IntelliSense to learn about possible attributes.
+    // Hover to view descriptions of existing attributes.
+    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "name": "Launch",
+            "type": "go",
+            "request": "launch",
+            "mode": "auto",
+            "program": "${workspaceFolder}/cmd/devcontainer",
+            "env": {},
+            "args": ["template", "list"]
+        },
+        {
+            "name": "Connect to server",
+            "type": "go",
+            "request": "attach",
+            "mode": "remote",
+            "remotePath": "${workspaceFolder}",
+            "port": 2345,
+            "host": "127.0.0.1",
+        }, 
+    ]
+}

cmd/devcontainer/devcontainer.go

@@ -117,7 +117,6 @@ func createExecCommand() *cobra.Command {
 			}
 			devcontainers, err := devcontainers.ListDevcontainers()
 			if err != nil {
-				fmt.Printf("Error: %v", err)
 				os.Exit(1)
 			}
 			names := []string{}

cmd/devcontainer/main.go

@@ -1,9 +1,6 @@
 package main
 
 import (
-	"fmt"
-	"os"
-
 	"github.com/spf13/cobra"
 	"github.com/stuartleeks/devcontainer-cli/internal/pkg/update"
 )
@@ -33,9 +30,5 @@ func main() {
 	rootCmd.AddCommand(createUpdateCommand())
 	rootCmd.AddCommand(createVersionCommand())
 
-	err := rootCmd.Execute()
-	if err != nil {
-		fmt.Printf("Error running command:\n\t%s\n", err)
-		os.Exit(1)
-	}
+	_ = rootCmd.Execute()
 }

cmd/devcontainer/template.go

@@ -86,7 +86,6 @@ func createTemplateAddCommand() *cobra.Command {
 			}
 			templates, err := devcontainers.GetTemplates()
 			if err != nil {
-				fmt.Printf("Error: %v", err)
 				os.Exit(1)
 			}
 			names := []string{}
@@ -146,7 +145,6 @@ func createTemplateAddLinkCommand() *cobra.Command {
 			}
 			templates, err := devcontainers.GetTemplates()
 			if err != nil {
-				fmt.Printf("Error: %v", err)
 				os.Exit(1)
 			}
 			names := []string{}

internal/pkg/devcontainers/template.go

@@ -2,10 +2,12 @@ package devcontainers
 
 import (
 	"fmt"
-	"github.com/stuartleeks/devcontainer-cli/internal/pkg/config"
 	"io/ioutil"
 	"os"
 	"path/filepath"
+
+	"github.com/stuartleeks/devcontainer-cli/internal/pkg/config"
+	"github.com/stuartleeks/devcontainer-cli/internal/pkg/errors"
 )
 
 // DevcontainerTemplate holds info on templates for list/add etc
@@ -34,6 +36,9 @@ func GetTemplateByName(name string) (*DevcontainerTemplate, error) {
 func GetTemplates() ([]DevcontainerTemplate, error) {
 	templates := []DevcontainerTemplate{}
 	folders := config.GetTemplateFolders()
+	if len(folders) == 0 {
+		return []DevcontainerTemplate{}, &errors.StatusError{Message: "No template folders configured - see https://github.com/stuartleeks/devcontainer-cli/#working-with-devcontainer-templates"}
+	}
 	for _, folder := range folders {
 		folder := os.ExpandEnv(folder)
 		newTemplates, err := getTemplatesFromFolder(folder)

internal/pkg/errors/errors.go

@@ -0,0 +1,10 @@
+package errors
+
+var _ error = &StatusError{}
+
+// StatusError is used to return informational errors
+type StatusError struct {
+	Message string
+}
+
+func (e *StatusError) Error() string { return e.Message }