| 1 | # salesforcedx-templates
|
| 2 |
|
| 3 | This repository provides a series of commands, templates, and generators for various metadata types. It is bundled with the [salesforcedx plugin](https://www.npmjs.com/package/salesforcedx).
|
| 4 |
|
| 5 | [](https://circleci.com/gh/forcedotcom/salesforcedx-templates/tree/master)
|
| 6 | [](https://codecov.io/gh/forcedotcom/salesforcedx-templates)
|
| 7 | [](https://snyk.io/test/github/forcedotcom/salesforcedx-templates)
|
| 8 | [](https://github.com/forcedotcom/salesforcedx-templates/blob/master/package.json)
|
| 9 |
|
| 10 | ## Getting Started
|
| 11 |
|
| 12 | To use, install the [Salesforce CLI](https://developer.salesforce.com/tools/sfdxcli) and run the following commands.
|
| 13 |
|
| 14 | ```
|
| 15 | Verify the CLI is installed
|
| 16 | $ sfdx (-v | --version)
|
| 17 | Install the salesforcedx plugin
|
| 18 | $ sfdx plugins:install salesforcedx
|
| 19 | To run a command
|
| 20 | $ sfdx [command]
|
| 21 | ```
|
| 22 |
|
| 23 | To build the plugin locally, make sure to have yarn installed and run the following commands:
|
| 24 |
|
| 25 | ```
|
| 26 | Clone the repository
|
| 27 | $ git clone git@github.com:forcedotcom/salesforcedx-templates.git
|
| 28 | Install the dependencies and compile
|
| 29 | $ yarn install
|
| 30 | $ yarn prepack
|
| 31 | Link your plugin to the sfdx cli
|
| 32 | $ sfdx plugins:link .
|
| 33 | To verify
|
| 34 | $ sfdx plugins
|
| 35 | salesforcedx-templates 0.0.0 (link) /Users/a.jha/Documents/repos/salesforcedx-templates
|
| 36 | ```
|
| 37 |
|
| 38 | ## Commands
|
| 39 |
|
| 40 | - [`sfdx force:apex:class:create`](https://github.com/forcedotcom/salesforcedx-templates/blob/master/COMMANDS.md#sfdx-forceapexclasscreate)
|
| 41 | - [`sfdx force:apex:trigger:create`](https://github.com/forcedotcom/salesforcedx-templates/blob/master/COMMANDS.md#sfdx-forceapextriggercreate)
|
| 42 | - [`sfdx force:lightning:app:create`](https://github.com/forcedotcom/salesforcedx-templates/blob/master/COMMANDS.md#sfdx-forcelightningappcreate)
|
| 43 | - [`sfdx force:lightning:component:create`](https://github.com/forcedotcom/salesforcedx-templates/blob/master/COMMANDS.md#sfdx-forcelightningcomponentcreate)
|
| 44 | - [`sfdx force:lightning:event:create`](https://github.com/forcedotcom/salesforcedx-templates/blob/master/COMMANDS.md#sfdx-forcelightningeventcreate)
|
| 45 | - [`sfdx force:lightning:interface:create`](https://github.com/forcedotcom/salesforcedx-templates/blob/master/COMMANDS.md#sfdx-forcelightninginterfacecreate)
|
| 46 | - [`sfdx force:lightning:test:create`](https://github.com/forcedotcom/salesforcedx-templates/blob/master/COMMANDS.md#sfdx-forcelightningtestcreate)
|
| 47 | - [`sfdx force:project:create`](https://github.com/forcedotcom/salesforcedx-templates/blob/master/COMMANDS.md#sfdx-forceprojectcreate)
|
| 48 | - [`sfdx force:visualforce:component:create`](https://github.com/forcedotcom/salesforcedx-templates/blob/master/COMMANDS.md#sfdx-forcevisualforcecomponentcreate)
|
| 49 | - [`sfdx force:visualforce:page:create`](https://github.com/forcedotcom/salesforcedx-templates/blob/master/COMMANDS.md#sfdx-forcevisualforcepagecreate)
|
| 50 |
|
| 51 | ## Debugging your plugin
|
| 52 |
|
| 53 | We recommend using the Visual Studio Code (VS Code) IDE for your plugin development. Included in the `.vscode` directory of this plugin is a `launch.json` config file, which allows you to attach a debugger to the node process when running your commands.
|
| 54 |
|
| 55 | To debug the `hello:org` command:
|
| 56 |
|
| 57 | If you linked your plugin to the sfdx cli, call your command with the `dev-suspend` switch:
|
| 58 |
|
| 59 | ```sh-session
|
| 60 | $ sfdx hello:org -u myOrg@example.com --dev-suspend
|
| 61 | ```
|
| 62 |
|
| 63 | Alternatively, to call your command using the `bin/run` script, set the `NODE_OPTIONS` environment variable to `--inspect-brk` when starting the debugger:
|
| 64 |
|
| 65 | ```sh-session
|
| 66 | $ NODE_OPTIONS=--inspect-brk bin/run hello:org -u myOrg@example.com
|
| 67 | ```
|
| 68 |
|
| 69 | 2. Set some breakpoints in your command code
|
| 70 | 3. Click on the Debug icon in the Activity Bar on the side of VS Code to open up the Debug view.
|
| 71 | 4. In the upper left hand corner of VS Code, verify that the "Attach to Remote" launch configuration has been chosen.
|
| 72 | 5. Hit the green play button to the left of the "Attach to Remote" launch configuration window. The debugger should now be suspended on the first line of the program.
|
| 73 | 6. Hit the green play button at the top middle of VS Code (this play button will be to the right of the play button that you clicked in step #5).
|
| 74 | <br><img src=".images/vscodeScreenshot.png" width="480" height="278"><br>
|
| 75 | Congrats, you are debugging!
|