Lightning Aura Components Developer Guide

What Is the Lightning Component Framework?
Quick Start
Creating Components
Component Names
Create Aura Components in the Developer Console
Create Aura Components Using Salesforce CLI
Component Markup
Component Namespace
Component Bundles
Component IDs
HTML in Components
CSS in Components
Component Attributes
Using Expressions
Component Composition
Component Body
Component Facets
Controlling Access
Using Object-Oriented Development
Best Practices for Conditional Markup
Aura Component Versioning for Managed Packages
Base Components with Minimum API Version Requirements
Validations for Aura Component Code
Validation When You Save Code Changes
Validation During Development Using the Salesforce CLI
Use force:lightning:lint
force:lightning:lint Options
Custom “House Style” Rules
Review and Resolve Validation Errors and Warnings
Aura Component Validation Rules
Salesforce Lightning CLI (Deprecated)
Using Labels
Localization
Working with Base Lightning Components
Supporting Accessibility
Writing Documentation for the Component Library
Using Components
Communicating with Events
Communicating Across the DOM with Lightning Message Service
Creating Apps
Styling Apps
Developing Secure Code
Using JavaScript
Working with Salesforce Data
Testing Components with Lightning Testing Service
Debugging
Performance
Reference
PDF

Newer Version Available

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

Use force:lightning:lint

Run force:lightning:lint just like any other lint command-line tool. The only trick is invoking it through the sfdx command. Your shell window shows the results.

Normal Use

You can run the force:lightning:lint lint tool on any folder that contains Aura components:

1sfdx force:lightning:lint ./path/to/lightning/components/

force:lightning:lint runs only on local files. Use Salesforce DX or third-party tools to download your component code to your machine. Options include Salesforce CLI commands like force:mdapi:retrieve and force:source:pull, or other tools such as the Salesforce Extensions for Visual Studio Code, the Ant 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 Validation Errors and Warnings” for what to do with the output of running force:lightning:lint.