Lightning Components Developer Guide

What is the Lightning Component Framework?
Quick Start
Creating Components
Using Components
Communicating with Events
Creating Apps
App Overview
Designing App UI
Creating App Templates
Developing Secure Code
Content Security Policy Overview
What is LockerService?
Writing Secure Code
Salesforce Lightning CLI
Install Salesforce Lightning CLI
Use Salesforce Lightning CLI
Review and Resolve Problems
Salesforce Lightning CLI Rules
Salesforce Lightning CLI Options
Styling Apps
Using JavaScript
JavaScript Cookbook
Using Apex
Lightning Data Service (Developer Preview)
Lightning Container (Developer Preview)
Controlling Access
Using Object-Oriented Development
Using the AppCache
Distributing Applications and Components
Debugging
Fixing Performance Warnings
Reference
PDF

Newer Version Available

This content describes an older version of this product. View Latest

Use Salesforce Lightning CLI

Run Lightning CLI just like any other lint command-line tool. The only trick is invoking it through the heroku command. Your shell window shows the results.

Normal Use

You can run the Lightning CLI linter on any folder that contains Lightning components:

1heroku lightning:lint ./path/to/lightning/components/

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 various third-party options.

Note

The default output only shows errors. To see warnings too, use the verbose mode option.

See “Review and Resolve Problems” for what to do with the output of running Lightning CLI.

Common Options

Filtering Files

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:

1heroku lightning:lint ./path/to/lightning/components/ --files **/*Controller.js

Verbose Mode

The default output only shows errors so you can focus on bigger issues. The --verbose argument allows you to see warning messages and errors during the linting process.