Salesforce Lightning (Aura) specific linting rules for ESLint.
npm install --save-dev @salesforce/eslint-plugin-aura
Add this plugin to your ESLint configuration and extend your desired configuration. See ESLint documentation for details.
Example:
{
"plugins": ["@salesforce/eslint-plugin-aura"],
"extends": [
"plugin:@salesforce/eslint-plugin-aura/recommended",
"plugin:@salesforce/eslint-plugin-aura/locker"
]
}
Rule ID | Description |
---|---|
aura/aura-api | validate Aura APIs |
aura/getevt-markup-prefix | verify the presence of the markup:// prefix for events accessed via $A.getEvt() |
aura/no-deprecated-aura-error | prevent usage of $A.error |
aura/no-deprecated-component-creation | prevent usage of deprecated component creation methods |
aura/no-deprecated-event-creation | prevent usage of deprecated event creation methods |
Rule ID | Description |
---|---|
aura/ecma-intrinsics | validate JavaScript intrinsic APIs |
aura/secure-document | validate secure document public APIs |
aura/secure-window | validate secure window public APIs |
This package exposes 2 configurations for your usage.
@salesforce/eslint-plugin-aura/recommended
configurationGoal: Prevent common pitfalls with Lightning component development, and enforce other Salesforce platform restrictions.
Rules:
$A
global, via the aura-api
rule.@salesforce/eslint-plugin-aura/locker
configurationGoal: Prevent Lightning Locker violations.
Rules:
@salesforce/eslint-plugin-aura/recommended
rules.document
and window
via the secure-document
and secure-window
rules, respectively.ecma-intrinsics
rule.