@salesforce-ux/eslint-plugin-slds 0.1.0 → 0.1.1

package/.eslintrc.yml

@@ -18,5 +18,5 @@ overrides:
       - "@salesforce-ux/slds"
     rules:
       "@salesforce-ux/slds/enforce-bem-class": "error"
-      "@salesforce-ux/slds/no-deprecated-slds2-classes": "error"
+      "@salesforce-ux/slds/no-deprecated-classes-slds2": "error"
       "@salesforce-ux/slds/modal-close-button-issue": "error"

package/build/index.d.ts

@@ -1,7 +1,7 @@
 declare const _default: {
     rules: {
         "enforce-bem-class": any;
-        "no-deprecated-slds2-classes": any;
+        "no-deprecated-classes-slds2": any;
         "modal-close-button-issue": any;
     };
     configs: {
@@ -10,7 +10,7 @@ declare const _default: {
             plugins: string[];
             rules: {
                 "slds/enforce-bem-class": string;
-                "slds/no-deprecated-slds2-classes": string;
+                "slds/no-deprecated-classes-slds2": string;
                 "slds/modal-close-button-issue": string;
             };
         };

package/build/index.js

@@ -2,7 +2,7 @@
 module.exports = {
     rules: {
         "enforce-bem-class": require('./rules/enforce-bem-class'),
-        "no-deprecated-slds2-classes": require('./rules/no-deprecated-slds2-classes'),
+        "no-deprecated-classes-slds2": require('./rules/no-deprecated-classes-slds2'),
         "modal-close-button-issue": require('./rules/modal-close-button-issue')
     },
     configs: {
@@ -11,7 +11,7 @@ module.exports = {
             plugins: ["slds"],
             rules: {
                 "slds/enforce-bem-class": "error",
-                "slds/no-deprecated-slds2-classes": "error",
+                "slds/no-deprecated-classes-slds2": "error",
                 "slds/modal-close-button-issue": "error"
             },
         },

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,8 @@ declare const _default: {
             additionalProperties: boolean;
         }[];
         messages: {
-            wrongClassName: string;
+            errorMsg: 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,7 +20,8 @@ module.exports = {
             },
         ],
         messages: {
-            wrongClassName: "The class '{{actual}}' does not follow BEM naming convention.",
+            errorMsg: "The {{actual}} class doesn’t follow the correct BEM naming convention.",
+            suggestedMsg: "{{actual}} has been retired. Update it to the new name {{newValue}}.",
         },
     },
     create(context) {
@@ -55,8 +55,9 @@ module.exports = {
                             loc: { start: startLoc, end: endLoc },
                             data: {
                                 actual: className,
+                                newValue
                             },
-                            messageId: "wrongClassName",
+                            messageId: newValue ? "suggestedMsg" : "errorMsg",
                             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/build/rules/utils/node.js

@@ -1,19 +1,7 @@
 "use strict";
 // THIS IS TAKEN FROM html-eslint
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.findAttr = findAttr;
-exports.isAttributesEmpty = isAttributesEmpty;
-exports.isNodeTokensOnSameLine = isNodeTokensOnSameLine;
-exports.splitToLineNodes = splitToLineNodes;
-exports.getLocBetween = getLocBetween;
-exports.isExpressionInTemplate = isExpressionInTemplate;
-exports.isTag = isTag;
-exports.isComment = isComment;
-exports.isText = isText;
-exports.isOverlapWithTemplates = isOverlapWithTemplates;
-exports.codeToLines = codeToLines;
-exports.isRangesOverlap = isRangesOverlap;
-exports.getTemplateTokens = getTemplateTokens;
+exports.getTemplateTokens = exports.isRangesOverlap = exports.codeToLines = exports.isOverlapWithTemplates = exports.isText = exports.isComment = exports.isTag = exports.isExpressionInTemplate = exports.getLocBetween = exports.splitToLineNodes = exports.isNodeTokensOnSameLine = exports.isAttributesEmpty = exports.findAttr = void 0;
 const parser_1 = require("@html-eslint/parser");
 /**
  * @param {TagNode | ScriptTagNode | StyleTagNode} node
@@ -23,6 +11,7 @@ const parser_1 = require("@html-eslint/parser");
 function findAttr(node, key) {
     return node.attributes.find((attr) => attr.key && attr.key.value.toLowerCase() === key.toLowerCase());
 }
+exports.findAttr = findAttr;
 /**
  * Checks whether a node's attributes is empty or not.
  * @param {TagNode | ScriptTagNode | StyleTagNode} node
@@ -31,6 +20,7 @@ function findAttr(node, key) {
 function isAttributesEmpty(node) {
     return !node.attributes || node.attributes.length <= 0;
 }
+exports.isAttributesEmpty = isAttributesEmpty;
 /**
  * Checks whether a node's all tokens are on the same line or not.
  * @param {AnyNode} node A node to check
@@ -39,6 +29,7 @@ function isAttributesEmpty(node) {
 function isNodeTokensOnSameLine(node) {
     return node.loc.start.line === node.loc.end.line;
 }
+exports.isNodeTokensOnSameLine = isNodeTokensOnSameLine;
 /**
  *
  * @param {Range} rangeA
@@ -48,6 +39,7 @@ function isNodeTokensOnSameLine(node) {
 function isRangesOverlap(rangeA, rangeB) {
     return rangeA[0] < rangeB[1] && rangeB[0] < rangeA[1];
 }
+exports.isRangesOverlap = isRangesOverlap;
 /**
  * @param {(TextNode | CommentContentNode)['templates']} templates
  * @param {Range} range
@@ -58,6 +50,7 @@ function isOverlapWithTemplates(templates, range) {
         .filter((template) => template.isTemplate)
         .some((template) => isRangesOverlap(template.range, range));
 }
+exports.isOverlapWithTemplates = isOverlapWithTemplates;
 /**
  *
  * @param {TextNode | CommentContentNode} node
@@ -130,6 +123,7 @@ function splitToLineNodes(node) {
     });
     return lineNodes;
 }
+exports.splitToLineNodes = splitToLineNodes;
 /**
  * Get location between two nodes.
  * @param {BaseNode} before A node placed in before
@@ -142,6 +136,7 @@ function getLocBetween(before, after) {
         end: after.loc.start,
     };
 }
+exports.getLocBetween = getLocBetween;
 /**
  * @param {AttributeValueNode} node
  * @return {boolean}
@@ -152,6 +147,7 @@ function isExpressionInTemplate(node) {
     }
     return false;
 }
+exports.isExpressionInTemplate = isExpressionInTemplate;
 /**
  * @param {AnyNode} node
  * @returns {node is TagNode}
@@ -159,6 +155,7 @@ function isExpressionInTemplate(node) {
 function isTag(node) {
     return node.type === parser_1.NODE_TYPES.Tag;
 }
+exports.isTag = isTag;
 /**
  * @param {AnyNode} node
  * @returns {node is CommentNode}
@@ -166,6 +163,7 @@ function isTag(node) {
 function isComment(node) {
     return node.type === parser_1.NODE_TYPES.Comment;
 }
+exports.isComment = isComment;
 /**
  * @param {AnyNode} node
  * @returns {node is TextNode}
@@ -173,6 +171,7 @@ function isComment(node) {
 function isText(node) {
     return node.type === parser_1.NODE_TYPES.Text;
 }
+exports.isText = isText;
 const lineBreakPattern = /\r\n|[\r\n\u2028\u2029]/u;
 const lineEndingPattern = new RegExp(lineBreakPattern.source, "gu");
 /**
@@ -182,6 +181,7 @@ const lineEndingPattern = new RegExp(lineBreakPattern.source, "gu");
 function codeToLines(source) {
     return source.split(lineEndingPattern);
 }
+exports.codeToLines = codeToLines;
 /**
  *
  * @param {AnyToken[]} tokens
@@ -195,3 +195,4 @@ function getTemplateTokens(tokens) {
         // @ts-ignore
         .filter((token) => token.isTemplate));
 }
+exports.getTemplateTokens = getTemplateTokens;

package/package.json

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