README.md

@salesforce/eslint-plugin-slds-react

This rule aims to better align React UI component libraries that depend on the Salesforce Lightning Design System CSS Framework.

You'll first need to install ESLint:

$ npm i eslint --save-dev

Next, install @salesforce/eslint-plugin-slds-react:

$ npm install @salesforce/eslint-plugin-slds-react --save-dev

Note: If you installed ESLint globally (using the -g flag) then you must also install @salesforce/eslint-plugin-slds-react globally.

Add @salesforce/eslint-plugin-slds-react to the plugins section of your .eslintrc configuration file. You can omit the eslint-plugin- prefix:

{
	"plugins": ["@salesforce/eslint-plugin-slds-react"]
}

Then configure the rules you want to use under the rules section.

{
	"rules": {
		"slds-react/rule-no-double-dash-modifier": 2
	}
}