@html-eslint/core 0.56.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 YeonJuan
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,31 @@
+# @html-eslint/core
+
+Core HTML validation logic for html-eslint.
+
+## Overview
+
+This package provides framework-agnostic HTML validation utilities that can be used across different ESLint plugins (Angular, Svelte, etc.).
+
+## Installation
+
+```bash
+npm install @html-eslint/core
+```
+
+## Usage
+
+```javascript
+import { noInvalidAttrValue } from "@html-eslint/core";
+
+// Create a rule instance with options
+const rule = noInvalidAttrValue({
+  allow: [{ tag: "img", attr: "src", valuePattern: "^https://.*" }],
+});
+
+// Validate attributes using an adapter
+const result = rule.checkAttributes(elementAdapter);
+```
+
+## License
+
+MIT

package/dist/index.d.mts

@@ -0,0 +1,237 @@
+interface ElementNodeAdapter<ElementNode, AttributeKeyNode, AttributeValueNode> {
+    getTagName(): string;
+    getAttributes(): AttributeAdapter<AttributeKeyNode, AttributeValueNode>[];
+    node: () => ElementNode;
+}
+interface AttributeAdapter<AttributeKeyNode, AttributeValueNode> {
+    key: {
+        node: () => AttributeKeyNode;
+        isExpression: () => boolean;
+        value: () => null | string;
+        raw: () => null | string;
+    };
+    value: {
+        node: () => AttributeValueNode | null;
+        isExpression: () => boolean;
+        value: () => string | null;
+    };
+}
+interface NoInvalidAttrValueOptions {
+    allow?: Array<{
+        tag: string;
+        attr: string;
+        valuePattern?: string;
+    }>;
+}
+type NoInvalidAttrValueResult<AttributeKeyNode, AttributeValueNode> = Array<{
+    messageId: "invalid";
+    node: AttributeKeyNode | AttributeValueNode;
+    data: {
+        value: string;
+        attr: string;
+        element: string;
+        suggestion: string;
+    };
+}>;
+interface UseBaselineOptions {
+    available: "widely" | "newly" | number;
+}
+type UseBaselineResult<ElementNode, AttributeKeyNode, AttributeValueNode> = Array<{
+    messageId: "noBaselineElement";
+    node: ElementNode | AttributeValueNode;
+    data: {
+        element: string;
+        availability: string;
+    };
+} | {
+    messageId: "notBaselineElementAttribute";
+    node: ElementNode | AttributeValueNode | AttributeKeyNode;
+    data: {
+        element: string;
+        attr: string;
+        availability: string;
+    };
+} | {
+    messageId: "notBaselineGlobalAttribute";
+    node: AttributeValueNode | AttributeKeyNode;
+    data: {
+        attr: string;
+        availability: string;
+    };
+}>;
+type NoIneffectiveAttrsResult<AttributeKeyNode> = Array<{
+    messageId: "ineffective";
+    node: AttributeKeyNode;
+    data: {
+        message: string;
+    };
+}>;
+type NoObsoleteTagsResult<ElementNode> = Array<{
+    messageId: "unexpected";
+    node: ElementNode;
+    data: {
+        tag: string;
+    };
+}>;
+type NoObsoleteAttrsResult<AttributeKeyNode> = Array<{
+    messageId: "obsolete";
+    node: AttributeKeyNode;
+    data: {
+        attr: string;
+        element: string;
+        suggestion: string;
+    };
+}>;
+
+/**
+ * @template ElementNode
+ * @template AttributeKeyNode
+ * @template AttributeValueNode
+ * @param {NoInvalidAttrValueOptions} options
+ */
+declare function noInvalidAttrValue<ElementNode, AttributeKeyNode, AttributeValueNode>(options: NoInvalidAttrValueOptions): {
+    /**
+     * @param {ElementNodeAdapter<
+     *   ElementNode,
+     *   AttributeKeyNode,
+     *   AttributeValueNode
+     * >} adapter
+     * @returns {NoInvalidAttrValueResult<
+     *   AttributeKeyNode,
+     *   AttributeValueNode
+     * >}
+     */
+    checkAttributes(adapter: ElementNodeAdapter<ElementNode, AttributeKeyNode, AttributeValueNode>): NoInvalidAttrValueResult<AttributeKeyNode, AttributeValueNode>;
+};
+/**
+ * @type {{
+ *   invalid: "invalid";
+ * }}
+ */
+declare const NO_INVALID_ATTR_VALUE_MESSAGE_IDS: {
+    invalid: "invalid";
+};
+
+/**
+ * @template ElementNode
+ * @template AttributeKeyNode
+ * @template AttributeValueNode
+ * @param {UseBaselineOptions} options
+ */
+declare function useBaseline<ElementNode, AttributeKeyNode, AttributeValueNode>(options: UseBaselineOptions): {
+    /**
+     * @param {ElementNodeAdapter<
+     *   ElementNode,
+     *   AttributeKeyNode,
+     *   AttributeValueNode
+     * >} adapter
+     * @returns {UseBaselineResult<
+     *   ElementNode,
+     *   AttributeKeyNode,
+     *   AttributeValueNode
+     * >}
+     */
+    checkAttributes(adapter: ElementNodeAdapter<ElementNode, AttributeKeyNode, AttributeValueNode>): UseBaselineResult<ElementNode, AttributeKeyNode, AttributeValueNode>;
+};
+/**
+ * @type {{
+ *   noBaselineElement: "noBaselineElement";
+ *   notBaselineElementAttribute: "notBaselineElementAttribute";
+ *   notBaselineGlobalAttribute: "notBaselineGlobalAttribute";
+ * }}
+ */
+declare const USE_BASELINE_MESSAGE_IDS: {
+    noBaselineElement: "noBaselineElement";
+    notBaselineElementAttribute: "notBaselineElementAttribute";
+    notBaselineGlobalAttribute: "notBaselineGlobalAttribute";
+};
+
+/**
+ * @template ElementNode
+ * @template AttributeKeyNode
+ * @template AttributeValueNode
+ */
+declare function noIneffectiveAttrs<ElementNode, AttributeKeyNode, AttributeValueNode>(): {
+    /**
+     * @param {ElementNodeAdapter<
+     *   ElementNode,
+     *   AttributeKeyNode,
+     *   AttributeValueNode
+     * >} adapter
+     * @returns {NoIneffectiveAttrsResult<AttributeKeyNode>}
+     */
+    checkAttributes(adapter: ElementNodeAdapter<ElementNode, AttributeKeyNode, AttributeValueNode>): NoIneffectiveAttrsResult<AttributeKeyNode>;
+};
+/**
+ * @import {
+ *   ElementNodeAdapter,
+ *   NoIneffectiveAttrsResult
+ * } from "../types"
+ */
+/**
+ * @typedef {{
+ *   attr: string;
+ *   when: (adapter: ElementNodeAdapter<any, any, any>) => boolean;
+ *   message: string;
+ * }} AttributeChecker
+ */
+/**
+ * @type {{
+ *   ineffective: "ineffective";
+ * }}
+ */
+declare const NO_INEFFECTIVE_ATTRS_MESSAGE_IDS: {
+    ineffective: "ineffective";
+};
+
+/**
+ * @template ElementNode
+ * @template AttributeKeyNode
+ * @template AttributeValueNode
+ */
+declare function noObsoleteTags<ElementNode, AttributeKeyNode, AttributeValueNode>(): {
+    /**
+     * @param {ElementNodeAdapter<
+     *   ElementNode,
+     *   AttributeKeyNode,
+     *   AttributeValueNode
+     * >} adapter
+     * @returns {NoObsoleteTagsResult<ElementNode>}
+     */
+    checkElement(adapter: ElementNodeAdapter<ElementNode, AttributeKeyNode, AttributeValueNode>): NoObsoleteTagsResult<ElementNode>;
+};
+/**
+ * @type {{
+ *   unexpected: "unexpected";
+ * }}
+ */
+declare const NO_OBSOLETE_TAGS_MESSAGE_IDS: {
+    unexpected: "unexpected";
+};
+
+/**
+ * @template ElementNode
+ * @template AttributeKeyNode
+ * @template AttributeValueNode
+ */
+declare function noObsoleteAttrs<ElementNode, AttributeKeyNode, AttributeValueNode>(): {
+    /**
+     * @param {ElementNodeAdapter<
+     *   ElementNode,
+     *   AttributeKeyNode,
+     *   AttributeValueNode
+     * >} adapter
+     * @returns {NoObsoleteAttrsResult<AttributeKeyNode>}
+     */
+    checkAttributes(adapter: ElementNodeAdapter<ElementNode, AttributeKeyNode, AttributeValueNode>): NoObsoleteAttrsResult<AttributeKeyNode>;
+};
+/**
+ * @type {{
+ *   obsolete: "obsolete";
+ * }}
+ */
+declare const NO_OBSOLETE_ATTRS_MESSAGE_IDS: {
+    obsolete: "obsolete";
+};
+
+export { type AttributeAdapter, type ElementNodeAdapter, NO_INEFFECTIVE_ATTRS_MESSAGE_IDS, NO_INVALID_ATTR_VALUE_MESSAGE_IDS, NO_OBSOLETE_ATTRS_MESSAGE_IDS, NO_OBSOLETE_TAGS_MESSAGE_IDS, type NoIneffectiveAttrsResult, type NoInvalidAttrValueOptions, type NoInvalidAttrValueResult, type NoObsoleteAttrsResult, type NoObsoleteTagsResult, USE_BASELINE_MESSAGE_IDS, type UseBaselineOptions, type UseBaselineResult, noIneffectiveAttrs, noInvalidAttrValue, noObsoleteAttrs, noObsoleteTags, useBaseline };

package/dist/index.d.ts

@@ -0,0 +1,237 @@
+interface ElementNodeAdapter<ElementNode, AttributeKeyNode, AttributeValueNode> {
+    getTagName(): string;
+    getAttributes(): AttributeAdapter<AttributeKeyNode, AttributeValueNode>[];
+    node: () => ElementNode;
+}
+interface AttributeAdapter<AttributeKeyNode, AttributeValueNode> {
+    key: {
+        node: () => AttributeKeyNode;
+        isExpression: () => boolean;
+        value: () => null | string;
+        raw: () => null | string;
+    };
+    value: {
+        node: () => AttributeValueNode | null;
+        isExpression: () => boolean;
+        value: () => string | null;
+    };
+}
+interface NoInvalidAttrValueOptions {
+    allow?: Array<{
+        tag: string;
+        attr: string;
+        valuePattern?: string;
+    }>;
+}
+type NoInvalidAttrValueResult<AttributeKeyNode, AttributeValueNode> = Array<{
+    messageId: "invalid";
+    node: AttributeKeyNode | AttributeValueNode;
+    data: {
+        value: string;
+        attr: string;
+        element: string;
+        suggestion: string;
+    };
+}>;
+interface UseBaselineOptions {
+    available: "widely" | "newly" | number;
+}
+type UseBaselineResult<ElementNode, AttributeKeyNode, AttributeValueNode> = Array<{
+    messageId: "noBaselineElement";
+    node: ElementNode | AttributeValueNode;
+    data: {
+        element: string;
+        availability: string;
+    };
+} | {
+    messageId: "notBaselineElementAttribute";
+    node: ElementNode | AttributeValueNode | AttributeKeyNode;
+    data: {
+        element: string;
+        attr: string;
+        availability: string;
+    };
+} | {
+    messageId: "notBaselineGlobalAttribute";
+    node: AttributeValueNode | AttributeKeyNode;
+    data: {
+        attr: string;
+        availability: string;
+    };
+}>;
+type NoIneffectiveAttrsResult<AttributeKeyNode> = Array<{
+    messageId: "ineffective";
+    node: AttributeKeyNode;
+    data: {
+        message: string;
+    };
+}>;
+type NoObsoleteTagsResult<ElementNode> = Array<{
+    messageId: "unexpected";
+    node: ElementNode;
+    data: {
+        tag: string;
+    };
+}>;
+type NoObsoleteAttrsResult<AttributeKeyNode> = Array<{
+    messageId: "obsolete";
+    node: AttributeKeyNode;
+    data: {
+        attr: string;
+        element: string;
+        suggestion: string;
+    };
+}>;
+
+/**
+ * @template ElementNode
+ * @template AttributeKeyNode
+ * @template AttributeValueNode
+ * @param {NoInvalidAttrValueOptions} options
+ */
+declare function noInvalidAttrValue<ElementNode, AttributeKeyNode, AttributeValueNode>(options: NoInvalidAttrValueOptions): {
+    /**
+     * @param {ElementNodeAdapter<
+     *   ElementNode,
+     *   AttributeKeyNode,
+     *   AttributeValueNode
+     * >} adapter
+     * @returns {NoInvalidAttrValueResult<
+     *   AttributeKeyNode,
+     *   AttributeValueNode
+     * >}
+     */
+    checkAttributes(adapter: ElementNodeAdapter<ElementNode, AttributeKeyNode, AttributeValueNode>): NoInvalidAttrValueResult<AttributeKeyNode, AttributeValueNode>;
+};
+/**
+ * @type {{
+ *   invalid: "invalid";
+ * }}
+ */
+declare const NO_INVALID_ATTR_VALUE_MESSAGE_IDS: {
+    invalid: "invalid";
+};
+
+/**
+ * @template ElementNode
+ * @template AttributeKeyNode
+ * @template AttributeValueNode
+ * @param {UseBaselineOptions} options
+ */
+declare function useBaseline<ElementNode, AttributeKeyNode, AttributeValueNode>(options: UseBaselineOptions): {
+    /**
+     * @param {ElementNodeAdapter<
+     *   ElementNode,
+     *   AttributeKeyNode,
+     *   AttributeValueNode
+     * >} adapter
+     * @returns {UseBaselineResult<
+     *   ElementNode,
+     *   AttributeKeyNode,
+     *   AttributeValueNode
+     * >}
+     */
+    checkAttributes(adapter: ElementNodeAdapter<ElementNode, AttributeKeyNode, AttributeValueNode>): UseBaselineResult<ElementNode, AttributeKeyNode, AttributeValueNode>;
+};
+/**
+ * @type {{
+ *   noBaselineElement: "noBaselineElement";
+ *   notBaselineElementAttribute: "notBaselineElementAttribute";
+ *   notBaselineGlobalAttribute: "notBaselineGlobalAttribute";
+ * }}
+ */
+declare const USE_BASELINE_MESSAGE_IDS: {
+    noBaselineElement: "noBaselineElement";
+    notBaselineElementAttribute: "notBaselineElementAttribute";
+    notBaselineGlobalAttribute: "notBaselineGlobalAttribute";
+};
+
+/**
+ * @template ElementNode
+ * @template AttributeKeyNode
+ * @template AttributeValueNode
+ */
+declare function noIneffectiveAttrs<ElementNode, AttributeKeyNode, AttributeValueNode>(): {
+    /**
+     * @param {ElementNodeAdapter<
+     *   ElementNode,
+     *   AttributeKeyNode,
+     *   AttributeValueNode
+     * >} adapter
+     * @returns {NoIneffectiveAttrsResult<AttributeKeyNode>}
+     */
+    checkAttributes(adapter: ElementNodeAdapter<ElementNode, AttributeKeyNode, AttributeValueNode>): NoIneffectiveAttrsResult<AttributeKeyNode>;
+};
+/**
+ * @import {
+ *   ElementNodeAdapter,
+ *   NoIneffectiveAttrsResult
+ * } from "../types"
+ */
+/**
+ * @typedef {{
+ *   attr: string;
+ *   when: (adapter: ElementNodeAdapter<any, any, any>) => boolean;
+ *   message: string;
+ * }} AttributeChecker
+ */
+/**
+ * @type {{
+ *   ineffective: "ineffective";
+ * }}
+ */
+declare const NO_INEFFECTIVE_ATTRS_MESSAGE_IDS: {
+    ineffective: "ineffective";
+};
+
+/**
+ * @template ElementNode
+ * @template AttributeKeyNode
+ * @template AttributeValueNode
+ */
+declare function noObsoleteTags<ElementNode, AttributeKeyNode, AttributeValueNode>(): {
+    /**
+     * @param {ElementNodeAdapter<
+     *   ElementNode,
+     *   AttributeKeyNode,
+     *   AttributeValueNode
+     * >} adapter
+     * @returns {NoObsoleteTagsResult<ElementNode>}
+     */
+    checkElement(adapter: ElementNodeAdapter<ElementNode, AttributeKeyNode, AttributeValueNode>): NoObsoleteTagsResult<ElementNode>;
+};
+/**
+ * @type {{
+ *   unexpected: "unexpected";
+ * }}
+ */
+declare const NO_OBSOLETE_TAGS_MESSAGE_IDS: {
+    unexpected: "unexpected";
+};
+
+/**
+ * @template ElementNode
+ * @template AttributeKeyNode
+ * @template AttributeValueNode
+ */
+declare function noObsoleteAttrs<ElementNode, AttributeKeyNode, AttributeValueNode>(): {
+    /**
+     * @param {ElementNodeAdapter<
+     *   ElementNode,
+     *   AttributeKeyNode,
+     *   AttributeValueNode
+     * >} adapter
+     * @returns {NoObsoleteAttrsResult<AttributeKeyNode>}
+     */
+    checkAttributes(adapter: ElementNodeAdapter<ElementNode, AttributeKeyNode, AttributeValueNode>): NoObsoleteAttrsResult<AttributeKeyNode>;
+};
+/**
+ * @type {{
+ *   obsolete: "obsolete";
+ * }}
+ */
+declare const NO_OBSOLETE_ATTRS_MESSAGE_IDS: {
+    obsolete: "obsolete";
+};
+
+export { type AttributeAdapter, type ElementNodeAdapter, NO_INEFFECTIVE_ATTRS_MESSAGE_IDS, NO_INVALID_ATTR_VALUE_MESSAGE_IDS, NO_OBSOLETE_ATTRS_MESSAGE_IDS, NO_OBSOLETE_TAGS_MESSAGE_IDS, type NoIneffectiveAttrsResult, type NoInvalidAttrValueOptions, type NoInvalidAttrValueResult, type NoObsoleteAttrsResult, type NoObsoleteTagsResult, USE_BASELINE_MESSAGE_IDS, type UseBaselineOptions, type UseBaselineResult, noIneffectiveAttrs, noInvalidAttrValue, noObsoleteAttrs, noObsoleteTags, useBaseline };