@salesforce-ux/eslint-plugin-slds 0.1.0 → 0.1.2-alpha.0

package/build/rules/enforce-bem-class.d.ts

@@ -2,7 +2,6 @@ declare const _default: {
     meta: {
         type: string;
         docs: {
-            description: string;
             category: string;
             recommended: boolean;
         };
@@ -20,7 +19,7 @@ declare const _default: {
             additionalProperties: boolean;
         }[];
         messages: {
-            wrongClassName: string;
+            suggestedMsg: string;
         };
     };
     create(context: any): {

package/build/rules/enforce-bem-class.js

@@ -5,7 +5,6 @@ module.exports = {
     meta: {
         type: "problem", // The rule type
         docs: {
-            description: "Enforce consistent class naming using BEM convention",
             category: "Stylistic Issues",
             recommended: true,
         },
@@ -21,12 +20,10 @@ module.exports = {
             },
         ],
         messages: {
-            wrongClassName: "The class '{{actual}}' does not follow BEM naming convention.",
+            suggestedMsg: "{{actual}} has been retired. Update it to the new name {{newValue}}.",
         },
     },
     create(context) {
-        const pattern = /^(?:[a-z0-9]+(?:-[a-z0-9]+)*)(__[a-z0-9]+(?:-[a-z0-9]+)*)?(--[a-z0-9]+(?:-[a-z0-9]+)*)?$/;
-        const checkNaming = (name) => pattern.test(name);
         function check(node) {
             if ((0, node_1.isAttributesEmpty)(node)) {
                 return;
@@ -35,7 +32,7 @@ module.exports = {
             if (classAttr && classAttr.value) {
                 const classNames = classAttr.value.value.split(/\s+/);
                 classNames.forEach((className) => {
-                    if (className && !checkNaming(className)) {
+                    if (className && className in bem_mapping_1.bemMapping) {
                         // Find the exact location of the problematic class name
                         const classNameStart = classAttr.value.value.indexOf(className) + 7; // 7 here is for `class= "`
                         const classNameEnd = classNameStart + className.length;
@@ -55,8 +52,9 @@ module.exports = {
                             loc: { start: startLoc, end: endLoc },
                             data: {
                                 actual: className,
+                                newValue
                             },
-                            messageId: "wrongClassName",
+                            messageId: "suggestedMsg",
                             fix(fixer) {
                                 if (newValue) {
                                     const newClassValue = classAttr.value.value.replace(className, newValue);

package/build/rules/modal-close-button-issue.d.ts

@@ -2,7 +2,6 @@ declare const _default: {
     meta: {
         type: string;
         docs: {
-            description: string;
             category: string;
             recommended: boolean;
         };

package/build/rules/modal-close-button-issue.js

@@ -4,18 +4,17 @@ module.exports = {
     meta: {
         type: "problem",
         docs: {
-            description: "Ensure SLDS modal compliance by enforcing correct button and icon attributes.",
             category: "Best Practices",
             recommended: true,
         },
         fixable: "code",
         schema: [],
         messages: {
-            removeClass: "Remove the class 'slds-button_icon-inverse' from SLDS Modal blueprints.",
-            changeVariant: "Change 'variant' attribute from 'bare-inverse' to 'bare' in <lightning-button-icon> or <lightning-icon>.",
-            removeVariant: "Remove 'variant' attribute completely in <lightning-icon> inside <button>.",
-            ensureButtonClasses: "Ensure 'slds-button' and 'slds-button_icon' are in the class attribute of <button> or <lightning-button-icon>.",
-            ensureSizeAttribute: "Ensure 'size' attribute is set to 'large' in <lightning-icon> or <lightning-button-icon> for correct icon sizing.",
+            removeClass: "Remove the slds-button_icon-inverse class from the modal close button in components that use the SLDS modal blueprint.",
+            changeVariant: "Change the variant attribute value from bare-inverse to bare in <lightning-button-icon> or <lightning-icon>.",
+            removeVariant: "Remove the variant attribute from the <lightning-icon> component inside the <button> element.",
+            ensureButtonClasses: "Add or move slds-button and slds-button_icon to the class attribute of the <button> element or <lightning-button-icon> component.",
+            ensureSizeAttribute: "To size icons properly, set the size attribute ‌to large in the <lightning-icon> and <lightning-button-icon> components.",
         },
     },
     create(context) {

package/build/rules/{no-deprecated-slds2-classes.d.ts → no-deprecated-classes-slds2.d.ts}

@@ -2,13 +2,12 @@ declare const _default: {
     meta: {
         type: string;
         docs: {
-            description: string;
             category: string;
             recommended: boolean;
         };
         schema: any[];
         messages: {
-            deprecatedClass: string;
+            errorMsg: string;
         };
     };
     create(context: any): {

package/build/rules/{no-deprecated-slds2-classes.js → no-deprecated-classes-slds2.js}

@@ -6,13 +6,12 @@ module.exports = {
     meta: {
         type: "problem", // The rule type
         docs: {
-            description: "Disallow usage of deprecated CSS classes",
             category: "Best Practices",
             recommended: true,
         },
         schema: [], // No additional options needed
         messages: {
-            deprecatedClass: "The class '{{className}}' is deprecated and should not be used.",
+            errorMsg: "The class {{className}} isn't available in SLDS 2. Update it to a class supported in SLDS 2. See lightningdesignsystem.com for more information.",
         },
     },
     create(context) {
@@ -43,7 +42,7 @@ module.exports = {
                             data: {
                                 className,
                             },
-                            messageId: "deprecatedClass",
+                            messageId: "errorMsg",
                         });
                     }
                 });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@salesforce-ux/eslint-plugin-slds",
-  "version": "0.1.0",
+  "version": "0.1.2-alpha.0",
   "main": "build/index.js",
   "files": [
     "build/*",