Installations
npm install @salesforce/eslint-plugin-auraDeveloper Guide
Typescript
No
Module System
CommonJS
Min. Node Version
>=12.0.0
Node Version
16.14.0
NPM Version
8.3.1
Score
90.9
Supply Chain
88
Quality
80
Maintenance
100
Vulnerability
96.4
License
Contributors
Unable to fetch Contributors
Languages
JavaScript (99.77%)
Shell (0.23%)
Love this project? Help keep it running — sponsor us today! 🚀
Developer
forcedotcom
Download Statistics
Total Downloads
6,628,043
Last Day
2,648
Last Week
59,208
Last Month
246,084
Last Year
2,696,095
GitHub Statistics
BSD-3-Clause License
27 Stars
61 Commits
9 Forks
11 Watchers
6 Branches
21 Contributors
Updated on Aug 16, 2023
Maintainers
Package Meta Information
Latest Version
2.1.0
Package Id
@salesforce/eslint-plugin-aura@2.1.0
Unpacked Size
72.50 kB
Size
17.94 kB
File Count
20
NPM Version
8.3.1
Node Version
16.14.0
Total Downloads
Cumulative downloads
Total Downloads
6,628,043
Last Day
-20.1%
2,648
Compared to previous day
Last Week
-10.9%
59,208
Compared to previous week
Last Month
29%
246,084
Compared to previous month
Last Year
31.3%
2,696,095
Compared to previous year
Daily Downloads
Weekly Downloads
Monthly Downloads
Yearly Downloads
Dependencies
1
Peer Dependencies
1
eslint-plugin-aura
Salesforce Lightning (Aura) specific linting rules for ESLint.
Installation
1npm 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:
1{ 2 "plugins": ["@salesforce/eslint-plugin-aura"], 3 "extends": [ 4 "plugin:@salesforce/eslint-plugin-aura/recommended", 5 "plugin:@salesforce/eslint-plugin-aura/locker" 6 ] 7}
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:
- Many of the Best Practices rules.
- Proper usage of the
$Aglobal, via theaura-apirule. - Browser compatibility rules for Salesforce supported browsers.
@salesforce/eslint-plugin-aura/locker configuration
Goal: Prevent Lightning Locker violations.
Rules:
@salesforce/eslint-plugin-aura/recommendedrules.- Proper usage of
documentandwindowvia thesecure-documentandsecure-windowrules, respectively. - Proper usage of Javascript intrinsic APIs via the
ecma-intrinsicsrule.
No vulnerabilities found.
Reason
no binaries found in the repo
Reason
license file detected
Details
- Info: project has a license file: LICENSE:0
- Info: FSF or OSI recognized license: BSD 3-Clause "New" or "Revised" License: LICENSE:0
Reason
security policy file detected
Details
- Info: security policy file detected: github.com/forcedotcom/.github/SECURITY.md:1
- Info: Found linked content: github.com/forcedotcom/.github/SECURITY.md:1
- Warn: One or no descriptive hints of disclosure, vulnerability, and/or timelines in security policy
- Info: Found text in security policy: github.com/forcedotcom/.github/SECURITY.md:1
Reason
Found 11/15 approved changesets -- score normalized to 7
Reason
8 existing vulnerabilities detected
Details
- Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg
- Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
- Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv
- Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3
- Warn: Project is vulnerable to: GHSA-mwcw-c2x4-8c55
- Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw
- Warn: Project is vulnerable to: GHSA-76p7-773f-r4q5
- Warn: Project is vulnerable to: GHSA-j8xg-fqg3-53r7
Reason
0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Reason
SAST tool is not run on all commits -- score normalized to 0
Details
- Warn: 0 commits out of 26 are checked with a SAST tool
Score
4.2
/10
Last Scanned on 2025-02-10
The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.
Learn More