Registry / testing / eslint-config-salesforce

eslint-config-salesforce

library2.2.1jsnpmunverified

Official ESLint configuration for Salesforce projects. Provides a set of rules for JavaScript linting, including import restrictions and JSDoc enforcement. Current stable version 2.2.1, released October 2023. Requires eslint, eslint-plugin-import, and eslint-plugin-jsdoc as peer dependencies. Differentiates from generic configs by enforcing Salesforce-specific coding standards, such as no-param-reassign and restrictions on relative imports in lib directories. For TypeScript, use eslint-config-salesforce-typescript instead.

testing

npm install eslint-config-salesforce

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · ESLINT-CONFIG-SALE

eslint-config-salesforce

testingjavascriptv2.2.1

Install

—

Import

—

Disk

—

Pass rate

0/ 6

Env Coverage0 / 6

glibc

18–22

musl

18–22

Install & Compatibility

Where this runs

tested against v? · npm install

Install × environment matrix

Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux

musl

node 18–226 runs

build_error

glibc

node 18–226 runs

build_error

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

eslint-config-salesforce

✓ extends: ['eslint-config-salesforce']

✗ extends: ['salesforce']

In .eslintrc, use the full package name.

eslint-config-salesforce-license

✓ extends: ['eslint-config-salesforce-license']

Additional config for Salesforce repos, not included by default.

eslint-config-salesforce-typescript

✓ extends: ['eslint-config-salesforce-typescript']

✗ extends: ['eslint-config-salesforce'] with TypeScript

Use separate config for TypeScript projects; this one is for JavaScript.

Basic setup extending the Salesforce ESLint config in a JavaScript project.

// .eslintrc.js module.exports = { extends: ['eslint-config-salesforce'], }; // Install required packages: // npm install --save-dev eslint eslint-plugin-import eslint-plugin-jsdoc eslint-config-salesforce

Debug

Known issues

breakingIn v1.1.0, removed eslint-plugin-prettier and added eslint-config-prettier. Existing configs relying on prettier rules may break.

fix

If you use Prettier, add eslint-config-prettier to your extends array and remove any eslint-plugin-prettier references.

affects: >=1.1.0

gotchaThis config is for JavaScript only. Using it with TypeScript will cause issues.

fix

For TypeScript projects, use eslint-config-salesforce-typescript instead.

affects: >=1.0.0

deprecatedIn v2.0.1, removed the rule 'jsdoc/newline-after-description'. If your codebase relies on it, you must add it manually.

fix

Add 'jsdoc/newline-after-description': 'off' to your overrides or revert to an older version.

affects: >=2.0.1

gotchaThe config enforces import restrictions (lib/, non-relative src) which may cause false positives in monorepo setups.

fix

Override rules in your .eslintrc if the restrictions are too strict for your project structure.

affects: >=1.2.0

Errors

Common errors & fixes

Error: Failed to load plugin 'import' declared in 'eslint-config-salesforce': Cannot find module 'eslint-plugin-import'

eslint-plugin-import not installed

fix

npm install --save-dev eslint-plugin-import

Error: Failed to load plugin 'jsdoc' declared in 'eslint-config-salesforce': Cannot find module 'eslint-plugin-jsdoc'

eslint-plugin-jsdoc not installed

fix

npm install --save-dev eslint-plugin-jsdoc

Upgrade

Version history

2.2.1latest on npm

Audit

Dependencies

eslintrequiredpeer dependency for linting

eslint-plugin-importrequiredpeer dependency for import rules

eslint-plugin-jsdocrequiredpeer dependency for JSDoc rules

Agent activity

4 hits · last 30 days

node

Resources

githubhttps://github.com/forcedotcom/eslint-config-salesforce ↗

packagehttps://www.npmjs.com/package/eslint-config-salesforce ↗

homepagehttps://developer.salesforce.com/docs/atlas.en-us.sfdx_dev.meta/sfdx_dev/sfdx_dev_dev_lint.htm ↗