@salesforce-ux/eslint-plugin-slds 0.5.0-internal → 0.5.1-internal
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +13 -14
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -2,18 +2,18 @@
|
|
|
2
2
|
|
|
3
3
|
ESLint plugin provides custom linting rules specifically built for Salesforce Lightning Design System 2 (SLDS 2 beta).
|
|
4
4
|
|
|
5
|
-
## Installation
|
|
6
|
-
|
|
7
|
-
```bash
|
|
8
|
-
npm install @salesforce-ux/eslint-plugin-slds --save-dev
|
|
9
|
-
```
|
|
10
|
-
|
|
11
5
|
## Requirements
|
|
12
6
|
|
|
13
7
|
- **Node.js**: 18.18.0 or higher
|
|
14
8
|
- **ESLint**: 8.0.0 or 9.0.0+
|
|
15
9
|
|
|
16
|
-
##
|
|
10
|
+
## Install
|
|
11
|
+
|
|
12
|
+
```bash
|
|
13
|
+
npm install @salesforce-ux/eslint-plugin-slds --save-dev
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
## Configure
|
|
17
17
|
|
|
18
18
|
### ESLint v8 (Legacy Config)
|
|
19
19
|
|
|
@@ -42,16 +42,15 @@ module.exports = defineConfig([
|
|
|
42
42
|
]);
|
|
43
43
|
```
|
|
44
44
|
|
|
45
|
-
##
|
|
45
|
+
## Migrate to the Latest Version
|
|
46
46
|
|
|
47
|
-
|
|
48
|
-
> The plugin automatically supports both legacy and flat config systems.
|
|
47
|
+
By default, the latest version of the plugin supports legacy and flat config systems.
|
|
49
48
|
|
|
50
|
-
## Rules
|
|
49
|
+
## Supported Rules
|
|
51
50
|
|
|
52
|
-
- `enforce-bem-usage`:
|
|
53
|
-
- `no-deprecated-classes-slds2`:
|
|
54
|
-
- `modal-close-button-issue`:
|
|
51
|
+
- `enforce-bem-usage`: Identifies instances that use the double-dash (--) syntax for block-element-modifier (BEM) in classes.
|
|
52
|
+
- `no-deprecated-classes-slds2`: Identifies classes that aren’t available in SLDS 2.
|
|
53
|
+
- `modal-close-button-issue`: Identifies instances where the CSS classes or component attributes for the modal close button must be changed to follow the modal component blueprint.
|
|
55
54
|
|
|
56
55
|
## License
|
|
57
56
|
|