From 3d9a57a2af614b75672802d7d056781db660bd17 Mon Sep 17 00:00:00 2001 From: Dehru Cromer Date: Wed, 21 Aug 2019 12:09:50 -0600 Subject: [PATCH] add sfdx project container template, readme, and test --- .../sfdx-project/.devcontainer/Dockerfile | 1 + .../.devcontainer/devcontainer.json | 11 +++++ containers/sfdx-project/.npmignore | 3 ++ containers/sfdx-project/README.md | 43 +++++++++++++++++++ 4 files changed, 58 insertions(+) create mode 100644 containers/sfdx-project/.devcontainer/Dockerfile create mode 100644 containers/sfdx-project/.devcontainer/devcontainer.json create mode 100644 containers/sfdx-project/.npmignore create mode 100644 containers/sfdx-project/README.md diff --git a/containers/sfdx-project/.devcontainer/Dockerfile b/containers/sfdx-project/.devcontainer/Dockerfile new file mode 100644 index 0000000000..f70c65aa97 --- /dev/null +++ b/containers/sfdx-project/.devcontainer/Dockerfile @@ -0,0 +1 @@ +FROM salesforce/salesforcedx \ No newline at end of file diff --git a/containers/sfdx-project/.devcontainer/devcontainer.json b/containers/sfdx-project/.devcontainer/devcontainer.json new file mode 100644 index 0000000000..5ef0218792 --- /dev/null +++ b/containers/sfdx-project/.devcontainer/devcontainer.json @@ -0,0 +1,11 @@ +{ + "name": "Salesforce Project", + "dockerFile": "Dockerfile", + "extensions": [ + "salesforce.salesforcedx-vscode", + "redhat.vscode-xml", + "dbaeumer.vscode-eslint", + "esbenp.prettier-vscode" + ] + } + \ No newline at end of file diff --git a/containers/sfdx-project/.npmignore b/containers/sfdx-project/.npmignore new file mode 100644 index 0000000000..898cf94a33 --- /dev/null +++ b/containers/sfdx-project/.npmignore @@ -0,0 +1,3 @@ +README.md +.vscode +.npmignore diff --git a/containers/sfdx-project/README.md b/containers/sfdx-project/README.md new file mode 100644 index 0000000000..70e0bff29e --- /dev/null +++ b/containers/sfdx-project/README.md @@ -0,0 +1,43 @@ +# SFDX Project + +## Summary + +Salesforce Extension for VS Code supports remote development and allows you to use a docker container as a full-featured development environment. + +| Metadata | Value | +|----------|-------| +| *Contributors* | Salesforce Developer Experience Teams | +| *Definition type* | Dockerfile | +| *Languages, Platforms* | Salesforce CLI, Lightning Web Components, Apex, Aura, Java, node.js, Javascript, HTML, CSS, Git | + +## Description + +Remote development in container environment is powered by the official Salesforce sfdx [image](https://hub.docker.com/r/salesforce/salesforcedx) on Docker Hub. Salesforce CLI, Java, node.js, and Git are pre-installed and configured in your container. You can open a project mounted into the container and edit with full IntelliSense (completions), code navigation, debugging, and more. + +You can learn more about remote development with Salesforce Extension [here](https://forcedotcom.github.io/salesforcedx-vscode/). + +## Using this definition with an existing folder + +Just follow these steps: + +1. If this is your first time using a development container, follow the [getting started steps](https://aka.ms/vscode-remote/containers/getting-started) to set up your machine. + +2. To use VS Code's copy of this definition: + 1. Start VS Code and open your project folder. + 2. Press F1 and run **Remote-Containers: Add Development Container Configuration Files...** from the Command Palette. + 3. Select the Salesforce Project definition. + +3. To use latest-and-greatest copy of this definition from the repository: + 1. Clone this repository. + 2. Copy the contents of this folder in the cloned repository to the root of your project folder. + 3. Start VS Code and open your project folder. + +4. After step 2 or 3, edit the contents of the `.devcontainer` folder in your project, as required. + +5. Start using the definition by running **Remote-Containers: Reopen Folder in Container** from the Command Palette. + +## License + +Copyright (c) Microsoft Corporation. All rights reserved. + +Licensed under the MIT License. See [LICENSE](https://github.com/Microsoft/vscode-dev-containers/blob/master/LICENSE).