Skip to content

Commit f670699

Browse files
Update eslint-plugin-slds-react name and description
1 parent adf6058 commit f670699

File tree

3 files changed

+19
-20
lines changed

3 files changed

+19
-20
lines changed

eslint-plugin/README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# eslint-plugin-slds-bem-deprecation-react
1+
# @salesforce/eslint-plugin-slds-react
22

3-
This rule aims to better align JavaScirpt UI component libraries that depend on the Salesforce Lightning Design System CSS Framwork.
3+
This rule aims to better align React UI component libraries that depend on the Salesforce Lightning Design System CSS Framework.
44

55
## Installation
66

@@ -10,21 +10,21 @@ You'll first need to install [ESLint](http://eslint.org):
1010
$ npm i eslint --save-dev
1111
```
1212

13-
Next, install `@salesforce/eslint-plugin-slds-bem-deprecation-react`:
13+
Next, install `@salesforce/eslint-plugin-slds-react`:
1414

1515
```
16-
$ npm install @salesforce/eslint-plugin-slds-bem-deprecation-react --save-dev
16+
$ npm install @salesforce/eslint-plugin-slds-react --save-dev
1717
```
1818

19-
**Note:** If you installed ESLint globally (using the `-g` flag) then you must also install `@salesforce/eslint-plugin-slds-bem-deprecation-react` globally.
19+
**Note:** If you installed ESLint globally (using the `-g` flag) then you must also install `@salesforce/eslint-plugin-slds-react` globally.
2020

2121
## Usage
2222

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

2525
```json
2626
{
27-
"plugins": ["@salesforce/eslint-plugin-slds-bem-deprecation-react"]
27+
"plugins": ["@salesforce/eslint-plugin-slds-react"]
2828
}
2929
```
3030

@@ -33,11 +33,11 @@ Then configure the rules you want to use under the rules section.
3333
```json
3434
{
3535
"rules": {
36-
"design-system-react/rule-name": 2
36+
"slds-react/rule-no-double-dash-modifier": 2
3737
}
3838
}
3939
```
4040

4141
## Supported Rules
4242

43-
* Fill in provided rules here
43+
* `no-double-dash-modifier`
Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,27 @@
1-
# Warns against using the deprecated, double-dash style for BEM notation. See https://releasenotes.docs.salesforce.com/en-us/summer17/release-notes/rn_lds.htm. (no-double-dash-modifier)
2-
3-
Please describe the origin of the rule here.
1+
# No Double Dash BEM Modifier
42

3+
Warns against using the deprecated, double-dash style for BEM notation. See https://releasenotes.docs.salesforce.com/en-us/summer17/release-notes/rn_lds.htm. (no-double-dash-modifier)
54

65
## Rule Details
76

8-
This rule aims to better align JavaScirpt UI component libraries that depend on the Salesforce Lightning Design System CSS Framwork.
7+
This rule aims to better align JavaScirpt UI component libraries that depend on the Salesforce Lightning Design System CSS Framework.
98

10-
Examples of **incorrect** code for this rule:
9+
Examples of **incorrect** JSX for this rule:
1110

12-
```js
11+
```html
1312
<div className="slds-theme--default">
1413
<h3 className="slds-text-heading--label">Heading</h3>
1514
</div>
1615
```
1716

18-
Examples of **correct** code for this rule:
17+
Examples of **correct** JSX for this rule:
1918

20-
```js
19+
```html
2120
<div className="slds-theme_default">
2221
<h3 className="slds-text-heading_label">Heading</h3>
2322
</div>
2423
```
2524

2625
## Further Reading
2726

28-
This code is located within the [Design System React](https://github.com/salesforce/design-system-react) repository. Please create issues there.
27+
This code is located within the [Design System React](https://github.com/salesforce/design-system-react) repository. Please create issues there.

eslint-plugin/package.json.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
2-
"name": "eslint-plugin-slds-bem-deprecation-react",
2+
"name": "eslint-plugin-slds-react",
33
"version": "0.0.0",
4-
"description": "ESLint plugin. This rule aims to better align JavaScirpt UI component libraries that depend on the Salesforce Lightning Design System CSS Framwork.",
4+
"description": "ESLint plugin that aligns React UI components with the Salesforce Lightning Design System CSS Framework.",
55
"keywords": [
66
"eslint",
77
"eslintplugin",

0 commit comments

Comments
 (0)