Sublime Plugin for Aura
Python
Clone or download
1
Latest commit 3bc8033 Jan 12, 2017

README.md

Sublime Lightning

Sublime Plugin for Lightning Component Development

This plugin requires Sublime Text 3 and works in conjunction with the Force CLI. You can download the version of Force CLI for your OS here: https://force-cli.herokuapp.com

Make sure that you have installed the Force CLI force binary into a folder on your path, and that it's marked as executable.

To install the sublime-lightning plugin, first install Package Control. Installation instructions are here: https://sublime.wbond.net/installation. Once Package Control is installed, open the Command Palette from Tools > Command Palette, type 'install' and select 'Package Control: Install Package'. Search for 'lightning' and then install the package from the results.

Once you have both of these installed, create a new folder to be your working folder.

mkdir mywork
cd mywork

Launch Sublime Text and open the new folder. If you haven't logged in recently from the command line, you can right-click the folder in Sublime's sidebar and select "Salesforce Login". In the bottom tray of Sublime enter your username and hit the enter key, enter your password (shown in clear text, sorry), and hit the Enter key.

Note: If you receive the error message, "Sublime Lightning Plugin requires the Force.com CLI to function.." and you are certain that the CLI is in your path and is marked as executable, you can try installing the Fix Mac Path plugin, which might solve the issue.

At this point, you won't be able to create Lightning resources, unless you have a folder under your work directory named 'metadata/aura'. You can, however, fetch existing Lightning resources by right-clicking the work folder and selecting "Fetch Lightning". This queries your Salesforce instance for all Lightning bundles and display them for you to choose which you want to edit. You can choose all Lightning bundles, scroll to the specific bundle you want, or begin typing the name of the Lightning bundle to filter the list and then select the one you want.

Once you have a Lightning bundle locally in SublimeText, you can begin editing your component, controller, event, app, or styles. To save your changes back to Salesforce, simply press CMD+S on your Mac or CTRL+S on your Windows machine. You'll see a verification of the save and the time it took in the status bar at the bottom of the screen. You might also, or instead, see errors that prevented saving your changes back to Salesforce.

To create a new Lightning bundle, right-click the "aura" folder and select the type of component that you want to create. You are prompted for a name at the bottom of the screen. Enter a name and hit enter. Once your bundle is created, you can right-click the bundle folder and add other artifacts to your bundle as appropriate for the bundle type.

Deleting artifacts is accomplished by right-clicking the file and selecting "Delete Lightning Definition". This will only delete the selected file and remove that artifact from the bundle both locally and on Salesforce. If you want to delete the entire bundle, right-click the bundle folder and select "Delete Lightning Bundle". Deletes CANNOT be undone and there is no confirmation prompt in the current version of the plugin.

You can safely right-click any file or folder and select the Sublime menu item for deleting file or folder, as what is saved locally is a copy of what is in Salesforce. You can easily retrieve the Lightning bundle or artifact by re-fetching, right-click and select "Fetch Lightning".

screenshot-238

screenshot-237

screenshot-236

screenshot-235

See "how to" video below.

Video: How to Use SublimeText to Edit Lightning Commponents