@markuplint/ml-core 5.0.0-alpha.1 → 5.0.0-alpha.3

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

@@ -81,7 +81,6 @@ export class MLDocument extends MLParentNode {
      * Rules use this as a fallback when their own options do not specify a value.
      */
     ruleCommonSettings;
-    #tokenList = null;
     /**
      * @param ast node list of markuplint AST
      * @param ruleset ruleset object
@@ -108,9 +107,9 @@ export class MLDocument extends MLParentNode {
             return createNode(astNode, this);
         })
             .filter((n) => !!n));
-        this._pretending(options?.pretenders);
+        this.#pretending(options?.pretenders);
         try {
-            this._ruleMapping(ruleset);
+            this.#ruleMapping(ruleset);
         }
         catch (error) {
             if (error instanceof InvalidSelectorError) {
@@ -2040,7 +2039,6 @@ export class MLDocument extends MLParentNode {
      * @implements DOM API: `Document`
      */
     getElementById(elementId) {
-        // TODO:
         return this.querySelector(`#${elementId}`);
     }
     /**
@@ -2088,27 +2086,6 @@ export class MLDocument extends MLParentNode {
     getSelection() {
         throw new UnexpectedCallError('Not supported "getSelection" method');
     }
-    /**
-     * Returns a flat, offset-sorted list of all tokens in the document,
-     * including element close tags. The result is cached after the first call.
-     *
-     * @implements `@markuplint/ml-core` API: `MLDocument`
-     * @returns A frozen array of tokens sorted by their starting offset
-     */
-    getTokenList() {
-        if (this.#tokenList) {
-            return this.#tokenList;
-        }
-        const tokens = [];
-        for (const node of this.nodeList) {
-            tokens.push(node);
-            if (node.is(node.ELEMENT_NODE) && node.closeTag) {
-                tokens.push(node.closeTag);
-            }
-        }
-        this.#tokenList = Object.freeze(tokens.toSorted((a, b) => a.startOffset - b.startOffset));
-        return this.#tokenList;
-    }
     /**
      * **IT THROWS AN ERROR WHEN CALLING THIS.**
      *
@@ -2250,29 +2227,13 @@ export class MLDocument extends MLParentNode {
         throw new UnexpectedCallError('Not supported "startViewTransition" method');
     }
     /**
-     * Returns a string representation of the entire document. When `fixed` is true,
-     * returns the document with all lint fixes applied by substituting
-     * fixed token content at the appropriate offsets.
+     * Returns the raw string representation of the document.
      *
      * @implements `@markuplint/ml-core` API: `MLDocument`
-     * @param fixed - When true, returns the fixed content; otherwise returns the original raw content
      * @returns The string content of the document
      */
-    toString(fixed = false) {
-        if (!fixed) {
-            return this.raw;
-        }
-        let raw = this.raw;
-        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);
-        }
-        return raw;
+    toString() {
+        return this.raw;
     }
     walkOn(type, walker, skipWhenRuleIsDisabled = true) {
         return sequentialWalker(this.nodeList, node => {
@@ -2319,7 +2280,7 @@ export class MLDocument extends MLParentNode {
      *
      * @param pretenders - Optional pretender configurations from the document options
      */
-    _pretending(pretenders) {
+    #pretending(pretenders) {
         if (docLog.enabled) {
             docLog('Pretending: %O', pretenders);
         }
@@ -2336,7 +2297,7 @@ export class MLDocument extends MLParentNode {
      *
      * @param ruleset - The ruleset containing rules, nodeRules, and childNodeRules
      */
-    _ruleMapping(ruleset) {
+    #ruleMapping(ruleset) {
         if (docLog.enabled) {
             docLog('Rule Mapping: %O', Object.keys(ruleset.rules));
         }

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

@@ -28,6 +28,5 @@ export declare class MLDomTokenList extends Array<string> implements DOMTokenLis
     supports(token: string): boolean;
     toString(): string;
     toggle(token: string, force?: boolean): boolean;
-    private _pick;
 }
 export {};

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

@@ -45,7 +45,7 @@ export class MLDomTokenList extends Array {
             if (!token) {
                 break;
             }
-            const loc = this._pick(token, offset);
+            const loc = this.#pick(token, offset);
             if (!loc) {
                 offset = 0;
                 continue;
@@ -74,7 +74,7 @@ export class MLDomTokenList extends Array {
      * @implements `@markuplint/ml-core` API: `MLDomTokenList`
      */
     pick(token) {
-        const r = this._pick(token);
+        const r = this.#pick(token);
         if (!r) {
             return null;
         }
@@ -101,7 +101,7 @@ export class MLDomTokenList extends Array {
     toggle(token, force) {
         throw new UnexpectedCallError('Not supported "toggle" method');
     }
-    _pick(token, _offset = 0) {
+    #pick(token, _offset = 0) {
         token = token.trim().split(/\s+/)[0] ?? '';
         if (!token) {
             return null;

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

@@ -16,5 +16,5 @@ export declare class MLElementCloseTag<T extends RuleConfigValue, O extends Plai
      * @implements `@markuplint/ml-core` API: `MLElement`
      */
     get rawName(): string;
-    toString(fixed?: boolean): string;
+    toString(): string;
 }

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

@@ -23,21 +23,7 @@ export class MLElementCloseTag extends MLNode {
     get rawName() {
         return this._astToken.nodeName;
     }
-    toString(fixed = false) {
-        if (!fixed) {
-            return this.raw;
-        }
-        if (this.nodeName.startsWith('#')) {
-            return this.raw;
-        }
-        if (this.pair.isOmitted) {
-            return this.raw;
-        }
-        return [
-            this.pair.tagOpenChar,
-            this.pair.tagOpenChar === '' ? '' : '/',
-            this.pair.fixedNodeName === this.pair.rawName ? this.rawName : this.pair.fixedNodeName,
-            this.pair.tagCloseChar,
-        ].join('');
+    toString() {
+        return this.raw;
     }
 }

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

@@ -632,13 +632,6 @@ export declare class MLElement<T extends RuleConfigValue, O extends PlainData =
      * @implements DOM API: `Element`
      */
     get enterKeyHint(): string;
-    /**
-     * Returns the fixed (potentially corrected) node name, which may differ from the
-     * original node name after lint fixes such as case normalization.
-     *
-     * @implements `@markuplint/ml-core` API: `MLElement`
-     */
-    get fixedNodeName(): string;
     /**
      * Whether this element has any spread attributes (e.g., `{...props}` in JSX).
      */
@@ -1819,13 +1812,6 @@ export declare class MLElement<T extends RuleConfigValue, O extends PlainData =
      * @implements DOM API: `Element`
      */
     computedStyleMap(): StylePropertyMapReadOnly;
-    /**
-     * Overrides the fixed node name for this element, used when the element's
-     * tag name needs to be corrected during linting (e.g., case normalization).
-     *
-     * @param name - The new node name to set
-     */
-    fixNodeName(name: string): void;
     /**
      * **IT THROWS AN ERROR WHEN CALLING THIS.**
      *
@@ -2252,15 +2238,12 @@ export declare class MLElement<T extends RuleConfigValue, O extends PlainData =
      */
     toNormalizeString(): string;
     /**
-     * Returns a string representation of this element. When `fixed` is true,
-     * returns the element with any lint fixes applied to the tag name,
-     * attributes, and embedded comment nodes.
+     * Returns the raw string representation of this element.
      *
      * @implements `@markuplint/ml-core` API: `MLElement`
-     * @param fixed - When true, returns the fixed content; otherwise returns the original raw content
      * @returns The string content of this element
      */
-    toString(fixed?: boolean): string;
+    toString(): string;
     /**
      * **IT THROWS AN ERROR WHEN CALLING THIS.**
      *

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

@@ -34,7 +34,6 @@ export class MLElement extends MLParentNode {
      * - `authored`:  Authored element (JSX Element etc.) through the view framework or the template engine.
      */
     elementType;
-    #fixedNodeName;
     #getChildElementsAndTextNodeWithoutWhitespacesCache = null;
     /**
      * Whether this element belongs to a non-HTML namespace (e.g., SVG or MathML).
@@ -123,7 +122,6 @@ export class MLElement extends MLParentNode {
         this.elementType = astNode.elementType;
         this.#localName = ns.localName;
         this.isForeignElement = this.namespaceURI !== HTML_NAMESPACE;
-        this.#fixedNodeName = astNode.nodeName;
         this.isOmitted = astNode.isGhost;
         this.tagOpenChar = astNode.tagOpenChar;
         this.tagCloseChar = astNode.tagCloseChar;
@@ -850,15 +848,6 @@ export class MLElement extends MLParentNode {
     get enterKeyHint() {
         throw new UnexpectedCallError('Not supported "enterKeyHint" property');
     }
-    /**
-     * Returns the fixed (potentially corrected) node name, which may differ from the
-     * original node name after lint fixes such as case normalization.
-     *
-     * @implements `@markuplint/ml-core` API: `MLElement`
-     */
-    get fixedNodeName() {
-        return this.#fixedNodeName;
-    }
     /**
      * Whether this element has any spread attributes (e.g., `{...props}` in JSX).
      */
@@ -2385,15 +2374,6 @@ export class MLElement extends MLParentNode {
     computedStyleMap() {
         throw new UnexpectedCallError('Not supported "computedStyleMap" method');
     }
-    /**
-     * Overrides the fixed node name for this element, used when the element's
-     * tag name needs to be corrected during linting (e.g., case normalization).
-     *
-     * @param name - The new node name to set
-     */
-    fixNodeName(name) {
-        this.#fixedNodeName = name;
-    }
     /**
      * **IT THROWS AN ERROR WHEN CALLING THIS.**
      *
@@ -2745,7 +2725,6 @@ export class MLElement extends MLParentNode {
     insertAdjacentElement(where, 
     // eslint-disable-next-line @typescript-eslint/prefer-readonly-parameter-types
     element) {
-        // TODO:
         throw new UnexpectedCallError('Does not implement "insertAdjacentElement" method yet');
     }
     /**
@@ -2756,7 +2735,6 @@ export class MLElement extends MLParentNode {
      * @see https://w3c.github.io/DOM-Parsing/#widl-Element-insertAdjacentHTML-void-DOMString-position-DOMString-text
      */
     insertAdjacentHTML(position, text) {
-        // TODO:
         throw new UnexpectedCallError('Does not implement "insertAdjacentHTML" method yet');
     }
     /**
@@ -2767,7 +2745,6 @@ export class MLElement extends MLParentNode {
      * @see https://dom.spec.whatwg.org/#dom-element-insertadjacenttext
      */
     insertAdjacentText(where, data) {
-        // TODO:
         throw new UnexpectedCallError('Does not implement "insertAdjacentText" method yet');
     }
     /**
@@ -3176,52 +3153,13 @@ export class MLElement extends MLParentNode {
         return normalizedString;
     }
     /**
-     * Returns a string representation of this element. When `fixed` is true,
-     * returns the element with any lint fixes applied to the tag name,
-     * attributes, and embedded comment nodes.
+     * Returns the raw string representation of this element.
      *
      * @implements `@markuplint/ml-core` API: `MLElement`
-     * @param fixed - When true, returns the fixed content; otherwise returns the original raw content
      * @returns The string content of this element
      */
-    toString(fixed = false) {
-        if (!fixed) {
-            return this.raw;
-        }
-        if (this.pretenderContext?.type === 'pretender') {
-            return this.raw;
-        }
-        if (this.nodeName.startsWith('#')) {
-            return this.raw;
-        }
-        if (this.isOmitted) {
-            return this.raw;
-        }
-        let raw = this.raw;
-        let offset = 0;
-        const overriddenCommentNodes = 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,
-            },
-            ...overriddenCommentNodes,
-            ...this.attributes,
-        ];
-        for (const node of nodes) {
-            const before = raw.slice(0, node.startOffset + offset - this.startOffset);
-            const rawCode = node.toString(true);
-            const after = raw.slice(node.endOffset + offset - this.startOffset);
-            raw = before + rawCode + after;
-            offset += rawCode.length - (node.endOffset - node.startOffset);
-        }
-        return raw;
+    toString() {
+        return this.raw;
     }
     /**
      * **IT THROWS AN ERROR WHEN CALLING THIS.**

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

@@ -2,7 +2,7 @@ import type { MLASTToken } from '@markuplint/ml-ast';
 /**
  * Represents a single token in the markuplint AST.
  * Wraps an AST token with positional information (line, column, offset)
- * and provides both raw and fixed string representations.
+ * and provides the raw string representation.
  *
  * @template A - The AST token type this token wraps
  */
@@ -40,12 +40,6 @@ export declare class MLToken<A extends MLASTToken = MLASTToken> {
      * @implements `@markuplint/ml-core` API: `MLDOMToken`
      */
     get endOffset(): number;
-    /**
-     * The fixed (potentially modified) string content of this token.
-     *
-     * @implements `@markuplint/ml-core` API: `MLDOMToken`
-     */
-    get fixed(): string;
     /**
      * The original raw string content of this token from the source.
      *
@@ -71,19 +65,10 @@ export declare class MLToken<A extends MLASTToken = MLASTToken> {
      */
     get startOffset(): number;
     /**
-     * Replaces the fixed content of this token with the given string,
-     * used when applying lint fixes.
-     *
-     * @implements `@markuplint/ml-core` API: `MLDOMToken`
-     * @param raw - The new string content to set as the fixed value
-     */
-    fix(raw: string): void;
-    /**
-     * Returns the string representation of this token.
+     * Returns the raw string representation of this token.
      *
      * @implements `@markuplint/ml-core` API: `MLDOMToken`
-     * @param fixed - When true, returns the fixed content; otherwise returns the original raw content
      * @returns The string content of this token
      */
-    toString(fixed?: boolean): string;
+    toString(): string;
 }

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

@@ -2,12 +2,11 @@ import { getEndCol, getEndLine } from '@markuplint/parser-utils/location';
 /**
  * Represents a single token in the markuplint AST.
  * Wraps an AST token with positional information (line, column, offset)
- * and provides both raw and fixed string representations.
+ * and provides the raw string representation.
  *
  * @template A - The AST token type this token wraps
  */
 export class MLToken {
-    #fixed;
     #raw;
     /**
      * The unique identifier for this token.
@@ -25,7 +24,6 @@ export class MLToken {
     constructor(astToken) {
         this._astToken = astToken;
         this.#raw = astToken.raw;
-        this.#fixed = astToken.raw;
         this.uuid = astToken.uuid;
     }
     /**
@@ -34,7 +32,7 @@ export class MLToken {
      * @implements `@markuplint/ml-core` API: `MLDOMToken`
      */
     get endCol() {
-        return getEndCol(this.fixed, this.startCol);
+        return getEndCol(this.raw, this.startCol);
     }
     /**
      * The ending line number (1-based) of this token in the source.
@@ -42,7 +40,7 @@ export class MLToken {
      * @implements `@markuplint/ml-core` API: `MLDOMToken`
      */
     get endLine() {
-        return getEndLine(this.fixed, this.startLine);
+        return getEndLine(this.raw, this.startLine);
     }
     /**
      * The ending character offset (0-based) of this token in the source.
@@ -50,15 +48,7 @@ export class MLToken {
      * @implements `@markuplint/ml-core` API: `MLDOMToken`
      */
     get endOffset() {
-        return this.startOffset + this.fixed.length;
-    }
-    /**
-     * The fixed (potentially modified) string content of this token.
-     *
-     * @implements `@markuplint/ml-core` API: `MLDOMToken`
-     */
-    get fixed() {
-        return this.#fixed;
+        return this.startOffset + this.raw.length;
     }
     /**
      * The original raw string content of this token from the source.
@@ -93,23 +83,12 @@ export class MLToken {
         return this._astToken.offset;
     }
     /**
-     * Replaces the fixed content of this token with the given string,
-     * used when applying lint fixes.
+     * Returns the raw string representation of this token.
      *
      * @implements `@markuplint/ml-core` API: `MLDOMToken`
-     * @param raw - The new string content to set as the fixed value
-     */
-    fix(raw) {
-        this.#fixed = raw;
-    }
-    /**
-     * Returns the string representation of this token.
-     *
-     * @implements `@markuplint/ml-core` API: `MLDOMToken`
-     * @param fixed - When true, returns the fixed content; otherwise returns the original raw content
      * @returns The string content of this token
      */
-    toString(fixed = false) {
-        return fixed ? this.#fixed : this.#raw;
+    toString() {
+        return this.#raw;
     }
 }

package/lib/ml-rule/index.d.ts

@@ -1,3 +1,4 @@
 export * from './create-rule.js';
 export * from './ml-rule.js';
+export * from './rule-fixer.js';
 export * from './types.js';

package/lib/ml-rule/index.js

@@ -1,3 +1,4 @@
 export * from './create-rule.js';
 export * from './ml-rule.js';
+export * from './rule-fixer.js';
 export * from './types.js';

package/lib/ml-rule/ml-rule-context.d.ts

@@ -8,40 +8,12 @@ export declare class MLRuleContext<T extends RuleConfigValue, O extends PlainDat
     readonly locale: string;
     readonly translate: Translator;
     constructor(document: MLDocument<T, O>, locale: LocaleSet);
-    get reports(): ({
-        message: string;
-        line: number;
-        col: number;
-        raw: string;
-    } | {
-        message: string;
-        scope: import("@markuplint/ml-config").Scope<T, O>;
-    } | {
-        message: string;
-        scope: import("@markuplint/ml-config").Scope<T, O>;
-        line: number;
-        col: number;
-        raw: string;
-    })[];
+    get reports(): Report<T, O>[];
     provide(): {
         document: MLDocument<T, O>;
         translate: Translator;
         t: Translator;
-        reports: ({
-            message: string;
-            line: number;
-            col: number;
-            raw: string;
-        } | {
-            message: string;
-            scope: import("@markuplint/ml-config").Scope<T, O>;
-        } | {
-            message: string;
-            scope: import("@markuplint/ml-config").Scope<T, O>;
-            line: number;
-            col: number;
-            raw: string;
-        })[];
+        reports: Report<T, O>[];
         report: {
             (report: Report<T, O>): undefined;
             (report: CheckerReport<T, O>): boolean;
@@ -49,5 +21,4 @@ export declare class MLRuleContext<T extends RuleConfigValue, O extends PlainDat
     };
     report(report: Report<T, O>): undefined;
     report(report: CheckerReport<T, O>): boolean;
-    private _push;
 }

package/lib/ml-rule/ml-rule-context.js

@@ -3,6 +3,7 @@ export class MLRuleContext {
     document;
     locale;
     #reports = [];
+    #reportKeys = new Set();
     translate;
     constructor(
     // eslint-disable-next-line @typescript-eslint/prefer-readonly-parameter-types
@@ -12,10 +13,7 @@ export class MLRuleContext {
         this.locale = locale.locale;
     }
     get reports() {
-        return this.#reports.map(report => ({
-            ...report,
-            message: finish(report.message, this.locale),
-        }));
+        return this.#reports;
     }
     provide() {
         return {
@@ -30,16 +28,21 @@ export class MLRuleContext {
         if (typeof report === 'function') {
             const r = report(this.translate);
             if (r) {
-                this._push(r);
+                this.#push(r);
                 return true;
             }
             return false;
         }
-        this._push(report);
+        this.#push(report);
     }
-    _push(report) {
-        if (!this.#reports.some(r => is(r, report))) {
-            this.#reports.push(report);
+    #push(report) {
+        const key = reportKey(report);
+        if (!this.#reportKeys.has(key)) {
+            this.#reportKeys.add(key);
+            this.#reports.push({
+                ...report,
+                message: finish(report.message, this.locale),
+            });
         }
     }
 }
@@ -51,15 +54,12 @@ function finish(message, locale = 'en') {
     }
     return message;
 }
-function is(r1, r2) {
-    if ('col' in r1 && 'col' in r2) {
-        return r1.col === r2.col && r1.line === r2.line && r1.message === r2.message && r1.raw === r2.raw;
+function reportKey(report) {
+    if ('col' in report && report.col != null) {
+        return `${report.line}:${report.col}:${report.message}:${report.raw}`;
     }
-    if ('scope' in r1) {
-        if (!('scope' in r2)) {
-            return false;
-        }
-        return r1.scope === r2.scope && r1.message === r2.message;
+    if ('scope' in report) {
+        return `${report.scope.startLine}:${report.scope.startCol}:${report.message}`;
     }
-    return false;
+    return report.message;
 }

package/lib/ml-rule/ml-rule.d.ts

@@ -12,7 +12,7 @@ import type { GlobalRuleInfo, SpecConformance, PlainData, Rule, RuleConfigValue,
 export declare class MLRule<T extends RuleConfigValue, O extends PlainData = undefined> {
     #private;
     /**
-     * For virtual rules, the name of the base rule whose verify/fix logic is reused.
+     * For virtual rules, the name of the base rule whose verify logic is reused.
      * When set, violations report this as `ruleId` for backwards compatibility.
      */
     readonly baseRuleId?: string;
@@ -37,24 +37,19 @@ export declare class MLRule<T extends RuleConfigValue, O extends PlainData = und
         readonly groupName?: string;
     });
     /**
-     * Creates a virtual rule that reuses this rule's verify/fix logic
+     * Creates a virtual rule that reuses this rule's verify logic
      * under a different name (alias). Used by named nodeRules to produce
      * independent rule instances that can be individually configured.
      *
      * @param aliasName - The alias name (must contain `/`)
      * @param options - Override options for the virtual rule
-     * @returns A new MLRule instance sharing the same verify/fix logic
+     * @returns A new MLRule instance sharing the same verify logic
      */
     createAlias(aliasName: string, options?: {
         readonly defaultSeverity?: Severity;
         readonly specConformance?: SpecConformance;
         readonly groupName?: string;
     }): MLRule<T, O>;
-    /**
-     * The following getter is unused internally,
-     * only for extending from 3rd party library
-     */
-    protected get f(): RuleSeed<T, O>['fix'];
     /**
      * The following getter is unused internally,
      * only for extending from 3rd party library
@@ -78,16 +73,16 @@ export declare class MLRule<T extends RuleConfigValue, O extends PlainData = und
      */
     optimizeOption(configSettings: Rule<T, O> | null | undefined): RuleInfo<T, O>;
     /**
-     * Executes this rule's verify (and optionally fix) function against a document,
+     * Executes this rule's verify function against a document,
      * then collects and returns the resulting violations.
+     * When `fix` is true, fix callbacks on reports are executed to produce {@link FixData}.
      *
      * @param document - The parsed document to verify
      * @param locale - The locale set for translating violation messages
-     * @param fix - Whether to also run the fix function
+     * @param fix - Whether to execute fix callbacks and attach FixData to violations
      * @returns An array of violations found by this rule
      */
     verify(document: MLDocument<T, O>, locale: LocaleSet, fix: boolean): Promise<Violation[]>;
-    private _optimize;
 }
 /**
  * An MLRule with any value and option types. Used when the specific types are not known.