The Salesforce Lightning CLI is a code review tool that lets you scan your code for Lightning-specific issues. This tool is extremely useful for preparing your Lightning code for the forthcoming LockerService addition to the Lightning Platform.
Lightning CLI relies on Heroku Toolbelt. Make sure you have the
heroku command installed correctly before attempting to use this tool. More information about Heroku Toolbelt is available here:
After getting Heroku Toolbelt up and running, install the Lightning CLI plug-in using the following command:
heroku plugins:install salesforce-lightning-cli
Once installed, the plugin will be updated whenever you update the Heroku Toolbelt using the
heroku update command. Do this every week or so to make sure you've got the latest Lightning CLI rules.
Lightning CLI is run just like any other lint command line tool. The only trick is invoking it through the
heroku command. Results are output to your shell window.
You can run the Lightning CLI linter on any folder that contains Lightning components:
heroku lightning:lint ./path/to/lightning/components/
Note: The Lightning CLI runs only on local files. Download your component code to your machine using the Metadata API, or a tool such as the Force.com IDE, the Force.com Migration Tool, or any of a number of third-party options.
Sometimes you just want to scan a particular kind of file. The
--files argument allows you to set a pattern to match files against.
For example, the following command allows you to scan controllers only:
heroku lightning:lint ./path/to/lightning/components/ --files **/*Controller.js
By default only errors will be output from the Lightning CLI. The
--verbose argument will also output any warning message during the linting process.
--config argument to provide a custom rules configuration file. A custom rules configuration file allows you to define your own code style rules, which affect the style rules used by the Lightning CLI tool.
The Lightning CLI default style rules are defined in
lib/code-style-rules.js inside this package. Make a copy of that file, and modify it to match your existing ESLint style rules. Alternatively, you can use your existing ESLint rule configuration file directly. For example:
heroku lightning:lint ./path/to/lightning/components/ --config ~/.eslintrc
Note: Not all ESLint rules can be added or modified using --config. Only rules that we consider benign or neutral in the context of Lightning Platform are activated by Lightning CLI. And again, you can't override the security rules.
When you run Lightning CLI on your Lightning components code, the tool outputs results for each file scanned.
error secure-document Invalid SecureDocument APILine:109:29scrapping = document.innerHTML;^warning no-plusplus Unary operator '++' usedLine:120:50
Issues are displayed, one for each warning or error. Each issue includes the line number, severity, and a brief description of the issue. It also includes the rule name, which you can use to look up a more detailed description of the issue in the Lightning CLI documentation or ESLint documentation, as well as possible resolutions and options for further reading.
Your mission is to review each issue, examine the code in question, and to revise it to eliminate all of the genuine problems.
While no automated tool is perfect, we expect that most errors and warnings generated by Lightning CLI will point to genuine issues in your code, which you should plan to fix before using it with LockerService enabled.
Lightning CLI also provides some built-in help, which you can access at any time with the following commands:
heroku lightning --helpheroku lightning:lint --help
The Salesforce Developer MSA governs your use of the Lightning CLI.