Playground

Extension Overview

This extension allows to easily upload your Salesforce projects as assets/plays directly to Playground, right from your editor, giving you the best experience. This is the easiest way to upload solutions to Playground. This works well with SFDX projects and Salesforce extensions.

About Playground

Playground is an intuitive, collaborative and easy-to-use cloud application to upload and share solutions within the Salesforce ecosystem.

Extension Requirements

You should have a Playground login to use this extension. Once you are logged in, you need to create an App Password to be used for this extension.

Setup

Once installed, connect your extension with App Passwords. Follow the below step by step process to connect.

Generating App Password

To connect VS code with Playground, user would need to generate an App Password in Playground and consume the details in VS Code. Log into Playground and click on the user details on top right. Select Profile option to see profile details and customize it.

From the left sidebar menu, click on App Passwords. This would open the existing app passwords (if created earlier) and it gives an option to create a new app password. Click on New buttton. It opens a pop-up to create a new app password. Enter a meaningful name like VSCode. Click Continue, once done.

Copy the app password. Make sure to note it safely (if needed), as it will not be visible after you move away from the page.

Get User Nickname

Remaining on the profile details page, click on General link on the sidebar. Copy the nickname. It will be needed later while connecting VS Code with Playground application.

Connecting VS Code with Playground/ Making folder a Playground directpry

Once the password is generated, configure VS Code editor & establish a connection. Click on Playground: Init button on the bottom status bar as shown below.

On button click, it will ask for following basic information:

1. Domain Url - Default is https://live.playg.app. This will be different if you are using private space of Playground
2. Nickname - Get your Nickname as explained above
3. Password - Generate your Password as explained above
4. Title - Add title of play which will mark the current folder as Playground directory
5. Type - Add type of play depicting type of Playground directory

Extension Usage

Once everything is set up, Uploading project to Playground is a single click task. Just go to Playground: Push Changes button in the bottom status bar & it will pick your current project & upload it to Playground. This button is clever & it overrides/updates the existing play next time if the same directory sent again with any changes.

Want to send limited files?

Playground generates a default .playgignore file to limit the unnecessary files being uploaded to Playground to make your solution clean & easily reusable. .playgignore uses glob patterns to ignore the files. Use appropriate patterns to limit according to the needs.

Open the play through vscode

There is an open link button just along with Playground: Push Changes that can simply open your play whenever you want. See the above image to locate.

Extension Commands

If buttons are not visible, use the following commands from Command Pallette:

• Init: Setup folder as a Playground directory
• Connect: Run this command to reset your login if required to replace it with the new App Password.
• Push & Create Play: Creates a play by pushing all files in your Salesforce Project
• Push & Update Play: Updates the current play by sending your changed files to Playground.

Relevant Links

• Getting Started
• What is Playground?
• Terminology
• Create a New Play