@salesforce-ux/eslint-plugin-slds 0.5.0 → 0.5.1

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.
Files changed (2) hide show
  1. package/README.md +13 -14
  2. package/package.json +2 -2
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
- ## Configuration
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
- ## Migration Note
45
+ ## Migrate to the Latest Version
46
46
 
47
- > Always import the plugin from the root (`@salesforce-ux/eslint-plugin-slds`).
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`: Enforces proper BEM methodology usage
53
- - `no-deprecated-classes-slds2`: Prevents usage of deprecated SLDS classes
54
- - `modal-close-button-issue`: Ensures proper modal close button implementation
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
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@salesforce-ux/eslint-plugin-slds",
3
- "version": "0.5.0",
3
+ "version": "0.5.1",
4
4
  "main": "build/index.js",
5
5
  "exports": {
6
6
  ".": {
@@ -34,7 +34,7 @@
34
34
  "dependencies": {
35
35
  "@html-eslint/eslint-plugin": "^0.34.0",
36
36
  "@html-eslint/parser": "^0.34.0",
37
- "@salesforce-ux/sds-metadata": "^0.3.2"
37
+ "@salesforce-ux/sds-metadata": "^0.3.3"
38
38
  },
39
39
  "peerDependencies": {
40
40
  "eslint": "^8.0.0 || ^9.0.0"