@salesforce-ux/eslint-plugin-slds 1.0.8-internal → 1.0.10-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/build/config/rule-messages.d.ts +2 -0
- package/build/config/rule-messages.js +197 -0
- package/build/config/rule-messages.js.map +7 -0
- package/build/index.js +77 -2459
- package/build/index.js.map +4 -4
- package/build/rules/enforce-bem-usage.js +16 -232
- package/build/rules/enforce-bem-usage.js.map +4 -4
- package/build/rules/modal-close-button-issue.js +11 -183
- package/build/rules/modal-close-button-issue.js.map +4 -4
- package/build/rules/no-deprecated-classes-slds2.js +4 -176
- package/build/rules/no-deprecated-classes-slds2.js.map +4 -4
- package/build/rules/v9/enforce-bem-usage.js +1 -161
- package/build/rules/v9/enforce-bem-usage.js.map +4 -4
- package/build/rules/v9/enforce-component-hook-naming-convention.js +1 -161
- package/build/rules/v9/enforce-component-hook-naming-convention.js.map +4 -4
- package/build/rules/v9/enforce-sds-to-slds-hooks.js +1 -161
- package/build/rules/v9/enforce-sds-to-slds-hooks.js.map +4 -4
- package/build/rules/v9/lwc-token-to-slds-hook.js +4 -262
- package/build/rules/v9/lwc-token-to-slds-hook.js.map +4 -4
- package/build/rules/v9/no-deprecated-slds-classes.js +1 -161
- package/build/rules/v9/no-deprecated-slds-classes.js.map +4 -4
- package/build/rules/v9/no-deprecated-tokens-slds1.js +29 -168
- package/build/rules/v9/no-deprecated-tokens-slds1.js.map +4 -4
- package/build/rules/v9/no-hardcoded-values/handlers/boxShadowHandler.js +9 -289
- package/build/rules/v9/no-hardcoded-values/handlers/boxShadowHandler.js.map +4 -4
- package/build/rules/v9/no-hardcoded-values/handlers/colorHandler.js +13 -283
- package/build/rules/v9/no-hardcoded-values/handlers/colorHandler.js.map +4 -4
- package/build/rules/v9/no-hardcoded-values/handlers/densityHandler.js +12 -328
- package/build/rules/v9/no-hardcoded-values/handlers/densityHandler.js.map +4 -4
- package/build/rules/v9/no-hardcoded-values/handlers/fontHandler.js +13 -309
- package/build/rules/v9/no-hardcoded-values/handlers/fontHandler.js.map +4 -4
- package/build/rules/v9/no-hardcoded-values/handlers/index.js +8 -875
- package/build/rules/v9/no-hardcoded-values/handlers/index.js.map +4 -4
- package/build/rules/v9/no-hardcoded-values/no-hardcoded-values-slds1.js +3 -1208
- package/build/rules/v9/no-hardcoded-values/no-hardcoded-values-slds1.js.map +4 -4
- package/build/rules/v9/no-hardcoded-values/no-hardcoded-values-slds2.js +3 -1208
- package/build/rules/v9/no-hardcoded-values/no-hardcoded-values-slds2.js.map +4 -4
- package/build/rules/v9/no-hardcoded-values/noHardcodedValueRule.js +22 -993
- package/build/rules/v9/no-hardcoded-values/noHardcodedValueRule.js.map +4 -4
- package/build/rules/v9/no-slds-class-overrides.js +1 -161
- package/build/rules/v9/no-slds-class-overrides.js.map +4 -4
- package/build/rules/v9/no-slds-namespace-for-custom-hooks.js +3 -252
- package/build/rules/v9/no-slds-namespace-for-custom-hooks.js.map +4 -4
- package/build/rules/v9/no-slds-private-var.js +1 -161
- package/build/rules/v9/no-slds-private-var.js.map +4 -4
- package/build/rules/v9/no-slds-var-without-fallback.js +3 -255
- package/build/rules/v9/no-slds-var-without-fallback.js.map +4 -4
- package/build/rules/v9/no-sldshook-fallback-for-lwctoken.js +1 -161
- package/build/rules/v9/no-sldshook-fallback-for-lwctoken.js.map +4 -4
- package/build/rules/v9/no-unsupported-hooks-slds2.js +1 -161
- package/build/rules/v9/no-unsupported-hooks-slds2.js.map +4 -4
- package/build/rules/v9/reduce-annotations.js +1 -161
- package/build/rules/v9/reduce-annotations.js.map +4 -4
- package/build/{src/utils → utils}/boxShadowValueParser.d.ts +1 -1
- package/build/utils/boxShadowValueParser.js +63 -93
- package/build/utils/boxShadowValueParser.js.map +4 -4
- package/build/utils/color-lib-utils.js +2 -29
- package/build/utils/color-lib-utils.js.map +3 -3
- package/build/{src/utils → utils}/css-utils.d.ts +7 -0
- package/build/utils/css-utils.js +10 -71
- package/build/utils/css-utils.js.map +4 -4
- package/build/utils/hardcoded-shared-utils.js +17 -82
- package/build/utils/hardcoded-shared-utils.js.map +4 -4
- package/build/utils/property-matcher.js +2 -2
- package/build/utils/property-matcher.js.map +2 -2
- package/build/utils/styling-hook-utils.js +16 -39
- package/build/utils/styling-hook-utils.js.map +3 -3
- package/build/{src/utils → utils}/value-utils.d.ts +2 -2
- package/build/utils/value-utils.js +8 -8
- package/build/utils/value-utils.js.map +2 -2
- package/package.json +5 -10
- package/src/config/rule-messages.yml +0 -143
- /package/build/{src/index.d.ts → index.d.ts} +0 -0
- /package/build/{src/rules → rules}/enforce-bem-usage.d.ts +0 -0
- /package/build/{src/rules → rules}/modal-close-button-issue.d.ts +0 -0
- /package/build/{src/rules → rules}/no-deprecated-classes-slds2.d.ts +0 -0
- /package/build/{src/rules → rules}/v9/enforce-bem-usage.d.ts +0 -0
- /package/build/{src/rules → rules}/v9/enforce-component-hook-naming-convention.d.ts +0 -0
- /package/build/{src/rules → rules}/v9/enforce-sds-to-slds-hooks.d.ts +0 -0
- /package/build/{src/rules → rules}/v9/lwc-token-to-slds-hook.d.ts +0 -0
- /package/build/{src/rules → rules}/v9/no-deprecated-slds-classes.d.ts +0 -0
- /package/build/{src/rules → rules}/v9/no-deprecated-tokens-slds1.d.ts +0 -0
- /package/build/{src/rules → rules}/v9/no-hardcoded-values/handlers/boxShadowHandler.d.ts +0 -0
- /package/build/{src/rules → rules}/v9/no-hardcoded-values/handlers/colorHandler.d.ts +0 -0
- /package/build/{src/rules → rules}/v9/no-hardcoded-values/handlers/densityHandler.d.ts +0 -0
- /package/build/{src/rules → rules}/v9/no-hardcoded-values/handlers/fontHandler.d.ts +0 -0
- /package/build/{src/rules → rules}/v9/no-hardcoded-values/handlers/index.d.ts +0 -0
- /package/build/{src/rules → rules}/v9/no-hardcoded-values/no-hardcoded-values-slds1.d.ts +0 -0
- /package/build/{src/rules → rules}/v9/no-hardcoded-values/no-hardcoded-values-slds2.d.ts +0 -0
- /package/build/{src/rules → rules}/v9/no-hardcoded-values/noHardcodedValueRule.d.ts +0 -0
- /package/build/{src/rules → rules}/v9/no-hardcoded-values/ruleOptionsSchema.d.ts +0 -0
- /package/build/{src/rules → rules}/v9/no-slds-class-overrides.d.ts +0 -0
- /package/build/{src/rules → rules}/v9/no-slds-namespace-for-custom-hooks.d.ts +0 -0
- /package/build/{src/rules → rules}/v9/no-slds-private-var.d.ts +0 -0
- /package/build/{src/rules → rules}/v9/no-slds-var-without-fallback.d.ts +0 -0
- /package/build/{src/rules → rules}/v9/no-sldshook-fallback-for-lwctoken.d.ts +0 -0
- /package/build/{src/rules → rules}/v9/no-unsupported-hooks-slds2.d.ts +0 -0
- /package/build/{src/rules → rules}/v9/reduce-annotations.d.ts +0 -0
- /package/build/{src/types → types}/index.d.ts +0 -0
- /package/build/{src/utils → utils}/color-lib-utils.d.ts +0 -0
- /package/build/{src/utils → utils}/css-functions.d.ts +0 -0
- /package/build/{src/utils → utils}/custom-mapping-utils.d.ts +0 -0
- /package/build/{src/utils → utils}/hardcoded-shared-utils.d.ts +0 -0
- /package/build/{src/utils → utils}/node.d.ts +0 -0
- /package/build/{src/utils → utils}/property-matcher.d.ts +0 -0
- /package/build/{src/utils → utils}/rule-utils.d.ts +0 -0
- /package/build/{src/utils → utils}/styling-hook-utils.d.ts +0 -0
|
@@ -4,9 +4,6 @@ var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
|
|
|
4
4
|
var __getOwnPropNames = Object.getOwnPropertyNames;
|
|
5
5
|
var __getProtoOf = Object.getPrototypeOf;
|
|
6
6
|
var __hasOwnProp = Object.prototype.hasOwnProperty;
|
|
7
|
-
var __commonJS = (cb, mod) => function __require() {
|
|
8
|
-
return mod || (0, cb[__getOwnPropNames(cb)[0]])((mod = { exports: {} }).exports, mod), mod.exports;
|
|
9
|
-
};
|
|
10
7
|
var __copyProps = (to, from, except, desc) => {
|
|
11
8
|
if (from && typeof from === "object" || typeof from === "function") {
|
|
12
9
|
for (let key of __getOwnPropNames(from))
|
|
@@ -24,242 +21,29 @@ var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__ge
|
|
|
24
21
|
mod
|
|
25
22
|
));
|
|
26
23
|
|
|
27
|
-
// yaml-file:rule-messages.yml
|
|
28
|
-
var require_rule_messages = __commonJS({
|
|
29
|
-
"yaml-file:rule-messages.yml"(exports2, module2) {
|
|
30
|
-
module2.exports = {
|
|
31
|
-
"no-slds-class-overrides": {
|
|
32
|
-
"description": "Create new custom CSS classes instead of overriding SLDS selectors",
|
|
33
|
-
"url": "https://developer.salesforce.com/docs/platform/slds-linter/guide/reference-rules.html#no-slds-class-overrides",
|
|
34
|
-
"type": "problem",
|
|
35
|
-
"messages": {
|
|
36
|
-
"sldsClassOverride": "Overriding .{{className}} isn't supported. To differentiate SLDS and custom classes, create a CSS class in your namespace. Examples: myapp-input, myapp-button."
|
|
37
|
-
}
|
|
38
|
-
},
|
|
39
|
-
"no-deprecated-slds-classes": {
|
|
40
|
-
"description": "Please replace the deprecated classes with a modern equivalent",
|
|
41
|
-
"url": "https://developer.salesforce.com/docs/platform/slds-linter/guide/reference-rules.html#no-deprecated-slds-classes",
|
|
42
|
-
"type": "problem",
|
|
43
|
-
"messages": {
|
|
44
|
-
"deprecatedClass": "The class {{className}} is deprecated and not available in SLDS2. Please update to a supported class."
|
|
45
|
-
}
|
|
46
|
-
},
|
|
47
|
-
"no-deprecated-tokens-slds1": {
|
|
48
|
-
"description": "Update outdated design tokens to SLDS 2 styling hooks with similar values. For more information, see Styling Hooks on lightningdesignsystem.com.",
|
|
49
|
-
"url": "https://developer.salesforce.com/docs/platform/slds-linter/guide/reference-rules.html#no-deprecated-tokens-slds1",
|
|
50
|
-
"type": "problem",
|
|
51
|
-
"messages": {
|
|
52
|
-
"deprecatedToken": "Consider removing {{oldValue}} or replacing it with {{newValue}}. Set the fallback to {{oldValue}}. For more info, see Styling Hooks on lightningdesignsystem.com.",
|
|
53
|
-
"noReplacement": "Update outdated design tokens to SLDS 2 styling hooks with similar values. For more information, see Styling Hooks on lightningdesignsystem.com."
|
|
54
|
-
}
|
|
55
|
-
},
|
|
56
|
-
"enforce-sds-to-slds-hooks": {
|
|
57
|
-
"description": "Convert your existing --sds styling hooks to --slds styling hooks. See lightningdesignsystem.com for more info.",
|
|
58
|
-
"url": "https://developer.salesforce.com/docs/platform/slds-linter/guide/reference-rules.html#enforce-sds-to-slds-hooks",
|
|
59
|
-
"type": "problem",
|
|
60
|
-
"messages": {
|
|
61
|
-
"replaceSdsWithSlds": "Replace {{oldValue}} with {{suggestedMatch}} styling hook."
|
|
62
|
-
}
|
|
63
|
-
},
|
|
64
|
-
"enforce-bem-usage": {
|
|
65
|
-
"description": "Replace BEM double-dash syntax in class names with single underscore syntax",
|
|
66
|
-
"url": "https://developer.salesforce.com/docs/platform/slds-linter/guide/reference-rules.html#enforce-bem-usage",
|
|
67
|
-
"type": "problem",
|
|
68
|
-
"messages": {
|
|
69
|
-
"bemDoubleDash": "{{actual}} has been retired. Update it to the new name {{newValue}}.",
|
|
70
|
-
"fixBemNaming": "Update to correct BEM naming convention"
|
|
71
|
-
}
|
|
72
|
-
},
|
|
73
|
-
"modal-close-button-issue": {
|
|
74
|
-
"description": "Update component attributes or CSS classes for the modal close button to comply with the modal component blueprint",
|
|
75
|
-
"url": "https://developer.salesforce.com/docs/platform/slds-linter/guide/reference-rules.html#modal-close-button-issue",
|
|
76
|
-
"type": "problem",
|
|
77
|
-
"messages": {
|
|
78
|
-
"modalCloseButtonIssue": "Update component attributes or CSS classes for the modal close button to comply with the modal component blueprint.",
|
|
79
|
-
"removeClass": "Remove the slds-button_icon-inverse class from the modal close button in components that use the SLDS modal blueprint.",
|
|
80
|
-
"changeVariant": "Change the variant attribute value from bare-inverse to bare in <lightning-button-icon> or <lightning-icon>.",
|
|
81
|
-
"removeVariant": "Remove the variant attribute from the <lightning-icon> component inside the <button> element.",
|
|
82
|
-
"ensureButtonClasses": "Add or move slds-button and slds-button_icon to the class attribute of the <button> element or <lightning-button-icon> component.",
|
|
83
|
-
"ensureSizeAttribute": "To size icons properly, set the size attribute \u200Cto large in the <lightning-icon> and <lightning-button-icon> components."
|
|
84
|
-
}
|
|
85
|
-
},
|
|
86
|
-
"no-deprecated-classes-slds2": {
|
|
87
|
-
"description": "Replace classes that aren't available with SLDS 2 classes",
|
|
88
|
-
"url": "https://developer.salesforce.com/docs/platform/slds-linter/guide/reference-rules.html#no-deprecated-classes-slds2",
|
|
89
|
-
"type": "problem",
|
|
90
|
-
"messages": {
|
|
91
|
-
"deprecatedClass": "The class {{className}} isn't available in SLDS 2. Update it to a class supported in SLDS 2. See lightningdesignsystem.com for more information.",
|
|
92
|
-
"updateToModernClass": "Replace deprecated class with modern equivalent",
|
|
93
|
-
"checkDocumentation": "See lightningdesignsystem.com for SLDS 2 class alternatives"
|
|
94
|
-
}
|
|
95
|
-
},
|
|
96
|
-
"lwc-token-to-slds-hook": {
|
|
97
|
-
"description": "Replace the deprecated --lwc tokens with the latest --slds tokens. See lightningdesignsystem.com for more info.",
|
|
98
|
-
"url": "https://developer.salesforce.com/docs/platform/slds-linter/guide/reference-rules.html#lwc-token-to-slds-hook",
|
|
99
|
-
"type": "problem",
|
|
100
|
-
"messages": {
|
|
101
|
-
"errorWithReplacement": "The '{{oldValue}}' design token is deprecated. Replace it with '{{newValue}}'. For more info, see Global Styling Hooks on lightningdesignsystem.com.",
|
|
102
|
-
"errorWithStyleHooks": "The '{{oldValue}}' design token is deprecated. Replace it with the SLDS 2 '{{newValue}}' styling hook and set the fallback to '{{oldValue}}'. For more info, see Global Styling Hooks on lightningdesignsystem.com.",
|
|
103
|
-
"errorWithNoRecommendation": "The '{{oldValue}}' design token is deprecated. For more info, see the New Global Styling Hook Guidance on lightningdesignsystem.com."
|
|
104
|
-
}
|
|
105
|
-
},
|
|
106
|
-
"no-sldshook-fallback-for-lwctoken": {
|
|
107
|
-
"description": "Avoid using --slds styling hooks as fallback values for --lwc tokens.",
|
|
108
|
-
"url": "https://developer.salesforce.com/docs/platform/slds-linter/guide/reference-rules.html#no-sldshook-fallback-for-lwctoken",
|
|
109
|
-
"type": "problem",
|
|
110
|
-
"messages": {
|
|
111
|
-
"unsupportedFallback": "Remove the {{sldsToken}} styling hook that is used as a fallback value for {{lwcToken}}."
|
|
112
|
-
}
|
|
113
|
-
},
|
|
114
|
-
"no-unsupported-hooks-slds2": {
|
|
115
|
-
"description": "Identifies styling hooks that aren't present in SLDS 2. They must be replaced with styling hooks that have a similar effect, or they must be removed.",
|
|
116
|
-
"url": "https://developer.salesforce.com/docs/platform/slds-linter/guide/reference-rules.html#no-unsupported-hooks-slds2",
|
|
117
|
-
"type": "problem",
|
|
118
|
-
"messages": {
|
|
119
|
-
"deprecated": "The {{token}} styling hook isn't present in SLDS 2 and there's no equivalent replacement. Remove it or replace it with a styling hook with a similar effect."
|
|
120
|
-
}
|
|
121
|
-
},
|
|
122
|
-
"no-slds-var-without-fallback": {
|
|
123
|
-
"description": "Add fallback values to SLDS styling hooks. The fallback values are used in Salesforce environments where styling hooks are unavailable.",
|
|
124
|
-
"url": "https://developer.salesforce.com/docs/platform/slds-linter/guide/reference-rules.html#no-slds-var-without-fallback",
|
|
125
|
-
"type": "problem",
|
|
126
|
-
"messages": {
|
|
127
|
-
"varWithoutFallback": "Your code uses the {{cssVar}} styling hook without a fallback value. Styling hooks are unavailable in some Salesforce environments. To render your component correctly in all environments, add this fallback value: var({{cssVar}}, {{recommendation}}). To make this fallback value brand-aware, use a branded design token instead of a static value. See Design Tokens on v1.lightningdesignsystem.com."
|
|
128
|
-
}
|
|
129
|
-
},
|
|
130
|
-
"no-slds-namespace-for-custom-hooks": {
|
|
131
|
-
"description": "To differentiate custom styling hooks from SLDS styling hooks, create custom styling hooks in your namespace.",
|
|
132
|
-
"url": "https://developer.salesforce.com/docs/platform/slds-linter/guide/reference-rules.html#no-slds-namespace-for-custom-hooks",
|
|
133
|
-
"type": "problem",
|
|
134
|
-
"messages": {
|
|
135
|
-
"customHookNamespace": "Using the --slds namespace for {{token}} isn't supported. Create the custom styling hook in your namespace. Example: --myapp-{{tokenWithoutNamespace}}"
|
|
136
|
-
}
|
|
137
|
-
},
|
|
138
|
-
"no-slds-private-var": {
|
|
139
|
-
"description": "Some SLDS styling hooks are private and reserved only for internal Salesforce use. Private SLDS styling hooks have prefixes --_slds- and --slds-s-. For more information, look up private CSS in lightningdesignsystem.com.",
|
|
140
|
-
"url": "https://developer.salesforce.com/docs/platform/slds-linter/guide/reference-rules.html#no-slds-private-var",
|
|
141
|
-
"type": "problem",
|
|
142
|
-
"messages": {
|
|
143
|
-
"privateVar": "This styling hook is reserved for internal Salesforce use. Remove the --_slds- or \u2013slds-s private variable within selector {{prop}}. For more information, look up private CSS in lightningdesignsystem.com."
|
|
144
|
-
}
|
|
145
|
-
},
|
|
146
|
-
"enforce-component-hook-naming-convention": {
|
|
147
|
-
"description": "Replace component styling hooks that use a deprecated naming convention.",
|
|
148
|
-
"url": "https://developer.salesforce.com/docs/platform/slds-linter/guide/reference-rules.html#enforce-component-hook-naming-convention",
|
|
149
|
-
"type": "problem",
|
|
150
|
-
"messages": {
|
|
151
|
-
"replace": "Replace the deprecated {{oldValue}} component styling hook with {{suggestedMatch}}."
|
|
152
|
-
}
|
|
153
|
-
},
|
|
154
|
-
"no-hardcoded-values-slds1": {
|
|
155
|
-
"description": "Replace static values with SLDS 1 design tokens. For more information, look up design tokens on lightningdesignsystem.com.",
|
|
156
|
-
"url": "https://developer.salesforce.com/docs/platform/slds-linter/guide/reference-rules.html#no-hardcoded-value",
|
|
157
|
-
"type": "suggestion",
|
|
158
|
-
"messages": {
|
|
159
|
-
"hardcodedValue": "Replace the {{oldValue}} static value with an SLDS 1 styling hook: {{newValue}}.",
|
|
160
|
-
"noReplacement": "There's no replacement styling hook for the {{oldValue}} static value. Remove the static value."
|
|
161
|
-
}
|
|
162
|
-
},
|
|
163
|
-
"no-hardcoded-values-slds2": {
|
|
164
|
-
"description": "Replace static values with SLDS 2 styling hooks. For more information, look up design tokens on lightningdesignsystem.com.",
|
|
165
|
-
"url": "https://developer.salesforce.com/docs/platform/slds-linter/guide/reference-rules.html#no-hardcoded-values-slds2",
|
|
166
|
-
"type": "suggestion",
|
|
167
|
-
"messages": {
|
|
168
|
-
"hardcodedValue": "Consider replacing the {{oldValue}} static value with an SLDS 2 styling hook that has a similar value: {{newValue}}.",
|
|
169
|
-
"noReplacement": "There's no replacement styling hook for the {{oldValue}} static value. Remove the static value."
|
|
170
|
-
}
|
|
171
|
-
},
|
|
172
|
-
"reduce-annotations": {
|
|
173
|
-
"description": "Remove your annotations and update your code.",
|
|
174
|
-
"url": "https://developer.salesforce.com/docs/platform/slds-linter/guide/reference-rules.html#reduce-annotations",
|
|
175
|
-
"type": "problem",
|
|
176
|
-
"messages": {
|
|
177
|
-
"removeAnnotation": "Remove this annotation and update the code to SLDS best practices. For help, file an issue at https://github.com/salesforce-ux/slds-linter/"
|
|
178
|
-
}
|
|
179
|
-
}
|
|
180
|
-
};
|
|
181
|
-
}
|
|
182
|
-
});
|
|
183
|
-
|
|
184
|
-
// src/utils/node.ts
|
|
185
|
-
var import_parser = require("@html-eslint/parser");
|
|
186
|
-
function findAttr(node, key) {
|
|
187
|
-
return node.attributes.find(
|
|
188
|
-
(attr) => attr.key && attr.key.value.toLowerCase() === key.toLowerCase()
|
|
189
|
-
);
|
|
190
|
-
}
|
|
191
|
-
function isAttributesEmpty(node) {
|
|
192
|
-
return !node.attributes || node.attributes.length <= 0;
|
|
193
|
-
}
|
|
194
|
-
var lineBreakPattern = /\r\n|[\r\n\u2028\u2029]/u;
|
|
195
|
-
var lineEndingPattern = new RegExp(lineBreakPattern.source, "gu");
|
|
196
|
-
|
|
197
24
|
// src/rules/enforce-bem-usage.ts
|
|
198
|
-
var
|
|
199
|
-
var import_rule_messages2 = __toESM(require_rule_messages());
|
|
200
|
-
|
|
201
|
-
// src/rules/v9/enforce-bem-usage.ts
|
|
25
|
+
var import_node = require("../utils/node");
|
|
202
26
|
var import_next = __toESM(require("@salesforce-ux/sds-metadata/next"));
|
|
203
|
-
var import_rule_messages = __toESM(
|
|
204
|
-
var
|
|
27
|
+
var import_rule_messages = __toESM(require("../config/rule-messages"));
|
|
28
|
+
var import_enforce_bem_usage = __toESM(require("./v9/enforce-bem-usage"));
|
|
205
29
|
var bemMapping = import_next.default.bemNaming;
|
|
206
|
-
var
|
|
207
|
-
|
|
208
|
-
|
|
209
|
-
docs: {
|
|
210
|
-
description,
|
|
211
|
-
recommended: true,
|
|
212
|
-
url
|
|
213
|
-
},
|
|
214
|
-
fixable: "code",
|
|
215
|
-
messages
|
|
216
|
-
},
|
|
217
|
-
create(context) {
|
|
218
|
-
return {
|
|
219
|
-
// Check all class selectors for BEM usage
|
|
220
|
-
"SelectorList Selector ClassSelector"(node) {
|
|
221
|
-
const cssClassSelector = context.sourceCode.getText(node);
|
|
222
|
-
const className = cssClassSelector.substring(1);
|
|
223
|
-
if (className && className in bemMapping) {
|
|
224
|
-
const newValue = bemMapping[className];
|
|
225
|
-
if (typeof newValue === "string") {
|
|
226
|
-
context.report({
|
|
227
|
-
node,
|
|
228
|
-
messageId: "bemDoubleDash",
|
|
229
|
-
data: {
|
|
230
|
-
actual: className,
|
|
231
|
-
newValue
|
|
232
|
-
},
|
|
233
|
-
fix(fixer) {
|
|
234
|
-
return fixer.replaceText(node, `.${newValue}`);
|
|
235
|
-
}
|
|
236
|
-
});
|
|
237
|
-
}
|
|
238
|
-
}
|
|
239
|
-
}
|
|
240
|
-
};
|
|
241
|
-
}
|
|
242
|
-
};
|
|
243
|
-
|
|
244
|
-
// src/rules/enforce-bem-usage.ts
|
|
245
|
-
var bemMapping2 = import_next2.default.bemNaming;
|
|
246
|
-
var deprecatedClasses = import_next2.default.deprecatedClasses;
|
|
247
|
-
var ruleConfig = import_rule_messages2.default["enforce-bem-usage"];
|
|
248
|
-
var { type: type2, description: description2, url: url2, messages: messages2 } = ruleConfig;
|
|
30
|
+
var deprecatedClasses = import_next.default.deprecatedClasses;
|
|
31
|
+
var ruleConfig = import_rule_messages.default["enforce-bem-usage"];
|
|
32
|
+
var { type, description, url, messages } = ruleConfig;
|
|
249
33
|
var isDeprecatedClass = (className) => {
|
|
250
|
-
return deprecatedClasses.includes(className) || deprecatedClasses.includes(
|
|
34
|
+
return deprecatedClasses.includes(className) || deprecatedClasses.includes(bemMapping[className]);
|
|
251
35
|
};
|
|
252
36
|
var enforceBemUsageHtml = {
|
|
253
37
|
create(context) {
|
|
254
38
|
function check(node) {
|
|
255
|
-
if (isAttributesEmpty(node)) {
|
|
39
|
+
if ((0, import_node.isAttributesEmpty)(node)) {
|
|
256
40
|
return;
|
|
257
41
|
}
|
|
258
|
-
const classAttr = findAttr(node, "class");
|
|
42
|
+
const classAttr = (0, import_node.findAttr)(node, "class");
|
|
259
43
|
if (classAttr && classAttr.value) {
|
|
260
44
|
const classNames = classAttr.value.value.split(/\s+/);
|
|
261
45
|
classNames.forEach((className) => {
|
|
262
|
-
if (className && className in
|
|
46
|
+
if (className && className in bemMapping && !isDeprecatedClass(className)) {
|
|
263
47
|
const classNameStart = classAttr.value.value.indexOf(className) + 7;
|
|
264
48
|
const classNameEnd = classNameStart + className.length;
|
|
265
49
|
const startLoc = {
|
|
@@ -270,7 +54,7 @@ var enforceBemUsageHtml = {
|
|
|
270
54
|
line: classAttr.loc.start.line,
|
|
271
55
|
column: classAttr.loc.start.column + classNameEnd
|
|
272
56
|
};
|
|
273
|
-
const newValue =
|
|
57
|
+
const newValue = bemMapping[className];
|
|
274
58
|
context.report({
|
|
275
59
|
node,
|
|
276
60
|
loc: { start: startLoc, end: endLoc },
|
|
@@ -304,20 +88,20 @@ var enforceBemUsageHtml = {
|
|
|
304
88
|
};
|
|
305
89
|
var enforceBemUsage = {
|
|
306
90
|
meta: {
|
|
307
|
-
type
|
|
91
|
+
type,
|
|
308
92
|
docs: {
|
|
309
93
|
recommended: true,
|
|
310
|
-
description
|
|
311
|
-
url
|
|
94
|
+
description,
|
|
95
|
+
url
|
|
312
96
|
},
|
|
313
97
|
fixable: "code",
|
|
314
|
-
messages
|
|
98
|
+
messages
|
|
315
99
|
},
|
|
316
100
|
create(context) {
|
|
317
101
|
const filename = context.filename || context.getFilename();
|
|
318
102
|
if (filename.endsWith(".css") || filename.endsWith(".scss")) {
|
|
319
103
|
try {
|
|
320
|
-
return
|
|
104
|
+
return import_enforce_bem_usage.default.create(context);
|
|
321
105
|
} catch (error) {
|
|
322
106
|
return {};
|
|
323
107
|
}
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"version": 3,
|
|
3
|
-
"sources": ["
|
|
4
|
-
"sourcesContent": ["module.exports = {\n \"no-slds-class-overrides\": {\n \"description\": \"Create new custom CSS classes instead of overriding SLDS selectors\",\n \"url\": \"https://developer.salesforce.com/docs/platform/slds-linter/guide/reference-rules.html#no-slds-class-overrides\",\n \"type\": \"problem\",\n \"messages\": {\n \"sldsClassOverride\": \"Overriding .{{className}} isn't supported. To differentiate SLDS and custom classes, create a CSS class in your namespace. Examples: myapp-input, myapp-button.\"\n }\n },\n \"no-deprecated-slds-classes\": {\n \"description\": \"Please replace the deprecated classes with a modern equivalent\",\n \"url\": \"https://developer.salesforce.com/docs/platform/slds-linter/guide/reference-rules.html#no-deprecated-slds-classes\",\n \"type\": \"problem\",\n \"messages\": {\n \"deprecatedClass\": \"The class {{className}} is deprecated and not available in SLDS2. Please update to a supported class.\"\n }\n },\n \"no-deprecated-tokens-slds1\": {\n \"description\": \"Update outdated design tokens to SLDS 2 styling hooks with similar values. For more information, see Styling Hooks on lightningdesignsystem.com.\",\n \"url\": \"https://developer.salesforce.com/docs/platform/slds-linter/guide/reference-rules.html#no-deprecated-tokens-slds1\",\n \"type\": \"problem\",\n \"messages\": {\n \"deprecatedToken\": \"Consider removing {{oldValue}} or replacing it with {{newValue}}. Set the fallback to {{oldValue}}. For more info, see Styling Hooks on lightningdesignsystem.com.\",\n \"noReplacement\": \"Update outdated design tokens to SLDS 2 styling hooks with similar values. For more information, see Styling Hooks on lightningdesignsystem.com.\"\n }\n },\n \"enforce-sds-to-slds-hooks\": {\n \"description\": \"Convert your existing --sds styling hooks to --slds styling hooks. See lightningdesignsystem.com for more info.\",\n \"url\": \"https://developer.salesforce.com/docs/platform/slds-linter/guide/reference-rules.html#enforce-sds-to-slds-hooks\",\n \"type\": \"problem\",\n \"messages\": {\n \"replaceSdsWithSlds\": \"Replace {{oldValue}} with {{suggestedMatch}} styling hook.\"\n }\n },\n \"enforce-bem-usage\": {\n \"description\": \"Replace BEM double-dash syntax in class names with single underscore syntax\",\n \"url\": \"https://developer.salesforce.com/docs/platform/slds-linter/guide/reference-rules.html#enforce-bem-usage\",\n \"type\": \"problem\",\n \"messages\": {\n \"bemDoubleDash\": \"{{actual}} has been retired. Update it to the new name {{newValue}}.\",\n \"fixBemNaming\": \"Update to correct BEM naming convention\"\n }\n },\n \"modal-close-button-issue\": {\n \"description\": \"Update component attributes or CSS classes for the modal close button to comply with the modal component blueprint\",\n \"url\": \"https://developer.salesforce.com/docs/platform/slds-linter/guide/reference-rules.html#modal-close-button-issue\",\n \"type\": \"problem\",\n \"messages\": {\n \"modalCloseButtonIssue\": \"Update component attributes or CSS classes for the modal close button to comply with the modal component blueprint.\",\n \"removeClass\": \"Remove the slds-button_icon-inverse class from the modal close button in components that use the SLDS modal blueprint.\",\n \"changeVariant\": \"Change the variant attribute value from bare-inverse to bare in <lightning-button-icon> or <lightning-icon>.\",\n \"removeVariant\": \"Remove the variant attribute from the <lightning-icon> component inside the <button> element.\",\n \"ensureButtonClasses\": \"Add or move slds-button and slds-button_icon to the class attribute of the <button> element or <lightning-button-icon> component.\",\n \"ensureSizeAttribute\": \"To size icons properly, set the size attribute \u200Cto large in the <lightning-icon> and <lightning-button-icon> components.\"\n }\n },\n \"no-deprecated-classes-slds2\": {\n \"description\": \"Replace classes that aren't available with SLDS 2 classes\",\n \"url\": \"https://developer.salesforce.com/docs/platform/slds-linter/guide/reference-rules.html#no-deprecated-classes-slds2\",\n \"type\": \"problem\",\n \"messages\": {\n \"deprecatedClass\": \"The class {{className}} isn't available in SLDS 2. Update it to a class supported in SLDS 2. See lightningdesignsystem.com for more information.\",\n \"updateToModernClass\": \"Replace deprecated class with modern equivalent\",\n \"checkDocumentation\": \"See lightningdesignsystem.com for SLDS 2 class alternatives\"\n }\n },\n \"lwc-token-to-slds-hook\": {\n \"description\": \"Replace the deprecated --lwc tokens with the latest --slds tokens. See lightningdesignsystem.com for more info.\",\n \"url\": \"https://developer.salesforce.com/docs/platform/slds-linter/guide/reference-rules.html#lwc-token-to-slds-hook\",\n \"type\": \"problem\",\n \"messages\": {\n \"errorWithReplacement\": \"The '{{oldValue}}' design token is deprecated. Replace it with '{{newValue}}'. For more info, see Global Styling Hooks on lightningdesignsystem.com.\",\n \"errorWithStyleHooks\": \"The '{{oldValue}}' design token is deprecated. Replace it with the SLDS 2 '{{newValue}}' styling hook and set the fallback to '{{oldValue}}'. For more info, see Global Styling Hooks on lightningdesignsystem.com.\",\n \"errorWithNoRecommendation\": \"The '{{oldValue}}' design token is deprecated. For more info, see the New Global Styling Hook Guidance on lightningdesignsystem.com.\"\n }\n },\n \"no-sldshook-fallback-for-lwctoken\": {\n \"description\": \"Avoid using --slds styling hooks as fallback values for --lwc tokens.\",\n \"url\": \"https://developer.salesforce.com/docs/platform/slds-linter/guide/reference-rules.html#no-sldshook-fallback-for-lwctoken\",\n \"type\": \"problem\",\n \"messages\": {\n \"unsupportedFallback\": \"Remove the {{sldsToken}} styling hook that is used as a fallback value for {{lwcToken}}.\"\n }\n },\n \"no-unsupported-hooks-slds2\": {\n \"description\": \"Identifies styling hooks that aren't present in SLDS 2. They must be replaced with styling hooks that have a similar effect, or they must be removed.\",\n \"url\": \"https://developer.salesforce.com/docs/platform/slds-linter/guide/reference-rules.html#no-unsupported-hooks-slds2\",\n \"type\": \"problem\",\n \"messages\": {\n \"deprecated\": \"The {{token}} styling hook isn't present in SLDS 2 and there's no equivalent replacement. Remove it or replace it with a styling hook with a similar effect.\"\n }\n },\n \"no-slds-var-without-fallback\": {\n \"description\": \"Add fallback values to SLDS styling hooks. The fallback values are used in Salesforce environments where styling hooks are unavailable.\",\n \"url\": \"https://developer.salesforce.com/docs/platform/slds-linter/guide/reference-rules.html#no-slds-var-without-fallback\",\n \"type\": \"problem\",\n \"messages\": {\n \"varWithoutFallback\": \"Your code uses the {{cssVar}} styling hook without a fallback value. Styling hooks are unavailable in some Salesforce environments. To render your component correctly in all environments, add this fallback value: var({{cssVar}}, {{recommendation}}). To make this fallback value brand-aware, use a branded design token instead of a static value. See Design Tokens on v1.lightningdesignsystem.com.\"\n }\n },\n \"no-slds-namespace-for-custom-hooks\": {\n \"description\": \"To differentiate custom styling hooks from SLDS styling hooks, create custom styling hooks in your namespace.\",\n \"url\": \"https://developer.salesforce.com/docs/platform/slds-linter/guide/reference-rules.html#no-slds-namespace-for-custom-hooks\",\n \"type\": \"problem\",\n \"messages\": {\n \"customHookNamespace\": \"Using the --slds namespace for {{token}} isn't supported. Create the custom styling hook in your namespace. Example: --myapp-{{tokenWithoutNamespace}}\"\n }\n },\n \"no-slds-private-var\": {\n \"description\": \"Some SLDS styling hooks are private and reserved only for internal Salesforce use. Private SLDS styling hooks have prefixes --_slds- and --slds-s-. For more information, look up private CSS in lightningdesignsystem.com.\",\n \"url\": \"https://developer.salesforce.com/docs/platform/slds-linter/guide/reference-rules.html#no-slds-private-var\",\n \"type\": \"problem\",\n \"messages\": {\n \"privateVar\": \"This styling hook is reserved for internal Salesforce use. Remove the --_slds- or \u2013slds-s private variable within selector {{prop}}. For more information, look up private CSS in lightningdesignsystem.com.\"\n }\n },\n \"enforce-component-hook-naming-convention\": {\n \"description\": \"Replace component styling hooks that use a deprecated naming convention.\",\n \"url\": \"https://developer.salesforce.com/docs/platform/slds-linter/guide/reference-rules.html#enforce-component-hook-naming-convention\",\n \"type\": \"problem\",\n \"messages\": {\n \"replace\": \"Replace the deprecated {{oldValue}} component styling hook with {{suggestedMatch}}.\"\n }\n },\n \"no-hardcoded-values-slds1\": {\n \"description\": \"Replace static values with SLDS 1 design tokens. For more information, look up design tokens on lightningdesignsystem.com.\",\n \"url\": \"https://developer.salesforce.com/docs/platform/slds-linter/guide/reference-rules.html#no-hardcoded-value\",\n \"type\": \"suggestion\",\n \"messages\": {\n \"hardcodedValue\": \"Replace the {{oldValue}} static value with an SLDS 1 styling hook: {{newValue}}.\",\n \"noReplacement\": \"There's no replacement styling hook for the {{oldValue}} static value. Remove the static value.\"\n }\n },\n \"no-hardcoded-values-slds2\": {\n \"description\": \"Replace static values with SLDS 2 styling hooks. For more information, look up design tokens on lightningdesignsystem.com.\",\n \"url\": \"https://developer.salesforce.com/docs/platform/slds-linter/guide/reference-rules.html#no-hardcoded-values-slds2\",\n \"type\": \"suggestion\",\n \"messages\": {\n \"hardcodedValue\": \"Consider replacing the {{oldValue}} static value with an SLDS 2 styling hook that has a similar value: {{newValue}}.\",\n \"noReplacement\": \"There's no replacement styling hook for the {{oldValue}} static value. Remove the static value.\"\n }\n },\n \"reduce-annotations\": {\n \"description\": \"Remove your annotations and update your code.\",\n \"url\": \"https://developer.salesforce.com/docs/platform/slds-linter/guide/reference-rules.html#reduce-annotations\",\n \"type\": \"problem\",\n \"messages\": {\n \"removeAnnotation\": \"Remove this annotation and update the code to SLDS best practices. For help, file an issue at https://github.com/salesforce-ux/slds-linter/\"\n }\n }\n};", "// THIS IS TAKEN FROM html-eslint\n\nimport { NODE_TYPES } from \"@html-eslint/parser\";\n\n\n/**\n * @param {TagNode | ScriptTagNode | StyleTagNode} node\n * @param {string} key\n * @returns {AttributeNode | undefined}\n */\nfunction findAttr(node, key) {\n return node.attributes.find(\n (attr) => attr.key && attr.key.value.toLowerCase() === key.toLowerCase()\n );\n}\n\n/**\n * Checks whether a node's attributes is empty or not.\n * @param {TagNode | ScriptTagNode | StyleTagNode} node\n * @returns {boolean}\n */\nfunction isAttributesEmpty(node) {\n return !node.attributes || node.attributes.length <= 0;\n}\n\n/**\n * Checks whether a node's all tokens are on the same line or not.\n * @param {AnyNode} node A node to check\n * @returns {boolean} `true` if a node's tokens are on the same line, otherwise `false`.\n */\nfunction isNodeTokensOnSameLine(node) {\n return node.loc.start.line === node.loc.end.line;\n}\n\n/**\n *\n * @param {Range} rangeA\n * @param {Range} rangeB\n * @returns {boolean}\n */\nfunction isRangesOverlap(rangeA, rangeB) {\n return rangeA[0] < rangeB[1] && rangeB[0] < rangeA[1];\n}\n\n/**\n * @param {(TextNode | CommentContentNode)['templates']} templates\n * @param {Range} range\n * @returns {boolean}\n */\nfunction isOverlapWithTemplates(templates, range) {\n return templates\n .filter((template) => template.isTemplate)\n .some((template) => isRangesOverlap(template.range, range));\n}\n\n/**\n *\n * @param {TextNode | CommentContentNode} node\n * @returns {LineNode[]}\n */\nfunction splitToLineNodes(node) {\n let start = node.range[0];\n let line = node.loc.start.line;\n const startCol = node.loc.start.column;\n /**\n * @type {LineNode[]}\n */\n const lineNodes = [];\n const templates = node.templates || [];\n /**\n *\n * @param {import(\"../../types\").Range} range\n */\n function shouldSkipIndentCheck(range) {\n const overlappedTemplates = templates.filter(\n (template) =>\n template.isTemplate && isRangesOverlap(template.range, range)\n );\n\n const isLineInTemplate = overlappedTemplates.some((template) => {\n return template.range[0] <= range[0] && template.range[1] >= range[1];\n });\n if (isLineInTemplate) {\n return true;\n }\n const isLineBeforeTemplate = overlappedTemplates.some((template) => {\n return template.range[0] <= range[0] && template.range[1] <= range[1];\n });\n if (isLineBeforeTemplate) {\n return true;\n }\n const isLineAfterTemplate = overlappedTemplates.some((template) => {\n return template.range[1] <= range[0];\n });\n if (isLineAfterTemplate) {\n return true;\n }\n return false;\n }\n\n node.value.split(\"\\n\").forEach((value, index) => {\n const columnStart = index === 0 ? startCol : 0;\n /**\n * @type {import(\"../../types\").Range}\n */\n const range = [start, start + value.length];\n const loc = {\n start: {\n line,\n column: columnStart,\n },\n end: {\n line,\n column: columnStart + value.length,\n },\n };\n /**\n * @type {LineNode}\n */\n const lineNode = {\n type: \"Line\",\n value,\n range,\n loc,\n skipIndentCheck: shouldSkipIndentCheck(range),\n };\n\n start += value.length + 1;\n line += 1;\n\n lineNodes.push(lineNode);\n });\n\n return lineNodes;\n}\n\n/**\n * Get location between two nodes.\n * @param {BaseNode} before A node placed in before\n * @param {BaseNode} after A node placed in after\n * @returns {Location} location between two nodes.\n */\nfunction getLocBetween(before, after) {\n return {\n start: before.loc.end,\n end: after.loc.start,\n };\n}\n\n/**\n * @param {AttributeValueNode} node\n * @return {boolean}\n */\nfunction isExpressionInTemplate(node) {\n if (node.type === NODE_TYPES.AttributeValue) {\n return node.value.indexOf(\"${\") === 0;\n }\n return false;\n}\n\n/**\n * @param {AnyNode} node\n * @returns {node is TagNode}\n */\nfunction isTag(node) {\n return node.type === NODE_TYPES.Tag;\n}\n\n/**\n * @param {AnyNode} node\n * @returns {node is CommentNode}\n */\nfunction isComment(node) {\n return node.type === NODE_TYPES.Comment;\n}\n\n/**\n * @param {AnyNode} node\n * @returns {node is TextNode}\n */\nfunction isText(node) {\n return node.type === NODE_TYPES.Text;\n}\n\nconst lineBreakPattern = /\\r\\n|[\\r\\n\\u2028\\u2029]/u;\nconst lineEndingPattern = new RegExp(lineBreakPattern.source, \"gu\");\n/**\n * @param {string} source\n * @returns {string[]}\n */\nfunction codeToLines(source) {\n return source.split(lineEndingPattern);\n}\n\n/**\n *\n * @param {AnyToken[]} tokens\n * @returns {((CommentContentNode | TextNode)['templates'][number])[]}\n */\nfunction getTemplateTokens(tokens) {\n return (\n []\n .concat(\n ...tokens\n // @ts-ignore\n .map((token) => token[\"templates\"] || [])\n )\n // @ts-ignore\n .filter((token) => token.isTemplate)\n );\n}\n\nexport {\n findAttr,\n isAttributesEmpty,\n isNodeTokensOnSameLine,\n splitToLineNodes,\n getLocBetween,\n isExpressionInTemplate,\n isTag,\n isComment,\n isText,\n isOverlapWithTemplates,\n codeToLines,\n isRangesOverlap,\n getTemplateTokens,\n};", "import { Rule } from 'eslint';\nimport { findAttr, isAttributesEmpty } from \"../utils/node\";\nimport metadata from '@salesforce-ux/sds-metadata/next';\nimport ruleMessages from '../config/rule-messages.yml';\nimport enforceBemUsageCss from './v9/enforce-bem-usage';\n\nconst bemMapping = metadata.bemNaming;\nconst deprecatedClasses = metadata.deprecatedClasses;\nconst ruleConfig = ruleMessages['enforce-bem-usage'];\nconst { type, description, url, messages } = ruleConfig;\n/**\n * Checks if a given className or its BEM mapped equivalent is deprecated.\n * \n * This function checks whether the provided className is included in the\n * `deprecatedClasses` list or if the BEM mapped class is deprecated.\n * \n * @param className - The class name to check for deprecation.\n * @returns A boolean indicating whether the className or its mapped version is deprecated.\n */\nconst isDeprecatedClass = (className : string) => {\n return (deprecatedClasses.includes(className) || deprecatedClasses.includes(bemMapping[className]))\n}\n\nconst enforceBemUsageHtml = {\n create(context) { \n\n function check(node) {\n if (isAttributesEmpty(node)) {\n return;\n }\n const classAttr = findAttr(node, \"class\");\n if (classAttr && classAttr.value) {\n const classNames = classAttr.value.value.split(/\\s+/);\n classNames.forEach((className) => {\n if (className && className in bemMapping && !isDeprecatedClass(className)) {\n // Find the exact location of the problematic class name\n const classNameStart = classAttr.value.value.indexOf(className) + 7; // 7 here is for `class= \"`\n const classNameEnd = classNameStart + className.length;\n\n // Use the loc property to get line and column from the class attribute\n const startLoc = {\n line: classAttr.loc.start.line,\n column: classAttr.loc.start.column + classNameStart,\n };\n const endLoc = {\n line: classAttr.loc.start.line,\n column: classAttr.loc.start.column + classNameEnd,\n };\n\n // Check whether a fixed class is available\n const newValue = bemMapping[className];\n context.report({\n node,\n loc: { start: startLoc, end: endLoc },\n messageId: 'bemDoubleDash',\n data: {\n actual: className,\n newValue\n },\n fix(fixer) {\n if (newValue) {\n const newClassValue = classAttr.value.value.replace(\n className,\n newValue\n );\n return fixer.replaceTextRange(\n [classAttr.value.range[0], classAttr.value.range[1]],\n `${newClassValue}`\n );\n }\n return null; // Ensure a return value even if no fix is applied\n },\n });\n }\n });\n }\n }\n\n return {\n Tag: check,\n };\n },\n};\n\n\n\n// Create a hybrid rule that works for both HTML and CSS\nconst enforceBemUsage = {\n meta: {\n type,\n docs: {\n recommended: true,\n description,\n url\n },\n fixable: \"code\",\n messages\n },\n\n create(context) {\n const filename = context.filename || context.getFilename();\n \n // Check if we're in a CSS context\n if (filename.endsWith('.css') || filename.endsWith('.scss')) {\n // Try to detect if we have CSS support\n // In ESLint v9 with @eslint/css, we should have CSS AST support\n try {\n // Use CSS implementation (ESLint v9 with @eslint/css)\n return enforceBemUsageCss.create(context);\n } catch (error) {\n // If CSS implementation fails, likely ESLint v8 without CSS support\n // Return empty visitor to avoid errors\n return {};\n }\n } else {\n // Use HTML implementation (compatible with both ESLint v8 and v9)\n return enforceBemUsageHtml.create(context);\n }\n },\n};\n\nexport = enforceBemUsage;", "import { Rule } from 'eslint';\nimport metadata from '@salesforce-ux/sds-metadata/next';\nimport ruleMessages from '../../config/rule-messages.yml';\n\nconst { type, description, url, messages } = ruleMessages['enforce-bem-usage'];\n\nconst bemMapping = metadata.bemNaming;\n\nexport default {\n meta: {\n type,\n docs: {\n description,\n recommended: true,\n url,\n },\n fixable: 'code',\n messages,\n },\n \n create(context) {\n return {\n // Check all class selectors for BEM usage\n \"SelectorList Selector ClassSelector\"(node) {\n const cssClassSelector = context.sourceCode.getText(node);\n \n // Extract class name (remove the leading dot)\n const className = cssClassSelector.substring(1);\n \n // Check mapping data for this class name (matches Stylelint logic)\n if (className && className in bemMapping) {\n const newValue = bemMapping[className];\n if (typeof newValue === 'string') {\n context.report({\n node,\n messageId: 'bemDoubleDash',\n data: {\n actual: className,\n newValue,\n },\n fix(fixer) {\n return fixer.replaceText(node, `.${newValue}`);\n },\n });\n }\n }\n },\n };\n },\n} as Rule.RuleModule;\n"],
|
|
5
|
-
"mappings": "
|
|
6
|
-
"names": ["
|
|
3
|
+
"sources": ["../../src/rules/enforce-bem-usage.ts"],
|
|
4
|
+
"sourcesContent": ["import { Rule } from 'eslint';\nimport { findAttr, isAttributesEmpty } from \"../utils/node\";\nimport metadata from '@salesforce-ux/sds-metadata/next';\nimport ruleMessages from '../config/rule-messages';\nimport enforceBemUsageCss from './v9/enforce-bem-usage';\n\nconst bemMapping = metadata.bemNaming;\nconst deprecatedClasses = metadata.deprecatedClasses;\nconst ruleConfig = ruleMessages['enforce-bem-usage'];\nconst { type, description, url, messages } = ruleConfig;\n/**\n * Checks if a given className or its BEM mapped equivalent is deprecated.\n * \n * This function checks whether the provided className is included in the\n * `deprecatedClasses` list or if the BEM mapped class is deprecated.\n * \n * @param className - The class name to check for deprecation.\n * @returns A boolean indicating whether the className or its mapped version is deprecated.\n */\nconst isDeprecatedClass = (className : string) => {\n return (deprecatedClasses.includes(className) || deprecatedClasses.includes(bemMapping[className]))\n}\n\nconst enforceBemUsageHtml = {\n create(context) { \n\n function check(node) {\n if (isAttributesEmpty(node)) {\n return;\n }\n const classAttr = findAttr(node, \"class\");\n if (classAttr && classAttr.value) {\n const classNames = classAttr.value.value.split(/\\s+/);\n classNames.forEach((className) => {\n if (className && className in bemMapping && !isDeprecatedClass(className)) {\n // Find the exact location of the problematic class name\n const classNameStart = classAttr.value.value.indexOf(className) + 7; // 7 here is for `class= \"`\n const classNameEnd = classNameStart + className.length;\n\n // Use the loc property to get line and column from the class attribute\n const startLoc = {\n line: classAttr.loc.start.line,\n column: classAttr.loc.start.column + classNameStart,\n };\n const endLoc = {\n line: classAttr.loc.start.line,\n column: classAttr.loc.start.column + classNameEnd,\n };\n\n // Check whether a fixed class is available\n const newValue = bemMapping[className];\n context.report({\n node,\n loc: { start: startLoc, end: endLoc },\n messageId: 'bemDoubleDash',\n data: {\n actual: className,\n newValue\n },\n fix(fixer) {\n if (newValue) {\n const newClassValue = classAttr.value.value.replace(\n className,\n newValue\n );\n return fixer.replaceTextRange(\n [classAttr.value.range[0], classAttr.value.range[1]],\n `${newClassValue}`\n );\n }\n return null; // Ensure a return value even if no fix is applied\n },\n });\n }\n });\n }\n }\n\n return {\n Tag: check,\n };\n },\n};\n\n\n\n// Create a hybrid rule that works for both HTML and CSS\nconst enforceBemUsage = {\n meta: {\n type,\n docs: {\n recommended: true,\n description,\n url\n },\n fixable: \"code\",\n messages\n },\n\n create(context) {\n const filename = context.filename || context.getFilename();\n \n // Check if we're in a CSS context\n if (filename.endsWith('.css') || filename.endsWith('.scss')) {\n // Try to detect if we have CSS support\n // In ESLint v9 with @eslint/css, we should have CSS AST support\n try {\n // Use CSS implementation (ESLint v9 with @eslint/css)\n return enforceBemUsageCss.create(context);\n } catch (error) {\n // If CSS implementation fails, likely ESLint v8 without CSS support\n // Return empty visitor to avoid errors\n return {};\n }\n } else {\n // Use HTML implementation (compatible with both ESLint v8 and v9)\n return enforceBemUsageHtml.create(context);\n }\n },\n};\n\nexport = enforceBemUsage;"],
|
|
5
|
+
"mappings": ";;;;;;;;;;;;;;;;;;;;;;;;AACA,kBAA4C;AAC5C,kBAAqB;AACrB,2BAAyB;AACzB,+BAA+B;AAE/B,IAAM,aAAa,YAAAA,QAAS;AAC5B,IAAM,oBAAoB,YAAAA,QAAS;AACnC,IAAM,aAAa,qBAAAC,QAAa,mBAAmB;AACnD,IAAM,EAAE,MAAM,aAAa,KAAK,SAAS,IAAI;AAU7C,IAAM,oBAAoB,CAAC,cAAuB;AAChD,SAAQ,kBAAkB,SAAS,SAAS,KAAK,kBAAkB,SAAS,WAAW,SAAS,CAAC;AACnG;AAEA,IAAM,sBAAsB;AAAA,EAC1B,OAAO,SAAS;AAEd,aAAS,MAAM,MAAM;AACnB,cAAI,+BAAkB,IAAI,GAAG;AAC3B;AAAA,MACF;AACA,YAAM,gBAAY,sBAAS,MAAM,OAAO;AACxC,UAAI,aAAa,UAAU,OAAO;AAChC,cAAM,aAAa,UAAU,MAAM,MAAM,MAAM,KAAK;AACpD,mBAAW,QAAQ,CAAC,cAAc;AAChC,cAAI,aAAa,aAAa,cAAc,CAAC,kBAAkB,SAAS,GAAG;AAEzE,kBAAM,iBAAiB,UAAU,MAAM,MAAM,QAAQ,SAAS,IAAI;AAClE,kBAAM,eAAe,iBAAiB,UAAU;AAGhD,kBAAM,WAAW;AAAA,cACf,MAAM,UAAU,IAAI,MAAM;AAAA,cAC1B,QAAQ,UAAU,IAAI,MAAM,SAAS;AAAA,YACvC;AACA,kBAAM,SAAS;AAAA,cACb,MAAM,UAAU,IAAI,MAAM;AAAA,cAC1B,QAAQ,UAAU,IAAI,MAAM,SAAS;AAAA,YACvC;AAGA,kBAAM,WAAW,WAAW,SAAS;AACrC,oBAAQ,OAAO;AAAA,cACb;AAAA,cACA,KAAK,EAAE,OAAO,UAAU,KAAK,OAAO;AAAA,cACpC,WAAW;AAAA,cACX,MAAM;AAAA,gBACJ,QAAQ;AAAA,gBACR;AAAA,cACF;AAAA,cACA,IAAI,OAAO;AACT,oBAAI,UAAU;AACZ,wBAAM,gBAAgB,UAAU,MAAM,MAAM;AAAA,oBAC1C;AAAA,oBACA;AAAA,kBACF;AACA,yBAAO,MAAM;AAAA,oBACX,CAAC,UAAU,MAAM,MAAM,CAAC,GAAG,UAAU,MAAM,MAAM,CAAC,CAAC;AAAA,oBACnD,GAAG,aAAa;AAAA,kBAClB;AAAA,gBACF;AACA,uBAAO;AAAA,cACT;AAAA,YACF,CAAC;AAAA,UACH;AAAA,QACF,CAAC;AAAA,MACH;AAAA,IACF;AAEA,WAAO;AAAA,MACL,KAAK;AAAA,IACP;AAAA,EACF;AACF;AAKA,IAAM,kBAAkB;AAAA,EACtB,MAAM;AAAA,IACJ;AAAA,IACA,MAAM;AAAA,MACJ,aAAa;AAAA,MACb;AAAA,MACA;AAAA,IACF;AAAA,IACA,SAAS;AAAA,IACT;AAAA,EACF;AAAA,EAEA,OAAO,SAAS;AACd,UAAM,WAAW,QAAQ,YAAY,QAAQ,YAAY;AAGzD,QAAI,SAAS,SAAS,MAAM,KAAK,SAAS,SAAS,OAAO,GAAG;AAG3D,UAAI;AAEF,eAAO,yBAAAC,QAAmB,OAAO,OAAO;AAAA,MAC1C,SAAS,OAAO;AAGd,eAAO,CAAC;AAAA,MACV;AAAA,IACF,OAAO;AAEL,aAAO,oBAAoB,OAAO,OAAO;AAAA,IAC3C;AAAA,EACF;AACF;AAEA,iBAAS;",
|
|
6
|
+
"names": ["metadata", "ruleMessages", "enforceBemUsageCss"]
|
|
7
7
|
}
|
|
@@ -4,9 +4,6 @@ var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
|
|
|
4
4
|
var __getOwnPropNames = Object.getOwnPropertyNames;
|
|
5
5
|
var __getProtoOf = Object.getPrototypeOf;
|
|
6
6
|
var __hasOwnProp = Object.prototype.hasOwnProperty;
|
|
7
|
-
var __commonJS = (cb, mod) => function __require() {
|
|
8
|
-
return mod || (0, cb[__getOwnPropNames(cb)[0]])((mod = { exports: {} }).exports, mod), mod.exports;
|
|
9
|
-
};
|
|
10
7
|
var __copyProps = (to, from, except, desc) => {
|
|
11
8
|
if (from && typeof from === "object" || typeof from === "function") {
|
|
12
9
|
for (let key of __getOwnPropNames(from))
|
|
@@ -24,178 +21,9 @@ var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__ge
|
|
|
24
21
|
mod
|
|
25
22
|
));
|
|
26
23
|
|
|
27
|
-
// yaml-file:rule-messages.yml
|
|
28
|
-
var require_rule_messages = __commonJS({
|
|
29
|
-
"yaml-file:rule-messages.yml"(exports2, module2) {
|
|
30
|
-
module2.exports = {
|
|
31
|
-
"no-slds-class-overrides": {
|
|
32
|
-
"description": "Create new custom CSS classes instead of overriding SLDS selectors",
|
|
33
|
-
"url": "https://developer.salesforce.com/docs/platform/slds-linter/guide/reference-rules.html#no-slds-class-overrides",
|
|
34
|
-
"type": "problem",
|
|
35
|
-
"messages": {
|
|
36
|
-
"sldsClassOverride": "Overriding .{{className}} isn't supported. To differentiate SLDS and custom classes, create a CSS class in your namespace. Examples: myapp-input, myapp-button."
|
|
37
|
-
}
|
|
38
|
-
},
|
|
39
|
-
"no-deprecated-slds-classes": {
|
|
40
|
-
"description": "Please replace the deprecated classes with a modern equivalent",
|
|
41
|
-
"url": "https://developer.salesforce.com/docs/platform/slds-linter/guide/reference-rules.html#no-deprecated-slds-classes",
|
|
42
|
-
"type": "problem",
|
|
43
|
-
"messages": {
|
|
44
|
-
"deprecatedClass": "The class {{className}} is deprecated and not available in SLDS2. Please update to a supported class."
|
|
45
|
-
}
|
|
46
|
-
},
|
|
47
|
-
"no-deprecated-tokens-slds1": {
|
|
48
|
-
"description": "Update outdated design tokens to SLDS 2 styling hooks with similar values. For more information, see Styling Hooks on lightningdesignsystem.com.",
|
|
49
|
-
"url": "https://developer.salesforce.com/docs/platform/slds-linter/guide/reference-rules.html#no-deprecated-tokens-slds1",
|
|
50
|
-
"type": "problem",
|
|
51
|
-
"messages": {
|
|
52
|
-
"deprecatedToken": "Consider removing {{oldValue}} or replacing it with {{newValue}}. Set the fallback to {{oldValue}}. For more info, see Styling Hooks on lightningdesignsystem.com.",
|
|
53
|
-
"noReplacement": "Update outdated design tokens to SLDS 2 styling hooks with similar values. For more information, see Styling Hooks on lightningdesignsystem.com."
|
|
54
|
-
}
|
|
55
|
-
},
|
|
56
|
-
"enforce-sds-to-slds-hooks": {
|
|
57
|
-
"description": "Convert your existing --sds styling hooks to --slds styling hooks. See lightningdesignsystem.com for more info.",
|
|
58
|
-
"url": "https://developer.salesforce.com/docs/platform/slds-linter/guide/reference-rules.html#enforce-sds-to-slds-hooks",
|
|
59
|
-
"type": "problem",
|
|
60
|
-
"messages": {
|
|
61
|
-
"replaceSdsWithSlds": "Replace {{oldValue}} with {{suggestedMatch}} styling hook."
|
|
62
|
-
}
|
|
63
|
-
},
|
|
64
|
-
"enforce-bem-usage": {
|
|
65
|
-
"description": "Replace BEM double-dash syntax in class names with single underscore syntax",
|
|
66
|
-
"url": "https://developer.salesforce.com/docs/platform/slds-linter/guide/reference-rules.html#enforce-bem-usage",
|
|
67
|
-
"type": "problem",
|
|
68
|
-
"messages": {
|
|
69
|
-
"bemDoubleDash": "{{actual}} has been retired. Update it to the new name {{newValue}}.",
|
|
70
|
-
"fixBemNaming": "Update to correct BEM naming convention"
|
|
71
|
-
}
|
|
72
|
-
},
|
|
73
|
-
"modal-close-button-issue": {
|
|
74
|
-
"description": "Update component attributes or CSS classes for the modal close button to comply with the modal component blueprint",
|
|
75
|
-
"url": "https://developer.salesforce.com/docs/platform/slds-linter/guide/reference-rules.html#modal-close-button-issue",
|
|
76
|
-
"type": "problem",
|
|
77
|
-
"messages": {
|
|
78
|
-
"modalCloseButtonIssue": "Update component attributes or CSS classes for the modal close button to comply with the modal component blueprint.",
|
|
79
|
-
"removeClass": "Remove the slds-button_icon-inverse class from the modal close button in components that use the SLDS modal blueprint.",
|
|
80
|
-
"changeVariant": "Change the variant attribute value from bare-inverse to bare in <lightning-button-icon> or <lightning-icon>.",
|
|
81
|
-
"removeVariant": "Remove the variant attribute from the <lightning-icon> component inside the <button> element.",
|
|
82
|
-
"ensureButtonClasses": "Add or move slds-button and slds-button_icon to the class attribute of the <button> element or <lightning-button-icon> component.",
|
|
83
|
-
"ensureSizeAttribute": "To size icons properly, set the size attribute \u200Cto large in the <lightning-icon> and <lightning-button-icon> components."
|
|
84
|
-
}
|
|
85
|
-
},
|
|
86
|
-
"no-deprecated-classes-slds2": {
|
|
87
|
-
"description": "Replace classes that aren't available with SLDS 2 classes",
|
|
88
|
-
"url": "https://developer.salesforce.com/docs/platform/slds-linter/guide/reference-rules.html#no-deprecated-classes-slds2",
|
|
89
|
-
"type": "problem",
|
|
90
|
-
"messages": {
|
|
91
|
-
"deprecatedClass": "The class {{className}} isn't available in SLDS 2. Update it to a class supported in SLDS 2. See lightningdesignsystem.com for more information.",
|
|
92
|
-
"updateToModernClass": "Replace deprecated class with modern equivalent",
|
|
93
|
-
"checkDocumentation": "See lightningdesignsystem.com for SLDS 2 class alternatives"
|
|
94
|
-
}
|
|
95
|
-
},
|
|
96
|
-
"lwc-token-to-slds-hook": {
|
|
97
|
-
"description": "Replace the deprecated --lwc tokens with the latest --slds tokens. See lightningdesignsystem.com for more info.",
|
|
98
|
-
"url": "https://developer.salesforce.com/docs/platform/slds-linter/guide/reference-rules.html#lwc-token-to-slds-hook",
|
|
99
|
-
"type": "problem",
|
|
100
|
-
"messages": {
|
|
101
|
-
"errorWithReplacement": "The '{{oldValue}}' design token is deprecated. Replace it with '{{newValue}}'. For more info, see Global Styling Hooks on lightningdesignsystem.com.",
|
|
102
|
-
"errorWithStyleHooks": "The '{{oldValue}}' design token is deprecated. Replace it with the SLDS 2 '{{newValue}}' styling hook and set the fallback to '{{oldValue}}'. For more info, see Global Styling Hooks on lightningdesignsystem.com.",
|
|
103
|
-
"errorWithNoRecommendation": "The '{{oldValue}}' design token is deprecated. For more info, see the New Global Styling Hook Guidance on lightningdesignsystem.com."
|
|
104
|
-
}
|
|
105
|
-
},
|
|
106
|
-
"no-sldshook-fallback-for-lwctoken": {
|
|
107
|
-
"description": "Avoid using --slds styling hooks as fallback values for --lwc tokens.",
|
|
108
|
-
"url": "https://developer.salesforce.com/docs/platform/slds-linter/guide/reference-rules.html#no-sldshook-fallback-for-lwctoken",
|
|
109
|
-
"type": "problem",
|
|
110
|
-
"messages": {
|
|
111
|
-
"unsupportedFallback": "Remove the {{sldsToken}} styling hook that is used as a fallback value for {{lwcToken}}."
|
|
112
|
-
}
|
|
113
|
-
},
|
|
114
|
-
"no-unsupported-hooks-slds2": {
|
|
115
|
-
"description": "Identifies styling hooks that aren't present in SLDS 2. They must be replaced with styling hooks that have a similar effect, or they must be removed.",
|
|
116
|
-
"url": "https://developer.salesforce.com/docs/platform/slds-linter/guide/reference-rules.html#no-unsupported-hooks-slds2",
|
|
117
|
-
"type": "problem",
|
|
118
|
-
"messages": {
|
|
119
|
-
"deprecated": "The {{token}} styling hook isn't present in SLDS 2 and there's no equivalent replacement. Remove it or replace it with a styling hook with a similar effect."
|
|
120
|
-
}
|
|
121
|
-
},
|
|
122
|
-
"no-slds-var-without-fallback": {
|
|
123
|
-
"description": "Add fallback values to SLDS styling hooks. The fallback values are used in Salesforce environments where styling hooks are unavailable.",
|
|
124
|
-
"url": "https://developer.salesforce.com/docs/platform/slds-linter/guide/reference-rules.html#no-slds-var-without-fallback",
|
|
125
|
-
"type": "problem",
|
|
126
|
-
"messages": {
|
|
127
|
-
"varWithoutFallback": "Your code uses the {{cssVar}} styling hook without a fallback value. Styling hooks are unavailable in some Salesforce environments. To render your component correctly in all environments, add this fallback value: var({{cssVar}}, {{recommendation}}). To make this fallback value brand-aware, use a branded design token instead of a static value. See Design Tokens on v1.lightningdesignsystem.com."
|
|
128
|
-
}
|
|
129
|
-
},
|
|
130
|
-
"no-slds-namespace-for-custom-hooks": {
|
|
131
|
-
"description": "To differentiate custom styling hooks from SLDS styling hooks, create custom styling hooks in your namespace.",
|
|
132
|
-
"url": "https://developer.salesforce.com/docs/platform/slds-linter/guide/reference-rules.html#no-slds-namespace-for-custom-hooks",
|
|
133
|
-
"type": "problem",
|
|
134
|
-
"messages": {
|
|
135
|
-
"customHookNamespace": "Using the --slds namespace for {{token}} isn't supported. Create the custom styling hook in your namespace. Example: --myapp-{{tokenWithoutNamespace}}"
|
|
136
|
-
}
|
|
137
|
-
},
|
|
138
|
-
"no-slds-private-var": {
|
|
139
|
-
"description": "Some SLDS styling hooks are private and reserved only for internal Salesforce use. Private SLDS styling hooks have prefixes --_slds- and --slds-s-. For more information, look up private CSS in lightningdesignsystem.com.",
|
|
140
|
-
"url": "https://developer.salesforce.com/docs/platform/slds-linter/guide/reference-rules.html#no-slds-private-var",
|
|
141
|
-
"type": "problem",
|
|
142
|
-
"messages": {
|
|
143
|
-
"privateVar": "This styling hook is reserved for internal Salesforce use. Remove the --_slds- or \u2013slds-s private variable within selector {{prop}}. For more information, look up private CSS in lightningdesignsystem.com."
|
|
144
|
-
}
|
|
145
|
-
},
|
|
146
|
-
"enforce-component-hook-naming-convention": {
|
|
147
|
-
"description": "Replace component styling hooks that use a deprecated naming convention.",
|
|
148
|
-
"url": "https://developer.salesforce.com/docs/platform/slds-linter/guide/reference-rules.html#enforce-component-hook-naming-convention",
|
|
149
|
-
"type": "problem",
|
|
150
|
-
"messages": {
|
|
151
|
-
"replace": "Replace the deprecated {{oldValue}} component styling hook with {{suggestedMatch}}."
|
|
152
|
-
}
|
|
153
|
-
},
|
|
154
|
-
"no-hardcoded-values-slds1": {
|
|
155
|
-
"description": "Replace static values with SLDS 1 design tokens. For more information, look up design tokens on lightningdesignsystem.com.",
|
|
156
|
-
"url": "https://developer.salesforce.com/docs/platform/slds-linter/guide/reference-rules.html#no-hardcoded-value",
|
|
157
|
-
"type": "suggestion",
|
|
158
|
-
"messages": {
|
|
159
|
-
"hardcodedValue": "Replace the {{oldValue}} static value with an SLDS 1 styling hook: {{newValue}}.",
|
|
160
|
-
"noReplacement": "There's no replacement styling hook for the {{oldValue}} static value. Remove the static value."
|
|
161
|
-
}
|
|
162
|
-
},
|
|
163
|
-
"no-hardcoded-values-slds2": {
|
|
164
|
-
"description": "Replace static values with SLDS 2 styling hooks. For more information, look up design tokens on lightningdesignsystem.com.",
|
|
165
|
-
"url": "https://developer.salesforce.com/docs/platform/slds-linter/guide/reference-rules.html#no-hardcoded-values-slds2",
|
|
166
|
-
"type": "suggestion",
|
|
167
|
-
"messages": {
|
|
168
|
-
"hardcodedValue": "Consider replacing the {{oldValue}} static value with an SLDS 2 styling hook that has a similar value: {{newValue}}.",
|
|
169
|
-
"noReplacement": "There's no replacement styling hook for the {{oldValue}} static value. Remove the static value."
|
|
170
|
-
}
|
|
171
|
-
},
|
|
172
|
-
"reduce-annotations": {
|
|
173
|
-
"description": "Remove your annotations and update your code.",
|
|
174
|
-
"url": "https://developer.salesforce.com/docs/platform/slds-linter/guide/reference-rules.html#reduce-annotations",
|
|
175
|
-
"type": "problem",
|
|
176
|
-
"messages": {
|
|
177
|
-
"removeAnnotation": "Remove this annotation and update the code to SLDS best practices. For help, file an issue at https://github.com/salesforce-ux/slds-linter/"
|
|
178
|
-
}
|
|
179
|
-
}
|
|
180
|
-
};
|
|
181
|
-
}
|
|
182
|
-
});
|
|
183
|
-
|
|
184
|
-
// src/utils/node.ts
|
|
185
|
-
var import_parser = require("@html-eslint/parser");
|
|
186
|
-
function findAttr(node, key) {
|
|
187
|
-
return node.attributes.find(
|
|
188
|
-
(attr) => attr.key && attr.key.value.toLowerCase() === key.toLowerCase()
|
|
189
|
-
);
|
|
190
|
-
}
|
|
191
|
-
function isAttributesEmpty(node) {
|
|
192
|
-
return !node.attributes || node.attributes.length <= 0;
|
|
193
|
-
}
|
|
194
|
-
var lineBreakPattern = /\r\n|[\r\n\u2028\u2029]/u;
|
|
195
|
-
var lineEndingPattern = new RegExp(lineBreakPattern.source, "gu");
|
|
196
|
-
|
|
197
24
|
// src/rules/modal-close-button-issue.ts
|
|
198
|
-
var
|
|
25
|
+
var import_node = require("../utils/node");
|
|
26
|
+
var import_rule_messages = __toESM(require("../config/rule-messages"));
|
|
199
27
|
var ruleConfig = import_rule_messages.default["modal-close-button-issue"];
|
|
200
28
|
module.exports = {
|
|
201
29
|
meta: {
|
|
@@ -212,12 +40,12 @@ module.exports = {
|
|
|
212
40
|
},
|
|
213
41
|
create(context) {
|
|
214
42
|
function check(node) {
|
|
215
|
-
if (isAttributesEmpty(node)) {
|
|
43
|
+
if ((0, import_node.isAttributesEmpty)(node)) {
|
|
216
44
|
return;
|
|
217
45
|
}
|
|
218
46
|
const tagName = node.name;
|
|
219
47
|
if (tagName === "button") {
|
|
220
|
-
const classAttr = findAttr(node, "class");
|
|
48
|
+
const classAttr = (0, import_node.findAttr)(node, "class");
|
|
221
49
|
if (classAttr && classAttr.value) {
|
|
222
50
|
const classList = classAttr.value.value.split(/\s+/);
|
|
223
51
|
if (!classList.includes("slds-modal__close")) {
|
|
@@ -298,22 +126,22 @@ module.exports = {
|
|
|
298
126
|
}
|
|
299
127
|
}
|
|
300
128
|
};
|
|
301
|
-
const variantAttr = findAttr(node, "variant");
|
|
302
|
-
const sizeAttr = findAttr(node, "size");
|
|
303
|
-
const classAttr = findAttr(node, "class");
|
|
304
|
-
const iconClassAttr = findAttr(node, "icon-class");
|
|
129
|
+
const variantAttr = (0, import_node.findAttr)(node, "variant");
|
|
130
|
+
const sizeAttr = (0, import_node.findAttr)(node, "size");
|
|
131
|
+
const classAttr = (0, import_node.findAttr)(node, "class");
|
|
132
|
+
const iconClassAttr = (0, import_node.findAttr)(node, "icon-class");
|
|
305
133
|
validateClassAttr(classAttr, "class");
|
|
306
134
|
validateClassAttr(iconClassAttr, "icon-class");
|
|
307
135
|
}
|
|
308
136
|
if ((tagName === "lightning-icon" || tagName === "lightning:icon") && node.parent?.name === "button") {
|
|
309
|
-
const parentClassAttr = findAttr(node.parent, "class");
|
|
137
|
+
const parentClassAttr = (0, import_node.findAttr)(node.parent, "class");
|
|
310
138
|
if (parentClassAttr && parentClassAttr.value) {
|
|
311
139
|
const parentClassList = parentClassAttr.value.value.split(/\s+/);
|
|
312
140
|
if (!parentClassList.includes("slds-modal__close")) {
|
|
313
141
|
return;
|
|
314
142
|
}
|
|
315
|
-
const variantAttr = findAttr(node, "variant");
|
|
316
|
-
const sizeAttr = findAttr(node, "size");
|
|
143
|
+
const variantAttr = (0, import_node.findAttr)(node, "variant");
|
|
144
|
+
const sizeAttr = (0, import_node.findAttr)(node, "size");
|
|
317
145
|
if (variantAttr && variantAttr.value && variantAttr.value.value === "bare-inverse") {
|
|
318
146
|
context.report({
|
|
319
147
|
node: variantAttr,
|