@salesforce/eslint-plugin-aura

2.1.0 • Public • Published

eslint-plugin-aura

Build status NPM version

Salesforce Lightning (Aura) specific linting rules for ESLint.

Installation

npm install --save-dev @salesforce/eslint-plugin-aura

Usage

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"
  ]
}

Rules

Aura

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

Locker

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

Configurations

This package exposes 2 configurations for your usage.

@salesforce/eslint-plugin-aura/recommended configuration

Goal: Prevent common pitfalls with Lightning component development, and enforce other Salesforce platform restrictions.

Rules:

@salesforce/eslint-plugin-aura/locker configuration

Goal: Prevent Lightning Locker violations.

Rules:

  • @salesforce/eslint-plugin-aura/recommended rules.
  • Proper usage of document and window via the secure-document and secure-window rules, respectively.
  • Proper usage of Javascript intrinsic APIs via the ecma-intrinsics rule.

Readme

Keywords

Package Sidebar

Install

npm i @salesforce/eslint-plugin-aura

Weekly Downloads

52,280

Version

2.1.0

License

BSD-3-Clause

Unpacked Size

74.2 kB

Total Files

20

Last publish

Collaborators

  • dme722
  • nolanlawson
  • ire-npm-team-user
  • jburnie
  • abirchfieldsfdc
  • dlouvton
  • mobify
  • jmsjtu
  • jasonschroeder-sfdc
  • packagellama
  • maward
  • danielshox
  • duane.chew
  • dferro
  • jcourtner
  • jye-sf
  • adirasanam
  • hkii
  • iamaziz
  • dbreese-salesforce
  • ashokrudraraju
  • dhersam
  • demianbrecht
  • mbettio
  • damilareolowoniyi
  • mmadialagan
  • mjrust
  • salesforce-releases
  • mpsenn
  • kevinv11n
  • byao
  • pmdartus
  • ekashida
  • gr8gatsby
  • ravi.jayaramappa
  • apapko
  • jleen-sfdc
  • jqian
  • cwallsf
  • dhagberg-sf
  • khawkins
  • amphro
  • jodarove
  • sfdctaka
  • fernomac
  • jimjag
  • ivarley
  • jbartolotta-sfdc