@markuplint/ml-core 4.0.2 → 4.1.0

package/lib/ml-core.d.ts

@@ -10,7 +10,7 @@ export type MLCoreParams = {
 export declare class MLCore {
     #private;
     constructor({ parser, sourceCode, ruleset, rules, locale, schemas, parserOptions, pretenders, filename, debug, configErrors, }: MLCoreParams);
-    get document(): Document<RuleConfigValue, PlainData> | ParserError;
+    get document(): ParserError | Document<RuleConfigValue, PlainData>;
     setCode(sourceCode: string): void;
     update({ parser, ruleset, rules, locale, schemas, parserOptions, configErrors }: Partial<MLFabric>): void;
     verify(fix?: boolean): Promise<Violation[]>;

package/lib/ml-dom/manipulations/child-node-methods.js

@@ -48,14 +48,12 @@ node) {
 export function previousElementSibling(
 // eslint-disable-next-line @typescript-eslint/prefer-readonly-parameter-types
 node) {
-    let prevNode = node.prevNode;
+    let prevNode = node.previousSibling;
     while (prevNode) {
-        if (((node.parentNode === null && prevNode.parentNode === null) ||
-            node.parentNode?.uuid === prevNode.parentNode?.uuid) &&
-            prevNode.is(prevNode.ELEMENT_NODE)) {
+        if (prevNode.is(prevNode.ELEMENT_NODE)) {
             return prevNode;
         }
-        prevNode = prevNode.prevNode;
+        prevNode = prevNode.previousSibling;
     }
     return null;
 }
@@ -66,14 +64,12 @@ node) {
 export function nextElementSibling(
 // eslint-disable-next-line @typescript-eslint/prefer-readonly-parameter-types
 node) {
-    let nextNode = node.nextNode;
+    let nextNode = node.nextSibling;
     while (nextNode) {
-        if (((node.parentNode === null && nextNode.parentNode === null) ||
-            node.parentNode?.uuid === nextNode.parentNode?.uuid) &&
-            nextNode.is(nextNode.ELEMENT_NODE)) {
+        if (nextNode.is(nextNode.ELEMENT_NODE)) {
             return nextNode;
         }
-        nextNode = nextNode.nextNode;
+        nextNode = nextNode.nextSibling;
     }
     return null;
 }

package/lib/ml-dom/node/child-node.d.ts

@@ -1,9 +1,18 @@
 import type { MLBlock } from './block.js';
 import type { MLCharacterData } from './character-data.js';
-import type { MLComment } from './comment.js';
+import type { MLDocumentType } from './document-type.js';
 import type { MLElement } from './element.js';
 import type { MLNode } from './node.js';
-import type { MLText } from './text.js';
 import type { PlainData, RuleConfigValue } from '@markuplint/ml-config';
-export type MLChildNode<T extends RuleConfigValue, O extends PlainData = undefined> = MLCharacterData<T, O> | MLComment<T, O> | MLText<T, O> | MLElement<T, O> | MLBlock<T, O>;
+/**
+ * > Element includes NonDocumentTypeChildNode;
+ * > CharacterData includes NonDocumentTypeChildNode;
+ *
+ * > DocumentType includes ChildNode;
+ * > Element includes ChildNode;
+ * > CharacterData includes ChildNode;
+ *
+ * @see https://dom.spec.whatwg.org/#idl-index
+ */
+export type MLChildNode<T extends RuleConfigValue, O extends PlainData = undefined> = MLDocumentType<T, O> | MLCharacterData<T, O> | MLElement<T, O> | MLBlock<T, O>;
 export declare function isChildNode<T extends RuleConfigValue, O extends PlainData = undefined>(node: MLNode<T, O>): node is MLChildNode<T, O>;

package/lib/ml-dom/node/child-node.js

@@ -2,6 +2,8 @@ export function isChildNode(
 // eslint-disable-next-line @typescript-eslint/prefer-readonly-parameter-types
 node) {
     return (node.is(node.DOCUMENT_TYPE_NODE) ||
+        node.is(node.CDATA_SECTION_NODE) ||
+        node.is(node.COMMENT_NODE) ||
         node.is(node.TEXT_NODE) ||
         node.is(node.ELEMENT_NODE) ||
         node.is(node.MARKUPLINT_PREPROCESSOR_BLOCK));

package/lib/ml-dom/node/document.js

@@ -2097,6 +2097,9 @@ export class MLDocument extends MLParentNode {
         let offset = 0;
         for (const node of this.getTokenList()) {
             const nodeRaw = node.toString(true);
+            if (nodeRaw === node.raw) {
+                continue;
+            }
             raw = raw.slice(0, node.startOffset + offset) + nodeRaw + raw.slice(node.endOffset + offset);
             offset += nodeRaw.length - (node.endOffset - node.startOffset);
         }

package/lib/ml-dom/node/element-close-tag.js

@@ -26,6 +26,9 @@ export class MLElementCloseTag extends MLNode {
         if (!fixed) {
             return this.raw;
         }
+        if (this.nodeName.startsWith('#')) {
+            return this.raw;
+        }
         if (this.pair.isOmitted) {
             return this.raw;
         }

package/lib/ml-dom/node/element.d.ts

@@ -1785,7 +1785,7 @@ export declare class MLElement<T extends RuleConfigValue, O extends PlainData =
      * @implements DOM API: `Element`
      * @see https://dom.spec.whatwg.org/#ref-for-dom-element-matches%E2%91%A0
      */
-    matches(selector: string): boolean;
+    matches(selector: string, scope?: MLParentNode<T, O>): boolean;
     /**
      * Pretenders Initialization
      */

package/lib/ml-dom/node/element.js

@@ -2423,10 +2423,12 @@ export class MLElement extends MLParentNode {
      * @implements DOM API: `Element`
      * @see https://dom.spec.whatwg.org/#ref-for-dom-element-matches%E2%91%A0
      */
-    matches(selector) {
+    matches(selector, 
+    // eslint-disable-next-line @typescript-eslint/prefer-readonly-parameter-types
+    scope) {
         return (createSelector(selector, this.ownerMLDocument.specs).match(
         // Prioritize the pretender
-        this.pretenderContext?.type === 'pretender' ? this.pretenderContext.as : this) !== false);
+        this.pretenderContext?.type === 'pretender' ? this.pretenderContext.as : this, scope) !== false);
     }
     /**
      * Pretenders Initialization
@@ -2756,12 +2758,19 @@ export class MLElement extends MLParentNode {
         }
         let raw = this.raw;
         let offset = 0;
+        const overlayedCommentNodes = this.ownerMLDocument.nodeList.filter(node => {
+            if (node.is(node.COMMENT_NODE)) {
+                return this.startOffset < node.startOffset && node.endOffset < this.endOffset;
+            }
+            return false;
+        });
         const nodes = [
             {
                 toString: () => this.tagOpenChar + this.fixedNodeName,
                 startOffset: this.startOffset,
                 endOffset: this.startOffset + this.tagOpenChar.length + this.nodeName.length,
             },
+            ...overlayedCommentNodes,
             ...this.attributes,
         ];
         for (const node of nodes) {

package/lib/ml-dom/node/node.d.ts

@@ -158,13 +158,12 @@ export declare abstract class MLNode<T extends RuleConfigValue, O extends PlainD
      */
     get nextNode(): MLNode<T, O> | null;
     /**
-     * **IT THROWS AN ERROR WHEN CALLING THIS.**
+     * The next sibling of an object is its first following sibling or null if it has no following sibling.
      *
-     * @unsupported
      * @implements DOM API: `Node`
-     * @see https://dom.spec.whatwg.org/#ref-for-dom-node-nextsibling%E2%91%A0
+     * @see https://dom.spec.whatwg.org/#concept-tree-next-sibling
      */
-    get nextSibling(): ChildNode | null;
+    get nextSibling(): MLChildNode<T, O> | null;
     /**
      * **IT THROWS AN ERROR WHEN CALLING THIS.**
      *
@@ -263,13 +262,12 @@ export declare abstract class MLNode<T extends RuleConfigValue, O extends PlainD
      */
     get prevToken(): MLNode<T, O> | null;
     /**
-     * **IT THROWS AN ERROR WHEN CALLING THIS.**
+     * The previous sibling of an object is its first preceding sibling or null if it has no preceding sibling.
      *
-     * @unsupported
      * @implements DOM API: `Node`
-     * @see https://dom.spec.whatwg.org/#ref-for-dom-node-previoussibling%E2%91%A0
+     * @see https://dom.spec.whatwg.org/#concept-tree-previous-sibling
      */
-    get previousSibling(): ChildNode | null;
+    get previousSibling(): MLChildNode<T, O> | null;
     /**
      * @implements `@markuplint/ml-core` API: `MLNode`
      */
@@ -356,13 +354,12 @@ export declare abstract class MLNode<T extends RuleConfigValue, O extends PlainD
      */
     compareDocumentPosition(other: Node): number;
     /**
-     * **IT THROWS AN ERROR WHEN CALLING THIS.**
+     * Returns true if other is an inclusive descendant of node; otherwise false.
      *
-     * @unsupported
      * @implements DOM API: `Node`
      * @see https://dom.spec.whatwg.org/#ref-for-dom-node-contains%E2%91%A0
      */
-    contains(other: Node | null): boolean;
+    contains(other: MLNode<T, O> | null): boolean;
     /**
      * **IT THROWS AN ERROR WHEN CALLING THIS.**
      *
@@ -371,6 +368,14 @@ export declare abstract class MLNode<T extends RuleConfigValue, O extends PlainD
      * @see https://dom.spec.whatwg.org/#ref-for-dom-eventtarget-dispatchevent%E2%91%A2
      */
     dispatchEvent(event: Event): boolean;
+    /**
+     * Finds subsequent nodes that match the given selector.
+     *
+     * @implements `@markuplint/ml-core` API: `MLNode`
+     * @param selector - Optional selector to filter the nodes.
+     * @returns An array of matched child nodes.
+     */
+    findSubsequentNodes(selector?: string): MLChildNode<T, O>[];
     /**
      * **IT THROWS AN ERROR WHEN CALLING THIS.**
      *

package/lib/ml-dom/node/node.js

@@ -234,14 +234,22 @@ export class MLNode extends MLToken {
         return siblings[index + 1] ?? null;
     }
     /**
-     * **IT THROWS AN ERROR WHEN CALLING THIS.**
+     * The next sibling of an object is its first following sibling or null if it has no following sibling.
      *
-     * @unsupported
      * @implements DOM API: `Node`
-     * @see https://dom.spec.whatwg.org/#ref-for-dom-node-nextsibling%E2%91%A0
+     * @see https://dom.spec.whatwg.org/#concept-tree-next-sibling
      */
     get nextSibling() {
-        throw new UnexpectedCallError('Not supported "nextSibling" property');
+        let nextNode = this.nextNode;
+        while (nextNode) {
+            if (isChildNode(nextNode) &&
+                ((this.parentNode === null && nextNode.parentNode === null) ||
+                    this.parentNode?.uuid === nextNode.parentNode?.uuid)) {
+                return nextNode;
+            }
+            nextNode = nextNode.nextNode;
+        }
+        return null;
     }
     /**
      * **IT THROWS AN ERROR WHEN CALLING THIS.**
@@ -406,14 +414,22 @@ export class MLNode extends MLToken {
         return __classPrivateFieldGet(this, _MLNode_prevToken, "f") ?? null;
     }
     /**
-     * **IT THROWS AN ERROR WHEN CALLING THIS.**
+     * The previous sibling of an object is its first preceding sibling or null if it has no preceding sibling.
      *
-     * @unsupported
      * @implements DOM API: `Node`
-     * @see https://dom.spec.whatwg.org/#ref-for-dom-node-previoussibling%E2%91%A0
+     * @see https://dom.spec.whatwg.org/#concept-tree-previous-sibling
      */
     get previousSibling() {
-        throw new UnexpectedCallError('Not supported "previousSibling" property');
+        let prevNode = this.prevNode;
+        while (prevNode) {
+            if (isChildNode(prevNode) &&
+                ((this.parentNode === null && prevNode.parentNode === null) ||
+                    this.parentNode?.uuid === prevNode.parentNode?.uuid)) {
+                return prevNode;
+            }
+            prevNode = prevNode.prevNode;
+        }
+        return null;
     }
     /**
      * @implements `@markuplint/ml-core` API: `MLNode`
@@ -535,16 +551,20 @@ export class MLNode extends MLToken {
         throw new UnexpectedCallError('Not supported "compareDocumentPosition" method');
     }
     /**
-     * **IT THROWS AN ERROR WHEN CALLING THIS.**
+     * Returns true if other is an inclusive descendant of node; otherwise false.
      *
-     * @unsupported
      * @implements DOM API: `Node`
      * @see https://dom.spec.whatwg.org/#ref-for-dom-node-contains%E2%91%A0
      */
     contains(
     // eslint-disable-next-line @typescript-eslint/prefer-readonly-parameter-types
     other) {
-        throw new UnexpectedCallError('Not supported "contains" method');
+        for (const childNode of this.childNodes) {
+            if (other?.uuid === childNode.uuid || childNode.contains(other)) {
+                return true;
+            }
+        }
+        return false;
     }
     /**
      * **IT THROWS AN ERROR WHEN CALLING THIS.**
@@ -558,6 +578,34 @@ export class MLNode extends MLToken {
     event) {
         throw new UnexpectedCallError('Not supported "dispatchEvent" method');
     }
+    /**
+     * Finds subsequent nodes that match the given selector.
+     *
+     * @implements `@markuplint/ml-core` API: `MLNode`
+     * @param selector - Optional selector to filter the nodes.
+     * @returns An array of matched child nodes.
+     */
+    findSubsequentNodes(selector) {
+        const matched = [];
+        for (const node of this.ownerMLDocument.nodeList) {
+            if (node.endOffset <= this.endOffset) {
+                continue;
+            }
+            if (this.contains(node)) {
+                continue;
+            }
+            if (selector) {
+                if (node.is(node.ELEMENT_NODE) && node.matches(selector)) {
+                    matched.push(node);
+                }
+                continue;
+            }
+            if (isChildNode(node)) {
+                matched.push(node);
+            }
+        }
+        return matched;
+    }
     /**
      * **IT THROWS AN ERROR WHEN CALLING THIS.**
      *

package/lib/ml-dom/node/parent-node.js

@@ -106,7 +106,7 @@ export class MLParentNode extends MLNode {
             return selected;
         }
         const elements = toNodeList(this._descendantsToArray(node => {
-            if (node.is(node.ELEMENT_NODE) && node.matches(selectors)) {
+            if (node.is(node.ELEMENT_NODE) && node.matches(selectors, this)) {
                 return node;
             }
         }));

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@markuplint/ml-core",
-	"version": "4.0.2",
+	"version": "4.1.0",
 	"description": "The core module of markuplint",
 	"repository": "git@github.com:markuplint/markuplint.git",
 	"author": "Yusuke Hirao <yusukehirao@me.com>",
@@ -28,19 +28,19 @@
 		"./lib/configs.js": "./lib/configs.browser.js"
 	},
 	"dependencies": {
-		"@markuplint/config-presets": "4.0.1",
-		"@markuplint/html-parser": "4.0.0",
-		"@markuplint/html-spec": "4.0.1",
-		"@markuplint/i18n": "4.0.0",
-		"@markuplint/ml-ast": "4.0.0",
-		"@markuplint/ml-config": "4.0.0",
-		"@markuplint/ml-spec": "4.0.0",
-		"@markuplint/parser-utils": "4.0.0",
-		"@markuplint/selector": "4.0.0",
+		"@markuplint/config-presets": "4.1.0",
+		"@markuplint/html-parser": "4.1.0",
+		"@markuplint/html-spec": "4.1.0",
+		"@markuplint/i18n": "4.1.0",
+		"@markuplint/ml-ast": "4.0.1",
+		"@markuplint/ml-config": "4.1.0",
+		"@markuplint/ml-spec": "4.0.1",
+		"@markuplint/parser-utils": "4.1.0",
+		"@markuplint/selector": "4.1.0",
 		"@types/debug": "^4.1.12",
 		"debug": "^4.3.4",
 		"is-plain-object": "^5.0.0",
 		"type-fest": "^4.10.2"
 	},
-	"gitHead": "b21d44dd0ac6b0e8be0201b92062e4b115fbc880"
+	"gitHead": "b9817c30c2df71faa866e3b3fe286afa499deede"
 }