@fkui/vue 6.26.0 → 6.28.0

package/htmlvalidate/rules/slotdeprecated.rule.js

@@ -0,0 +1,85 @@
+const { Rule } = require("html-validate/node");
+const { getDocumentationUrl, getSlots } = require("./common");
+
+/**
+ * @typedef {import("html-validate").RuleDocumentation} RuleDocumentation
+ */
+
+/**
+ * @typedef {Object} Entry
+ * @property {string} slot
+ * @property {string} component
+ * @property {string} [replacement]
+ * @property {string} [additionalMessage]
+ * @property {string} url
+ */
+
+/** @type {Entry[]} */
+const deprecatedSlots = [
+    {
+        slot: "#checkbox-description",
+        component: "f-interactive-table",
+        replacement: "selectable-description",
+        url: "/components/table-and-list/table.html",
+    },
+];
+
+/**
+ * @param {import("html-validate").ElementReadyEvent} event
+ * @returns {boolean}
+ */
+function isRelevant(event) {
+    return deprecatedSlots
+        .map((it) => it.component)
+        .includes(event.target.tagName);
+}
+
+/**
+ * @extends {Rule<Entry, void>}
+ */
+class SlotDeprecated extends Rule {
+    /**
+     * @param {Entry} context
+     * @returns {RuleDocumentation}
+     */
+    documentation(context) {
+        const { url, replacement, additionalMessage } = context;
+        const message = replacement
+            ? `Slot \`${context.slot}\` is deprecated and should be replaced with \`${replacement}\``
+            : `Slot \`${context.slot}\` is deprecated.`;
+        return {
+            description: additionalMessage
+                ? `${message}\n\n${additionalMessage}`
+                : message,
+            url: getDocumentationUrl(url),
+        };
+    }
+
+    setup() {
+        this.on("element:ready", isRelevant, (event) => {
+            const { target } = event;
+            const slots = getSlots(target);
+            const entries = deprecatedSlots.filter((it) =>
+                target.is(it.component),
+            );
+
+            for (const entry of entries) {
+                const description = slots[entry.slot];
+                if (!description) {
+                    continue;
+                }
+
+                this.report({
+                    node: target,
+                    location: description.location,
+                    message: entry.replacement
+                        ? `slot "{{ slot }}" is deprecated and replaced with "{{ replacement }}"`
+                        : `slot "{{ slot }}" is deprecated`,
+                    context: entry,
+                });
+            }
+        });
+    }
+}
+
+module.exports = SlotDeprecated;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fkui/vue",
-  "version": "6.26.0",
+  "version": "6.28.0",
   "description": "Vue implementation of FKUI components",
   "keywords": [
     "fkui",
@@ -60,9 +60,9 @@
     "unit:watch": "jest --watch"
   },
   "peerDependencies": {
-    "@fkui/date": "^6.26.0",
-    "@fkui/design": "^6.26.0",
-    "@fkui/logic": "^6.26.0",
+    "@fkui/date": "^6.28.0",
+    "@fkui/design": "^6.28.0",
+    "@fkui/logic": "^6.28.0",
     "fk-icons": "^4.30.1",
     "html-validate": ">= 7.9.0",
     "vue": "^3.5.0"
@@ -79,5 +79,5 @@
     "node": ">= 20",
     "npm": ">= 7"
   },
-  "gitHead": "ed75f6ab84a4757eb7b627101948112a967dddfe"
+  "gitHead": "fe2ffaeb55b9e9f560cc6f660740bc3480f77cd8"
 }

package/htmlvalidate/rules/finteractivetable-checkbox-description.rule.js

@@ -1,73 +0,0 @@
-const {
-    Rule,
-    TextClassification,
-    classifyNodeText,
-} = require("html-validate/node");
-const { getDocumentationUrl } = require("./common");
-
-/**
- * @param {import("html-validate").ElementReadyEvent} event
- * @returns {boolean}
- */
-function isRelevant(event) {
-    return event.target.is("f-interactive-table");
-}
-
-/**
- * @param {import("html-validate").HtmlElement} element
- * @returns {string[]}
- */
-function getSlots(element) {
-    return Object.fromEntries(
-        element.childElements
-            .filter((it) => it.is("template"))
-            .map((it) => {
-                const key = it.attributes.find((jt) =>
-                    jt.key.startsWith("#"),
-                )?.key;
-                return [key, it];
-            }),
-    );
-}
-
-class FInteractiveTableCheckboxDescription extends Rule {
-    documentation() {
-        return {
-            description:
-                "`#checkbox-description` slot must implemented and non-empty when `selectable` is enabled",
-            url: getDocumentationUrl("/components/table-and-list/table.html"),
-        };
-    }
-
-    setup() {
-        this.on("element:ready", isRelevant, (event) => {
-            const { target } = event;
-            const selectable = target.getAttribute("selectable");
-            if (!selectable) {
-                return;
-            }
-            const slots = getSlots(target);
-            const checkboxDescription = slots["#checkbox-description"];
-            if (!checkboxDescription) {
-                this.report({
-                    node: target,
-                    location: selectable.keyLocation,
-                    message:
-                        "#checkbox-description slot must be implemented when selectable is enabled",
-                });
-                return;
-            }
-            const textContent = classifyNodeText(checkboxDescription);
-            if (textContent === TextClassification.EMPTY_TEXT) {
-                this.report({
-                    node: checkboxDescription,
-                    location: checkboxDescription.location,
-                    message:
-                        "#checkbox-description cannot be empty when selectable is enabled",
-                });
-            }
-        });
-    }
-}
-
-module.exports = FInteractiveTableCheckboxDescription;