@salesforce-ux/eslint-plugin-slds 0.1.5 → 0.1.6

package/build/rules/deprecatedClasses.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Ideally we should be loading this from @salesforce-ux/metadata-slds package. But the eslint package in CJS and Metadata package is ESM.
+ * TODO: should avoid referencing this file.
+ */
+export declare const deprecatedClasses: string[];

package/build/rules/deprecatedClasses.js

@@ -0,0 +1,380 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.deprecatedClasses = void 0;
+/**
+ * Ideally we should be loading this from @salesforce-ux/metadata-slds package. But the eslint package in CJS and Metadata package is ESM.
+ * TODO: should avoid referencing this file.
+ */
+exports.deprecatedClasses = [
+    "slds-action-overflow—touch",
+    "slds-action-overflow_touch__body",
+    "slds-action-overflow_touch__container",
+    "slds-action-overflow_touch__content",
+    "slds-action-overflow_touch__footer",
+    "slds-align-content-center",
+    "slds-app-launcher__tile_small",
+    "slds-app-launcher__tile-body_small",
+    "slds-app-launcher__tile-figure_small",
+    "slds-attachments__item",
+    "slds-box_border",
+    "slds-button_icon-bare",
+    "slds-button_small",
+    "slds-button-space-left",
+    "slds-card_empty",
+    "slds-chat-avatar__intials",
+    "slds-chat-event__rule",
+    "slds-checkbox—faux_container",
+    "slds-coach__guidance",
+    "slds-coach__item",
+    "slds-coach__keys",
+    "slds-coach__value",
+    "slds-col-rule_bottom",
+    "slds-col-rule_left",
+    "slds-col-rule_right",
+    "slds-col-rule_top",
+    "slds-collapsed",
+    "slds-color__background_gray-1",
+    "slds-color__background_gray-10",
+    "slds-color__background_gray-11",
+    "slds-color__background_gray-12",
+    "slds-color__background_gray-2",
+    "slds-color__background_gray-3",
+    "slds-color__background_gray-4",
+    "slds-color__background_gray-5",
+    "slds-color__background_gray-6",
+    "slds-color__background_gray-7",
+    "slds-color__background_gray-8",
+    "slds-color__background_gray-9",
+    "slds-color__border_gray-1",
+    "slds-color__border_gray-10",
+    "slds-color__border_gray-11",
+    "slds-color__border_gray-12",
+    "slds-color__border_gray-2",
+    "slds-color__border_gray-3",
+    "slds-color__border_gray-4",
+    "slds-color__border_gray-5",
+    "slds-color__border_gray-6",
+    "slds-color__border_gray-7",
+    "slds-color__border_gray-8",
+    "slds-color__border_gray-9",
+    "slds-color__fill_gray-1",
+    "slds-color__fill_gray-10",
+    "slds-color__fill_gray-11",
+    "slds-color__fill_gray-12",
+    "slds-color__fill_gray-2",
+    "slds-color__fill_gray-3",
+    "slds-color__fill_gray-4",
+    "slds-color__fill_gray-5",
+    "slds-color__fill_gray-6",
+    "slds-color__fill_gray-7",
+    "slds-color__fill_gray-8",
+    "slds-color__fill_gray-9",
+    "slds-color__text_gray-1",
+    "slds-color__text_gray-10",
+    "slds-color__text_gray-11",
+    "slds-color__text_gray-12",
+    "slds-color__text_gray-2",
+    "slds-color__text_gray-3",
+    "slds-color__text_gray-4",
+    "slds-color__text_gray-5",
+    "slds-color__text_gray-6",
+    "slds-color__text_gray-7",
+    "slds-color__text_gray-8",
+    "slds-color__text_gray-9",
+    "slds-comment__replies",
+    "slds-context-bar_theme-marketing",
+    "slds-datepicker_time",
+    "slds-datepicker_time__list",
+    "slds-disabled-text",
+    "slds-docked-composer_overflow__pill",
+    "slds-dropdown_actions",
+    "slds-dropdown_nubbin-top",
+    "slds-einstein-header",
+    "slds-einstein-header__actions",
+    "slds-einstein-header__figure",
+    "slds-expanded",
+    "slds-expression_formula__rte",
+    "slds-faux-input",
+    "slds-faux-input_label",
+    "slds-flip_horizontal",
+    "slds-flip_vertical",
+    "slds-global-header__button_icon",
+    "slds-global-header__button_icon-actions",
+    "slds-global-header__button_icon-favorites",
+    "slds-global-header__icon",
+    "slds-global-header__notification",
+    "slds-global-header__notification_unread",
+    "slds-has-bottom-magnet",
+    "slds-has-buffer",
+    "slds-has-full-bleed",
+    "slds-has-icon",
+    "slds-has-icon_left-right",
+    "slds-has-icon_right",
+    "slds-has-top-magnet",
+    "slds-icon__container",
+    "slds-icon__container_circle",
+    "slds-icon_container_circle",
+    "slds-icon_flip",
+    "slds-icon_left",
+    "slds-icon_right",
+    "slds-icon-custom-1",
+    "slds-icon-custom-10",
+    "slds-icon-custom-100",
+    "slds-icon-custom-101",
+    "slds-icon-custom-102",
+    "slds-icon-custom-103",
+    "slds-icon-custom-104",
+    "slds-icon-custom-105",
+    "slds-icon-custom-106",
+    "slds-icon-custom-107",
+    "slds-icon-custom-108",
+    "slds-icon-custom-109",
+    "slds-icon-custom-11",
+    "slds-icon-custom-110",
+    "slds-icon-custom-111",
+    "slds-icon-custom-112",
+    "slds-icon-custom-113",
+    "slds-icon-custom-12",
+    "slds-icon-custom-13",
+    "slds-icon-custom-14",
+    "slds-icon-custom-15",
+    "slds-icon-custom-16",
+    "slds-icon-custom-17",
+    "slds-icon-custom-18",
+    "slds-icon-custom-19",
+    "slds-icon-custom-2",
+    "slds-icon-custom-20",
+    "slds-icon-custom-21",
+    "slds-icon-custom-22",
+    "slds-icon-custom-23",
+    "slds-icon-custom-24",
+    "slds-icon-custom-25",
+    "slds-icon-custom-26",
+    "slds-icon-custom-27",
+    "slds-icon-custom-28",
+    "slds-icon-custom-29",
+    "slds-icon-custom-3",
+    "slds-icon-custom-30",
+    "slds-icon-custom-31",
+    "slds-icon-custom-32",
+    "slds-icon-custom-33",
+    "slds-icon-custom-34",
+    "slds-icon-custom-35",
+    "slds-icon-custom-36",
+    "slds-icon-custom-37",
+    "slds-icon-custom-38",
+    "slds-icon-custom-39",
+    "slds-icon-custom-4",
+    "slds-icon-custom-40",
+    "slds-icon-custom-41",
+    "slds-icon-custom-42",
+    "slds-icon-custom-43",
+    "slds-icon-custom-44",
+    "slds-icon-custom-45",
+    "slds-icon-custom-46",
+    "slds-icon-custom-47",
+    "slds-icon-custom-48",
+    "slds-icon-custom-49",
+    "slds-icon-custom-5",
+    "slds-icon-custom-50",
+    "slds-icon-custom-51",
+    "slds-icon-custom-52",
+    "slds-icon-custom-53",
+    "slds-icon-custom-54",
+    "slds-icon-custom-55",
+    "slds-icon-custom-56",
+    "slds-icon-custom-57",
+    "slds-icon-custom-58",
+    "slds-icon-custom-59",
+    "slds-icon-custom-6",
+    "slds-icon-custom-60",
+    "slds-icon-custom-61",
+    "slds-icon-custom-62",
+    "slds-icon-custom-63",
+    "slds-icon-custom-64",
+    "slds-icon-custom-65",
+    "slds-icon-custom-66",
+    "slds-icon-custom-67",
+    "slds-icon-custom-68",
+    "slds-icon-custom-69",
+    "slds-icon-custom-7",
+    "slds-icon-custom-70",
+    "slds-icon-custom-71",
+    "slds-icon-custom-72",
+    "slds-icon-custom-73",
+    "slds-icon-custom-74",
+    "slds-icon-custom-75",
+    "slds-icon-custom-76",
+    "slds-icon-custom-77",
+    "slds-icon-custom-78",
+    "slds-icon-custom-79",
+    "slds-icon-custom-8",
+    "slds-icon-custom-80",
+    "slds-icon-custom-81",
+    "slds-icon-custom-82",
+    "slds-icon-custom-83",
+    "slds-icon-custom-84",
+    "slds-icon-custom-85",
+    "slds-icon-custom-86",
+    "slds-icon-custom-87",
+    "slds-icon-custom-88",
+    "slds-icon-custom-89",
+    "slds-icon-custom-9",
+    "slds-icon-custom-90",
+    "slds-icon-custom-91",
+    "slds-icon-custom-92",
+    "slds-icon-custom-93",
+    "slds-icon-custom-94",
+    "slds-icon-custom-95",
+    "slds-icon-custom-96",
+    "slds-icon-custom-97",
+    "slds-icon-custom-98",
+    "slds-icon-custom-99",
+    "slds-icon-standard-task-2",
+    "slds-icon-utility-error",
+    "slds-icon-utility-warning",
+    "slds-indicator-container",
+    "slds-is-focused",
+    "slds-is-interactive",
+    "slds-kx-is-animating-from-click",
+    "slds-large",
+    "slds-large-nowrap",
+    "slds-lookup",
+    "slds-lookup__item",
+    "slds-lookup__item_label",
+    "slds-lookup__item-action",
+    "slds-lookup__item-action_label",
+    "slds-lookup__list",
+    "lookup",
+    "slds-lookup__pill-container",
+    "slds-lookup__result-meta",
+    "slds-lookup__result-text",
+    "slds-lookup__search-input",
+    "slds-m-left_xxx-small",
+    "slds-max-medium-table_stacked",
+    "slds-max-medium-table_stacked-horizontal",
+    "slds-media__figure_fixed-width",
+    "slds-media_double",
+    "slds-media_responsive",
+    "slds-media_reverse",
+    "slds-media_timeline",
+    "slds-medium",
+    "slds-medium-nowrap",
+    "slds-mobile-combobox",
+    "slds-mobile-combobox__addon",
+    "slds-mobile-combobox__header",
+    "slds-mobile-combobox__header-has-icon",
+    "slds-mobile-combobox__input",
+    "slds-mobile-lookup__listbox",
+    "slds-mobile-lookup__listbox_container",
+    "slds-mobile-lookup__listbox_icon_container",
+    "slds-mobile-lookup__listbox_loader",
+    "slds-mobile-lookup__listbox_meta",
+    "slds-mobile-lookup__listbox_text",
+    "slds-mobile-lookup__listbox_trigger",
+    "slds-mobile-lookup__listbox-option",
+    "slds-mobile-lookup__listbox-option_heading",
+    "slds-modal__",
+    "slds-modal_form",
+    "slds-navigation-list—vertical-inverse",
+    "slds-navigation-list-vertical",
+    "slds-navigation-list-vertical__action",
+    "slds-navigation-list-vertical_shade",
+    "slds-notify",
+    "slds-notify-container",
+    "slds-page-header_joined",
+    "slds-page-header_object-home",
+    "slds-panel_filters",
+    "slds-path-coach",
+    "slds-picklist",
+    "slds-picklist__input",
+    "slds-picklist__item",
+    "slds-picklist_draggable",
+    "slds-picklist_fluid",
+    "slds-popover_einstein",
+    "slds-popover_feature",
+    "slds-popover_walkthrough",
+    "slds-popover_walkthrough-alt",
+    "slds-region",
+    "slds-region__pinned-top",
+    "slds-section-group_is-closed",
+    "slds-section-title",
+    "slds-small",
+    "slds-small-nowrap",
+    "slds-tab__scroll-controls",
+    "slds-table_joined",
+    "slds-table_joined-wrapper",
+    "slds-table—edit_container",
+    "slds-table—edit_container-message",
+    "slds-table—header-fixed_container",
+    "slds-tabs__content",
+    "slds-tabs__item",
+    "slds-tabs__nav-scroller",
+    "slds-tabs__nav-scroller_inner",
+    "slds-tabs_default__header",
+    "slds-tabs_mobile",
+    "slds-tabs_mobile__item",
+    "slds-tabs_mobile__title",
+    "slds-tabs_mobile__title-action",
+    "slds-tabs_path",
+    "slds-tabs_path__content",
+    "slds-tabs_path__item",
+    "slds-tabs_path__link",
+    "slds-tabs_path__nav",
+    "slds-tabs_path__stage",
+    "slds-tabs_path__title",
+    "slds-tabs-mobile",
+    "slds-tabs-mobile__group",
+    "slds-tabs-mobile__item",
+    "slds-tags",
+    "slds-tags__item",
+    "slds-tags__list",
+    "slds-text-heading_label-normal",
+    "slds-theme",
+    "slds-theme_alert-texture",
+    "slds-theme_offline",
+    "slds-timeline__media",
+    "slds-timeline__media_call",
+    "slds-timeline__media_email",
+    "slds-timeline__media_event",
+    "slds-timeline__media_task",
+    "slds-timeline__title",
+    "slds-timeline__title-content",
+    "slds-tooltip",
+    "slds-tooltip__body",
+    "slds-truncate_container—25",
+    "slds-truncate_container—33",
+    "slds-truncate_container—50",
+    "slds-truncate_container—66",
+    "slds-truncate_container—75",
+    "slds-var-m-around_xxx-small",
+    "slds-var-m-bottom_xxx-small",
+    "slds-var-m-horizontal_xxx-small",
+    "slds-var-m-left_xxx-small",
+    "slds-var-m-right_xxx-small",
+    "slds-var-m-top_xxx-small",
+    "slds-var-m-vertical_xxx-small",
+    "slds-var-p-around_xxx-small",
+    "slds-var-p-bottom_xxx-small",
+    "slds-var-p-horizontal_xxx-small",
+    "slds-var-p-left_xxx-small",
+    "slds-var-p-right_xxx-small",
+    "slds-var-p-top_xxx-small",
+    "slds-var-p-vertical_xxx-small",
+    "slds-video",
+    "slds-video_center",
+    "slds-video_right",
+    "slds-welcome-mat__info-badge",
+    "slds-welcome-mat__info-badge-container",
+    "slds-welcome-mat__info-progress_complete",
+    "slds-wizard",
+    "slds-wizard__item",
+    "slds-wizard__label",
+    "slds-wizard__link",
+    "slds-wizard__list",
+    "slds-wizard__marker",
+    "slds-wizard__progress",
+    "slds-wizard__progress-bar",
+    "slds-x-small",
+    "slds-x-small-nowrap"
+];

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

@@ -0,0 +1,28 @@
+declare const _default: {
+    meta: {
+        type: string;
+        docs: {
+            category: string;
+            recommended: boolean;
+            description: string;
+            url: string;
+        };
+        fixable: string;
+        schema: {
+            type: string;
+            properties: {
+                pattern: {
+                    type: string;
+                };
+                flags: {
+                    type: string;
+                };
+            };
+            additionalProperties: boolean;
+        }[];
+    };
+    create(context: any): {
+        Tag: (node: any) => void;
+    };
+};
+export = _default;

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

@@ -0,0 +1,73 @@
+"use strict";
+const node_1 = require("./utils/node");
+const bem_mapping_1 = require("./bem-mapping");
+module.exports = {
+    meta: {
+        type: "problem", // The rule type
+        docs: {
+            category: "Stylistic Issues",
+            recommended: true,
+            description: "Replace BEM double-dash syntax in class names with single underscore syntax.",
+            url: ""
+        },
+        fixable: "code", // This rule can be fixed automatically
+        schema: [
+            {
+                type: "object",
+                properties: {
+                    pattern: { type: "string" }, // Regex pattern for BEM
+                    flags: { type: "string" }, // Regex flags
+                },
+                additionalProperties: false,
+            },
+        ],
+    },
+    create(context) {
+        function check(node) {
+            if ((0, node_1.isAttributesEmpty)(node)) {
+                return;
+            }
+            const classAttr = (0, node_1.findAttr)(node, "class");
+            if (classAttr && classAttr.value) {
+                const classNames = classAttr.value.value.split(/\s+/);
+                classNames.forEach((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;
+                        // Use the loc property to get line and column from the class attribute
+                        const startLoc = {
+                            line: classAttr.loc.start.line,
+                            column: classAttr.loc.start.column + classNameStart,
+                        };
+                        const endLoc = {
+                            line: classAttr.loc.start.line,
+                            column: classAttr.loc.start.column + classNameEnd,
+                        };
+                        // Check whether a fixed class is available
+                        const newValue = bem_mapping_1.bemMapping[className];
+                        context.report({
+                            node,
+                            loc: { start: startLoc, end: endLoc },
+                            data: {
+                                actual: className,
+                                newValue
+                            },
+                            message: JSON.stringify({ message: "{{actual}} has been retired. Update it to the new name {{newValue}}.", suggestions: [newValue] }),
+                            fix(fixer) {
+                                if (newValue) {
+                                    const newClassValue = classAttr.value.value.replace(className, newValue);
+                                    return fixer.replaceTextRange([classAttr.value.range[0], classAttr.value.range[1]], `${newClassValue}`);
+                                }
+                                return null; // Ensure a return value even if no fix is applied
+                            },
+                        });
+                    }
+                });
+            }
+        }
+        return {
+            Tag: check,
+        };
+    },
+};

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

@@ -0,0 +1,17 @@
+declare const _default: {
+    meta: {
+        type: string;
+        docs: {
+            category: string;
+            recommended: boolean;
+            description: string;
+            url: string;
+        };
+        fixable: string;
+        schema: any[];
+    };
+    create(context: any): {
+        Tag: (node: any) => void;
+    };
+};
+export = _default;