Merge pull request #27 from stuartleeks/sl/set-devcontainer-name

Set devcontainer.json name property when adding a template

Author: stuartleeks

cmd/devcontainer/template.go

@@ -4,6 +4,7 @@ import (
 	"fmt"
 	"io/ioutil"
 	"os"
+	"path/filepath"
 	"sort"
 	"text/tabwriter"
 
@@ -63,6 +64,7 @@ func createTemplateListCommand() *cobra.Command {
 }
 
 func createTemplateAddCommand() *cobra.Command {
+	var devcontainerName string
 	cmd := &cobra.Command{
 		Use:   "add TEMPLATE_NAME",
 		Short: "add devcontainer from template",
@@ -94,7 +96,22 @@ func createTemplateAddCommand() *cobra.Command {
 			if err = ioutil2.CopyFolder(template.Path, currentDirectory+"/.devcontainer"); err != nil {
 				return fmt.Errorf("Error copying folder: %s\n", err)
 			}
-			return err
+
+			// by default the "name" in devcontainer.json is set to the name of the template
+			// override it here with the value passed in as --devcontainer-name (or the containing folder if not set)
+			if devcontainerName == "" {
+				devcontainerName, err = devcontainers.GetDefaultDevcontainerNameForFolder(currentDirectory)
+				if err != nil {
+					return fmt.Errorf("Error getting default devcontainer name: %s", err)
+				}
+			}
+			devcontainerJsonPath := filepath.Join(currentDirectory, ".devcontainer/devcontainer.json")
+			err = devcontainers.SetDevcontainerName(devcontainerJsonPath, devcontainerName)
+			if err != nil {
+				return fmt.Errorf("Error setting devcontainer name: %s", err)
+			}
+
+			return nil
 		},
 		ValidArgsFunction: func(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective) {
 			// only completing the first arg  (template name)
@@ -113,6 +130,7 @@ func createTemplateAddCommand() *cobra.Command {
 			return names, cobra.ShellCompDirectiveNoFileComp
 		},
 	}
+	cmd.Flags().StringVar(&devcontainerName, "devcontainer-name", "", "Value to set the devcontainer.json name property to (default is folder name)")
 	return cmd
 }
 

internal/pkg/devcontainers/template.go

@@ -5,6 +5,7 @@ import (
 	"io/ioutil"
 	"os"
 	"path/filepath"
+	"regexp"
 	"sort"
 
 	"github.com/stuartleeks/devcontainer-cli/internal/pkg/config"
@@ -86,3 +87,33 @@ func getTemplatesFromFolder(folder string) ([]DevcontainerTemplate, error) {
 	}
 	return templates, nil
 }
+
+func GetDefaultDevcontainerNameForFolder(folderPath string) (string, error) {
+
+	absPath, err := filepath.Abs(folderPath)
+	if err != nil {
+		return "", err
+	}
+
+	_, folderName := filepath.Split(absPath)
+	return folderName, nil
+}
+
+func SetDevcontainerName(devContainerJsonPath string, name string) error {
+	// This doesn't use `json` as devcontainer.json permits comments (and the default templates include them!)
+
+	buf, err := ioutil.ReadFile(devContainerJsonPath)
+	if err != nil {
+		return fmt.Errorf("error reading file %q: %s", devContainerJsonPath, err)
+	}
+
+	r := regexp.MustCompile("(\"name\"\\s*:\\s*\")[^\"]*(\")")
+	replacement := []byte("${1}" + name + "${2}")
+	buf = r.ReplaceAll(buf, replacement)
+
+	if err = ioutil.WriteFile(devContainerJsonPath, buf, 0777); err != nil {
+		return fmt.Errorf("error writing file %q: %s", devContainerJsonPath, err)
+	}
+
+	return nil
+}

internal/pkg/devcontainers/template_test.go

@@ -0,0 +1,40 @@
+package devcontainers
+
+import (
+	"io/ioutil"
+	"os"
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+)
+
+func TestSetDevcontainerName(t *testing.T) {
+
+	f, err := ioutil.TempFile("", "test.json")
+	assert.NoError(t, err)
+	defer os.Remove(f.Name())
+
+	_, _ = f.WriteString(`{
+	"name": "initial",
+	// here's a comment!
+	"otherProperties": [
+		"something",
+		"here"
+	]
+}`)
+
+	err = SetDevcontainerName(f.Name(), "newName")
+	assert.NoError(t, err)
+
+	buf, err := ioutil.ReadFile(f.Name())
+	assert.NoError(t, err)
+
+	assert.Equal(t, `{
+	"name": "newName",
+	// here's a comment!
+	"otherProperties": [
+		"something",
+		"here"
+	]
+}`, string(buf))
+}