Merge pull request #48 from stuartleeks/sl/substition

Add placeholder substitution to templates

Author: stuartleeks

.devcontainer/devcontainer.json

@@ -58,7 +58,7 @@
 	// "forwardPorts": [],
 
 	// Use 'postCreateCommand' to run commands after the container is created.
-	"postCreateCommand": "sudo chown $(whoami) /go/pkg",
+	"postCreateCommand": "make post-create",
 
 	// Uncomment to connect as a non-root user. See https://aka.ms/vscode-remote/containers/non-root.
 	"remoteUser": "vscode"

.vscode/launch.json

@@ -11,7 +11,14 @@
             "mode": "auto",
             "program": "${workspaceFolder}/cmd/devcontainer",
             "env": {},
-            "args": ["template", "list"]
+            "args": ["template", "list"],
+            "dlvLoadConfig": {
+                "followPointers": true,
+                "maxVariableRecurse": 1,
+                "maxStringLen": 512,
+                "maxArrayValues": 64,
+                "maxStructFields": -1
+            }
         },
         {
             "name": "Connect to server",
@@ -21,6 +28,13 @@
             "remotePath": "${workspaceFolder}",
             "port": 2345,
             "host": "127.0.0.1",
+            "dlvLoadConfig": {
+                "followPointers": true,
+                "maxVariableRecurse": 1,
+                "maxStringLen": 512,
+                "maxArrayValues": 64,
+                "maxStructFields": -1
+            }
         }, 
     ]
 }

.vscode/settings.json

@@ -0,0 +1,14 @@
+{
+    "go.delveConfig": {
+        "dlvLoadConfig": {
+            "followPointers": true,
+            "maxVariableRecurse": 1,
+            "maxStringLen": 512,
+            "maxArrayValues": 64,
+            "maxStructFields": -1
+        },
+        "apiVersion": 2,
+        "showGlobalVariables": false,
+        "debugAdapter": "legacy"
+    }
+}

Makefile

@@ -35,4 +35,9 @@ test:
 
 
 fmt:
-	find . -name '*.go' | grep -v vendor | xargs gofmt -s -w
+	find . -name '*.go' | grep -v vendor | xargs gofmt -s -w
+
+
+post-create:
+	sudo chown vscode /go/pkg
+	go get -u github.com/kyoh86/richgo

docs/snippet.md

@@ -154,3 +154,13 @@ For example:
     ]
 }
 ```
+
+### Placeholder Values
+
+After content has been merged/added to files when performing snippet actions, the following placeholder values are substituted:
+
+| Placeholder                  | Value                                                                                                                |
+|------------------------------|----------------------------------------------------------------------------------------------------------------------|
+| `__DEVCONTAINER_NAME__`      | The name of the dev container (from the `name` property in `devcontainer.json`)                                      |
+| `__DEVCONTAINER_USER_NAME__` | The name of the user for dev container (from the `remoteuser` property in `devcontainer.json`, or `root` if not set) |
+| `__DEVCONTAINER_HOME__`      | The home folder for the dev container (e.g. `/home/vscode` or `/root`)                                               |

docs/template.md

@@ -82,11 +82,20 @@ Assuming you cloned [github.com/microsoft/vscode-dev-containers/](https://github
 }
 ```
 
+## Placeholder Values
+
+After content has been copied to the project folder from a template, the following placeholder values are substituted:
+
+| Placeholder                  | Value                                                                                                                |
+|------------------------------|----------------------------------------------------------------------------------------------------------------------|
+| `__DEVCONTAINER_NAME__`      | The name of the dev container (from the `name` property in `devcontainer.json`)                                      |
+| `__DEVCONTAINER_USER_NAME__` | The name of the user for dev container (from the `remoteuser` property in `devcontainer.json`, or `root` if not set) |
+| `__DEVCONTAINER_HOME__`      | The home folder for the dev container (e.g. `/home/vscode` or `/root`)                                               |
+
 ## Repository containers
 
 VS Code dev containers have another feature called "Repository containers". These are a set of dev container definitions that VS Code will automatically apply to a project based on its git repo.
 
 The default definitions are in the [microsoft/vscode-dev-containers](https://github.com/microsoft/vscode-dev-containers/tree/master/repository-containers) repo. If you look at the repo, you will see a `github.com` folder followed by paths for `<org>/<repo>`, e.g. `django/django`. The `https://github.com/django/django` repo doesn't contain a dev container definition, but VS Code will use the repository container definition from the `microsoft/vscode-dev-containers` repo.
 
-You can also configure VS Code to look for additional local paths for repository containers by providing a value for the VS Code `remote.containers.repository-container-paths` setting (see [this issue](https://github.com/microsoft/vscode-remote-release/issues/3218) for more details). 
-
+You can also configure VS Code to look for additional local paths for repository containers by providing a value for the VS Code `remote.containers.repository-container-paths` setting (see [this issue](https://github.com/microsoft/vscode-remote-release/issues/3218) for more details).

internal/pkg/devcontainers/snippet.go

@@ -1,7 +1,6 @@
 package devcontainers
 
 import (
-	"bytes"
 	"encoding/json"
 	"fmt"
 	"io/ioutil"
@@ -225,7 +224,7 @@ func addFolderSnippetToDevContainer(projectFolder string, snippet *DevcontainerS
 				return fmt.Errorf("content must be set for %s actions", action.Type)
 			}
 			dockerfileFilename := filepath.Join(projectFolder, ".devcontainer", "Dockerfile")
-			err = insertDockerfileSnippet(dockerfileFilename, action.Content+"\n")
+			err = insertDockerfileSnippet(projectFolder, dockerfileFilename, action.Content+"\n")
 			if err != nil {
 				return err
 			}
@@ -251,11 +250,11 @@ RUN /tmp/%[2]s
 `, snippet.Name, scriptFilename)
 	dockerfileFilename := filepath.Join(projectFolder, ".devcontainer", "Dockerfile")
 
-	err := insertDockerfileSnippet(dockerfileFilename, snippetContent)
+	err := insertDockerfileSnippet(projectFolder, dockerfileFilename, snippetContent)
 	return err
 }
 
-func insertDockerfileSnippet(dockerfileFilename string, snippetContent string) error {
+func insertDockerfileSnippet(projectFolder string, dockerfileFilename string, snippetContent string) error {
 
 	buf, err := ioutil.ReadFile(dockerfileFilename)
 	if err != nil {
@@ -266,7 +265,7 @@ func insertDockerfileSnippet(dockerfileFilename string, snippetContent string) e
 	dockerFileLines := strings.Split(dockerfileContent, "\n")
 	addSeparator := false
 	addedSnippetContent := false
-	var newContent bytes.Buffer
+	var newContent strings.Builder
 	for _, line := range dockerFileLines {
 		if addSeparator {
 			if _, err = newContent.WriteString("\n"); err != nil {
@@ -301,7 +300,14 @@ func insertDockerfileSnippet(dockerfileFilename string, snippetContent string) e
 		}
 	}
 
-	err = ioutil.WriteFile(dockerfileFilename, newContent.Bytes(), 0)
+	content := newContent.String()
+	values, err := getSubstitutionValuesFromFile(filepath.Join(projectFolder, ".devcontainer/devcontainer.json"))
+	if err != nil {
+		return fmt.Errorf("failed to get dev container values: %s", err)
+	}
+	content = performSubstitutionString(values, content)
+
+	err = ioutil.WriteFile(dockerfileFilename, []byte(content), 0)
 
 	return err
 
@@ -333,21 +339,11 @@ func mergeJSON(projectFolder string, snippet *DevcontainerSnippet, relativeMerge
 		return err
 	}
 
-	// replace __DEVCONTAINER_NAME__ with name
-	devcontainerName, devcontainerUserName := getDevcontainerNameAndUserName(filepath.Join(projectFolder, ".devcontainer/devcontainer.json"))
-	if devcontainerName == "" {
-		return fmt.Errorf("failed to get dev container name")
-	}
-	resultJSON = strings.ReplaceAll(resultJSON, "__DEVCONTAINER_NAME__", devcontainerName)
-	if devcontainerUserName == "" {
-		devcontainerUserName = "root"
-	}
-	devcontainerHome := "/home/" + devcontainerUserName
-	if devcontainerUserName == "root" {
-		devcontainerHome = "/root"
+	values, err := getSubstitutionValuesFromFile(filepath.Join(projectFolder, ".devcontainer/devcontainer.json"))
+	if err != nil {
+		return fmt.Errorf("failed to get dev container values: %s", err)
 	}
-	resultJSON = strings.ReplaceAll(resultJSON, "__DEVCONTAINER_USER_NAME__", devcontainerUserName)
-	resultJSON = strings.ReplaceAll(resultJSON, "__DEVCONTAINER_HOME__", devcontainerHome)
+	resultJSON = performSubstitutionString(values, resultJSON)
 
 	err = ioutil.WriteFile(basePath, []byte(resultJSON), 0666)
 	if err != nil {
@@ -372,17 +368,23 @@ func loadJSONDocument(path string) (*dora_ast.RootNode, error) {
 	return &baseDocument, nil
 }
 
-func getDevcontainerNameAndUserName(devContainerJsonPath string) (string, string) {
+type SubstitutionValues struct {
+	Name       string
+	UserName   string
+	HomeFolder string
+}
+
+func getSubstitutionValuesFromFile(devContainerJsonPath string) (*SubstitutionValues, error) {
 	// This doesn't use standard `json` pkg as devcontainer.json permits comments (and the default templates include them!)
 
 	buf, err := ioutil.ReadFile(devContainerJsonPath)
 	if err != nil {
-		return "", ""
+		return nil, err
 	}
 
 	c, err := dora.NewFromBytes(buf)
 	if err != nil {
-		return "", ""
+		return nil, err
 	}
 
 	name, err := c.GetString("$.name")
@@ -391,8 +393,35 @@ func getDevcontainerNameAndUserName(devContainerJsonPath string) (string, string
 	}
 	userName, err := c.GetString("$.remoteUser")
 	if err != nil {
-		userName = ""
+		userName = "root"
 	}
+	homeFolder := "/home/" + userName
+	if userName == "root" {
+		homeFolder = "/root"
+	}
+
+	return &SubstitutionValues{
+		Name:       name,
+		UserName:   userName,
+		HomeFolder: homeFolder,
+	}, nil
+}
+
+func performSubstitutionFile(substitutionValues *SubstitutionValues, filename string) error {
+	buf, err := ioutil.ReadFile(filename)
+	if err != nil {
+		return err
+	}
+	content := string(buf)
+	content = performSubstitutionString(substitutionValues, content)
+	err = ioutil.WriteFile(filename, []byte(content), 0)
+	return err
+}
 
-	return name, userName
+func performSubstitutionString(substitutionValues *SubstitutionValues, content string) string {
+	// replace __DEVCONTAINER_NAME__ with name etc
+	content = strings.ReplaceAll(content, "__DEVCONTAINER_NAME__", substitutionValues.Name)
+	content = strings.ReplaceAll(content, "__DEVCONTAINER_USER_NAME__", substitutionValues.UserName)
+	content = strings.ReplaceAll(content, "__DEVCONTAINER_HOME__", substitutionValues.HomeFolder)
+	return content
 }