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

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

@@ -1,7 +1,9 @@
-import { deleteUndefProp } from '@markuplint/ml-config';
 // @ts-ignore
 import { isPlainObject } from 'is-plain-object';
+import { RuleFixer } from './rule-fixer.js';
 import { MLRuleContext } from './ml-rule-context.js';
+// Stateless — safe to share across all rule instances
+const sharedFixer = new RuleFixer();
 /**
  * Represents a single markuplint rule that can verify documents and report violations.
  *
@@ -10,14 +12,13 @@ import { MLRuleContext } from './ml-rule-context.js';
  */
 export class MLRule {
     /**
-     * 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.
      */
     baseRuleId;
     defaultOptions;
     defaultSeverity;
     defaultValue;
-    #f;
     /**
      * For multi-entry named nodeRules, the group name shared by all derived virtual rules.
      * Allows `rules["groupName"]: false` to disable all rules in the group.
@@ -42,16 +43,15 @@ export class MLRule {
         this.defaultValue = (o.defaultValue === undefined ? true : o.defaultValue);
         this.defaultOptions = o.defaultOptions;
         this.#v = o.verify;
-        this.#f = o.fix;
     }
     /**
-     * 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, options) {
         return new MLRule({
@@ -63,16 +63,8 @@ export class MLRule {
             defaultValue: this.defaultValue,
             defaultOptions: this.defaultOptions,
             verify: this.#v,
-            fix: this.#f,
         });
     }
-    /**
-     * The following getter is unused internally,
-     * only for extending from 3rd party library
-     */
-    get f() {
-        return this.#f;
-    }
     /**
      * The following getter is unused internally,
      * only for extending from 3rd party library
@@ -89,11 +81,11 @@ export class MLRule {
      * @returns The global rule info with node and child-node overrides
      */
     getRuleInfo(ruleSet, ruleName) {
-        const info = this._optimize(ruleSet.rules, ruleName);
+        const info = this.#optimize(ruleSet.rules, ruleName);
         return {
             ...info,
-            nodeRules: ruleSet.nodeRules.map(r => this._optimize(r.rules, ruleName)).filter(r => !r.disabled),
-            childNodeRules: ruleSet.childNodeRules.map(r => this._optimize(r.rules, ruleName)).filter(r => !r.disabled),
+            nodeRules: ruleSet.nodeRules.map(r => this.#optimize(r.rules, ruleName)).filter(r => !r.disabled),
+            childNodeRules: ruleSet.childNodeRules.map(r => this.#optimize(r.rules, ruleName)).filter(r => !r.disabled),
         };
     }
     /**
@@ -135,12 +127,13 @@ export class MLRule {
         };
     }
     /**
-     * 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
      */
     async verify(
@@ -150,13 +143,19 @@ export class MLRule {
         const context = new MLRuleContext(document, locale);
         const providableContext = context.provide();
         await this.#v(providableContext);
-        if (this.#f && fix) {
-            await this.#f(providableContext);
-        }
         const ruleId = this.baseRuleId ?? this.name;
         // Only include name and specConformance for virtual rules (named nodeRules)
         const aliasName = this.baseRuleId ? this.name : undefined;
-        const violation = context.reports.map(report => {
+        const violations = context.reports.map(report => {
+            // Execute fix callback if fix mode is enabled
+            let fixData;
+            if (fix && report.fix) {
+                const edits = report.fix(sharedFixer);
+                const editArray = Array.isArray(edits) ? edits : [edits];
+                if (editArray.length > 0) {
+                    fixData = { edits: editArray };
+                }
+            }
             if ('scope' in report) {
                 let line = report.scope.startLine;
                 let col = report.scope.startCol;
@@ -166,38 +165,38 @@ export class MLRule {
                     col = report.col;
                     raw = report.raw;
                 }
-                const violation = {
+                return {
                     severity: report.scope.rule.severity,
                     message: report.message,
                     line,
                     col,
                     raw,
                     ruleId,
-                    name: aliasName,
-                    specConformance: this.specConformance,
-                    reason: report.scope.rule.reason ?? document.rule.reason,
+                    ...(aliasName != null && { name: aliasName }),
+                    ...(this.specConformance != null && { specConformance: this.specConformance }),
+                    ...((report.scope.rule.reason ?? document.rule.reason)
+                        ? { reason: report.scope.rule.reason ?? document.rule.reason }
+                        : {}),
+                    ...(fixData != null && { fix: fixData }),
                 };
-                deleteUndefProp(violation);
-                return violation;
             }
-            const violation = {
+            return {
                 severity: document.rule.severity,
                 message: report.message,
                 line: report.line,
                 col: report.col,
                 raw: report.raw,
                 ruleId,
-                name: aliasName,
-                specConformance: this.specConformance,
-                reason: document.rule.reason,
+                ...(aliasName != null && { name: aliasName }),
+                ...(this.specConformance != null && { specConformance: this.specConformance }),
+                ...(document.rule.reason ? { reason: document.rule.reason } : {}),
+                ...(fixData != null && { fix: fixData }),
             };
-            deleteUndefProp(violation);
-            return violation;
         });
         document.setRule(null);
-        return violation;
+        return violations;
     }
-    _optimize(rules, ruleName) {
+    #optimize(rules, ruleName) {
         const rule = (rules?.[ruleName] ?? false);
         const info = this.optimizeOption(rule);
         return info;

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

@@ -0,0 +1,20 @@
+import type { FixToken, IRuleFixer, TextEdit } from '@markuplint/ml-config';
+/**
+ * Stateless implementation of {@link IRuleFixer}.
+ * Provides helper methods for building {@link TextEdit} objects
+ * inside rule fix callbacks.
+ */
+export declare class RuleFixer implements IRuleFixer {
+    /** @see {@link IRuleFixer.replaceText} */
+    replaceText(token: FixToken, text: string): TextEdit;
+    /** @see {@link IRuleFixer.replaceRange} */
+    replaceRange(range: readonly [number, number], text: string): TextEdit;
+    /** @see {@link IRuleFixer.insertBefore} */
+    insertBefore(token: Pick<FixToken, 'startOffset'>, text: string): TextEdit;
+    /** @see {@link IRuleFixer.insertAfter} */
+    insertAfter(token: FixToken, text: string): TextEdit;
+    /** @see {@link IRuleFixer.remove} */
+    remove(token: FixToken): TextEdit;
+    /** @see {@link IRuleFixer.removeRange} */
+    removeRange(range: readonly [number, number]): TextEdit;
+}

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

@@ -0,0 +1,38 @@
+/**
+ * Stateless implementation of {@link IRuleFixer}.
+ * Provides helper methods for building {@link TextEdit} objects
+ * inside rule fix callbacks.
+ */
+export class RuleFixer {
+    /** @see {@link IRuleFixer.replaceText} */
+    replaceText(token, text) {
+        return {
+            range: [token.startOffset, token.startOffset + token.raw.length],
+            text,
+        };
+    }
+    /** @see {@link IRuleFixer.replaceRange} */
+    replaceRange(range, text) {
+        return { range, text };
+    }
+    /** @see {@link IRuleFixer.insertBefore} */
+    insertBefore(token, text) {
+        return { range: [token.startOffset, token.startOffset], text };
+    }
+    /** @see {@link IRuleFixer.insertAfter} */
+    insertAfter(token, text) {
+        const end = token.startOffset + token.raw.length;
+        return { range: [end, end], text };
+    }
+    /** @see {@link IRuleFixer.remove} */
+    remove(token) {
+        return {
+            range: [token.startOffset, token.startOffset + token.raw.length],
+            text: '',
+        };
+    }
+    /** @see {@link IRuleFixer.removeRange} */
+    removeRange(range) {
+        return { range, text: '' };
+    }
+}

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

@@ -3,7 +3,7 @@ import type { Attr, Element } from '../ml-dom/index.js';
 import type { Translator } from '@markuplint/i18n';
 import type { PlainData, Report, RuleConfigValue, Severity } from '@markuplint/ml-config';
 /**
- * The definition of a markuplint rule, including verification logic, optional fix logic,
+ * The definition of a markuplint rule, including verification logic
  * and default configuration values.
  *
  * @template T - The type of the rule's configuration value (defaults to boolean)
@@ -17,7 +17,6 @@ export type RuleSeed<T extends RuleConfigValue = boolean, O extends PlainData =
     readonly defaultValue?: T;
     readonly defaultOptions?: O;
     verify(context: ReturnType<MLRuleContext<T, O>['provide']>): void | Promise<void>;
-    fix?(context: ReturnType<MLRuleContext<T, O>['provide']>): void | Promise<void>;
 };
 /**
  * A generic checker function that produces a violation report from parameters.

package/lib/test/index.d.ts

@@ -1,7 +1,6 @@
 import type { MLElement } from '../ml-dom/node/element.js';
 import type { MLNode } from '../ml-dom/node/node.js';
-import type { MLToken } from '../ml-dom/token/token.js';
-import type { MLASTNode, MLASTToken, MLParser } from '@markuplint/ml-ast';
+import type { MLASTNode, MLParser } from '@markuplint/ml-ast';
 import type { Config, PlainData, Pretender, RuleConfigValue } from '@markuplint/ml-config';
 import type { MLMLSpec } from '@markuplint/ml-spec';
 import { MLDocument } from '../ml-dom/node/document.js';
@@ -38,14 +37,6 @@ export declare function createTestDocument<T extends RuleConfigValue = any, O ex
  * @returns A readonly array of all nodes in the parsed document
  */
 export declare function createTestNodeList(sourceCode: string, options?: CreateTestOptions): readonly MLNode<any, any, MLASTNode>[];
-/**
- * Parses markup source code and returns the flat list of tokens.
- *
- * @param sourceCode - The markup source code to parse
- * @param options - Options for parser, config, specs, and pretenders
- * @returns A readonly array of all tokens in the parsed document
- */
-export declare function createTestTokenList(sourceCode: string, options?: CreateTestOptions): readonly MLToken<MLASTToken>[];
 /**
  * Parses markup source code and returns the first element node.
  * Throws if the source does not produce an element as its first node.

package/lib/test/index.js

@@ -35,17 +35,6 @@ export function createTestNodeList(sourceCode, options) {
     const document = createTestDocument(sourceCode, options);
     return document.nodeList;
 }
-/**
- * Parses markup source code and returns the flat list of tokens.
- *
- * @param sourceCode - The markup source code to parse
- * @param options - Options for parser, config, specs, and pretenders
- * @returns A readonly array of all tokens in the parsed document
- */
-export function createTestTokenList(sourceCode, options) {
-    const document = createTestDocument(sourceCode, options);
-    return document.getTokenList();
-}
 /**
  * Parses markup source code and returns the first element node.
  * Throws if the source does not produce an element as its first node.

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@markuplint/ml-core",
-	"version": "5.0.0-alpha.1",
+	"version": "5.0.0-alpha.3",
 	"description": "The core module of markuplint",
 	"repository": "git@github.com:markuplint/markuplint.git",
 	"author": "Yusuke Hirao <yusukehirao@me.com>",
@@ -30,20 +30,20 @@
 		"./lib/configs.js": "./lib/configs.browser.js"
 	},
 	"dependencies": {
-		"@markuplint/config-presets": "5.0.0-alpha.1",
-		"@markuplint/html-parser": "5.0.0-alpha.1",
-		"@markuplint/html-spec": "5.0.0-alpha.1",
-		"@markuplint/i18n": "5.0.0-alpha.1",
-		"@markuplint/ml-ast": "5.0.0-alpha.1",
-		"@markuplint/ml-config": "5.0.0-alpha.1",
-		"@markuplint/ml-spec": "5.0.0-alpha.1",
-		"@markuplint/parser-utils": "5.0.0-alpha.1",
-		"@markuplint/selector": "5.0.0-alpha.1",
-		"@markuplint/shared": "5.0.0-alpha.1",
+		"@markuplint/config-presets": "5.0.0-alpha.3",
+		"@markuplint/html-parser": "5.0.0-alpha.3",
+		"@markuplint/html-spec": "5.0.0-alpha.3",
+		"@markuplint/i18n": "5.0.0-alpha.3",
+		"@markuplint/ml-ast": "5.0.0-alpha.3",
+		"@markuplint/ml-config": "5.0.0-alpha.3",
+		"@markuplint/ml-spec": "5.0.0-alpha.3",
+		"@markuplint/parser-utils": "5.0.0-alpha.3",
+		"@markuplint/selector": "5.0.0-alpha.3",
+		"@markuplint/shared": "5.0.0-alpha.3",
 		"@types/debug": "4.1.12",
 		"debug": "4.4.3",
 		"is-plain-object": "5.0.0",
 		"type-fest": "5.4.4"
 	},
-	"gitHead": "78a295e73a097a1ce09c777c06fa21ab68136387"
+	"gitHead": "2fbdf26daa3d021ac628ccc2f59f0eeae6ddd53d"
 }