@markuplint/ml-config 5.0.0-alpha.0 → 5.0.0-alpha.2

package/CHANGELOG.md

@@ -3,6 +3,16 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [5.0.0-alpha.2](https://github.com/markuplint/markuplint/compare/v5.0.0-alpha.1...v5.0.0-alpha.2) (2026-02-23)
+
+### Features
+
+- **ml-config:** add autofix type definitions ([d7149c3](https://github.com/markuplint/markuplint/commit/d7149c319fe5f24dc96bfcbd5d83206c0f8e61ed))
+
+# [5.0.0-alpha.1](https://github.com/markuplint/markuplint/compare/v5.0.0-alpha.0...v5.0.0-alpha.1) (2026-02-22)
+
+**Note:** Version bump only for package @markuplint/ml-config
+
 # [5.0.0-alpha.0](https://github.com/markuplint/markuplint/compare/v4.14.1...v5.0.0-alpha.0) (2026-02-20)
 
 ### Bug Fixes

package/lib/types.d.ts

@@ -431,6 +431,7 @@ export type Report<T extends RuleConfigValue, O extends PlainData = undefined> =
 export type Report1<T extends RuleConfigValue, O extends PlainData = undefined> = {
     readonly message: string;
     readonly scope: Scope<T, O>;
+    readonly fix?: (fixer: IRuleFixer) => TextEdit | readonly TextEdit[];
 };
 /**
  * A coordinate-based violation report with explicit line, column, and raw text.
@@ -440,6 +441,7 @@ export type Report2 = {
     readonly line: number;
     readonly col: number;
     readonly raw: string;
+    readonly fix?: (fixer: IRuleFixer) => TextEdit | readonly TextEdit[];
 };
 /**
  * Identifies the location and rule context of a reported violation.
@@ -453,6 +455,46 @@ export type Scope<T extends RuleConfigValue, O extends PlainData = undefined> =
     readonly startCol: number;
     readonly raw: string;
 };
+/**
+ * A text range replacement on the source code.
+ * Used by the autofix system to describe edits.
+ */
+export type TextEdit = {
+    /** 0-based character offsets (UTF-16 code units): [start, end) */
+    readonly range: readonly [start: number, end: number];
+    /** Replacement text (empty string = deletion) */
+    readonly text: string;
+};
+/**
+ * Fix information attached to a {@link Violation}.
+ * Contains one or more {@link TextEdit}s to apply to the source.
+ */
+export type FixData = {
+    readonly edits: readonly TextEdit[];
+};
+/**
+ * A helper interface for building {@link TextEdit}s inside a fix callback.
+ * Passed to the `fix` function on {@link Report1} and {@link Report2}.
+ */
+export interface IRuleFixer {
+    replaceText(token: {
+        readonly startOffset: number;
+        readonly raw: string;
+    }, text: string): TextEdit;
+    replaceRange(range: readonly [number, number], text: string): TextEdit;
+    insertBefore(token: {
+        readonly startOffset: number;
+    }, text: string): TextEdit;
+    insertAfter(token: {
+        readonly startOffset: number;
+        readonly raw: string;
+    }, text: string): TextEdit;
+    remove(token: {
+        readonly startOffset: number;
+        readonly raw: string;
+    }): TextEdit;
+    removeRange(range: readonly [number, number]): TextEdit;
+}
 /**
  * A fully resolved lint violation with all information needed for reporting.
  */
@@ -472,6 +514,8 @@ export type Violation = {
     readonly line: number;
     readonly col: number;
     readonly raw: string;
+    /** Fix information for autofix. Present only when the rule provides a fix callback. */
+    readonly fix?: FixData;
 };
 /**
  * Resolved rule information after configuration merging, used at runtime by rules.

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@markuplint/ml-config",
-	"version": "5.0.0-alpha.0",
+	"version": "5.0.0-alpha.2",
 	"description": "JSON Schema and TypeScript types of markuplint configure JSON",
 	"repository": "git@github.com:markuplint/markuplint.git",
 	"author": "Yusuke Hirao <yusukehirao@me.com>",
@@ -27,14 +27,14 @@
 		"clean": "tsc --build --clean  tsconfig.build.json"
 	},
 	"dependencies": {
-		"@markuplint/ml-ast": "5.0.0-alpha.0",
-		"@markuplint/ml-spec": "5.0.0-alpha.0",
-		"@markuplint/selector": "5.0.0-alpha.0",
-		"@markuplint/shared": "5.0.0-alpha.0",
+		"@markuplint/ml-ast": "5.0.0-alpha.2",
+		"@markuplint/ml-spec": "5.0.0-alpha.2",
+		"@markuplint/selector": "5.0.0-alpha.2",
+		"@markuplint/shared": "5.0.0-alpha.2",
 		"@types/mustache": "4.2.6",
 		"is-plain-object": "5.0.0",
 		"mustache": "4.2.0",
 		"type-fest": "5.4.4"
 	},
-	"gitHead": "13dcfc84ec83d87360c720e253383b60767e1b56"
+	"gitHead": "31ccf1e81443ea3f93597d287595211f1823ddcf"
 }