@markuplint/ml-config 5.0.0-alpha.2 → 5.0.0-dev.5

package/ARCHITECTURE.ja.md

@@ -96,6 +96,13 @@ type RuleConfig<T, O> = {
 - `OriginalNode` -- 要素名、スロット、名前空間、属性、継承属性、ARIA プロパティを定義
 - `PretenderDetails` -- マージ後に使用される正規化形式 `{data?, files?, imports?}`
 
+### 自動修正型
+
+- `TextEdit` -- ソースコードの単一置換: `{ range: [start, end), text }`。`text` が空文字列の場合は削除を意味する
+- `FixData` -- 1つ以上の `TextEdit` をアトミックに適用する単位。`FixData` 内のいずれかの edit が他の `FixData` と重複すると、グループ全体がスキップされる
+- `FixToken` -- `IRuleFixer` メソッドが受け付ける最小トークン型（`{ startOffset, raw }`）。すべての MLDOM トークンはこの制約を満たす
+- `IRuleFixer` -- fix コールバック内で `TextEdit` を構築するためのインターフェース。`replaceText`、`replaceRange`、`insertBefore`、`insertAfter`、`remove`、`removeRange` を提供
+
 ## マージアルゴリズム
 
 このパッケージの中核です。`mergeConfig()` 関数はプロパティごとの戦略で2つの設定を統合します。
@@ -225,7 +232,7 @@ Mustache テンプレート文字列を提供されたデータでレンダリ
 
 | ファイル              | 目的                                                                                                    |
 | --------------------- | ------------------------------------------------------------------------------------------------------- |
-| `src/types.ts`        | 全型定義（Config, Rule, Pretender, Violation 等）                                                       |
+| `src/types.ts`        | 全型定義（Config, Rule, Pretender, Violation, FixToken, IRuleFixer 等）                                 |
 | `src/merge-config.ts` | `mergeConfig()`、`mergeRule()`、全ヘルパー関数                                                          |
 | `src/utils.ts`        | `provideValue()`、`exchangeValueOnRule()`、`cleanOptions()`、`isRuleConfigValue()`、`deleteUndefProp()` |
 | `src/index.ts`        | 全公開 API の再エクスポート                                                                             |

package/ARCHITECTURE.md

@@ -96,6 +96,13 @@ type RuleConfig<T, O> = {
 - `OriginalNode` -- Defines an element's name, slots, namespace, attributes, inherited attributes, and ARIA properties
 - `PretenderDetails` -- Normalized form `{data?, files?, imports?}` used after merging
 
+### Autofix Types
+
+- `TextEdit` -- A single source code replacement: `{ range: [start, end), text }`. An empty `text` means deletion
+- `FixData` -- Contains one or more `TextEdit`s to apply atomically. If any edit in a `FixData` overlaps with another `FixData`, the entire group is skipped
+- `FixToken` -- Minimal token shape (`{ startOffset, raw }`) accepted by `IRuleFixer` methods. Any MLDOM token satisfies this constraint
+- `IRuleFixer` -- Interface for building `TextEdit`s inside fix callbacks. Provides `replaceText`, `replaceRange`, `insertBefore`, `insertAfter`, `remove`, and `removeRange`
+
 ## Merge Algorithm
 
 This is the core of the package. The `mergeConfig()` function combines two configurations with property-specific strategies.
@@ -225,7 +232,7 @@ This function is used by `nodeRules` and `childNodeRules` with `regexSelector`,
 
 | File                  | Purpose                                                                                                 |
 | --------------------- | ------------------------------------------------------------------------------------------------------- |
-| `src/types.ts`        | All type definitions (Config, Rule, Pretender, Violation, etc.)                                         |
+| `src/types.ts`        | All type definitions (Config, Rule, Pretender, Violation, FixToken, IRuleFixer, etc.)                   |
 | `src/merge-config.ts` | `mergeConfig()`, `mergeRule()`, and all helper functions                                                |
 | `src/utils.ts`        | `provideValue()`, `exchangeValueOnRule()`, `cleanOptions()`, `isRuleConfigValue()`, `deleteUndefProp()` |
 | `src/index.ts`        | Re-exports all public APIs                                                                              |

package/CHANGELOG.md

@@ -3,6 +3,12 @@
 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.3](https://github.com/markuplint/markuplint/compare/v5.0.0-alpha.2...v5.0.0-alpha.3) (2026-02-26)
+
+### Features
+
+- **ml-config:** add FixToken type and JSDoc to IRuleFixer methods ([c39d3ce](https://github.com/markuplint/markuplint/commit/c39d3ceaf81ba131d4c1d0efb500d36f327081c4))
+
 # [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

package/lib/merge-config.js

@@ -35,7 +35,8 @@ export function mergeConfig(a, b) {
         severity: mergeObject(a.severity, b.severity),
         pretenders: mergePretenders(a.pretenders, b.pretenders),
         rules: mergeRules(
-        // TODO: Deep merge
+        // Shallow merge: rule-level options are replaced entirely by the overriding config.
+        // Deep merging individual rule options would require schema-aware merging logic.
         a.rules, b.rules),
         nodeRules: concatArray(a.nodeRules, b.nodeRules, true, 'name'),
         childNodeRules: concatArray(a.childNodeRules, b.childNodeRules, true, 'name'),

package/lib/types.d.ts

@@ -472,27 +472,64 @@ export type TextEdit = {
 export type FixData = {
     readonly edits: readonly TextEdit[];
 };
+/**
+ * Minimal token shape required by {@link IRuleFixer} methods.
+ * Any object with a character offset and raw source text satisfies this constraint.
+ */
+export type FixToken = {
+    readonly startOffset: number;
+    readonly raw: string;
+};
 /**
  * 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;
+    /**
+     * Replaces a token's entire text with new content.
+     *
+     * @param token - The token whose range will be replaced
+     * @param text - The replacement text
+     * @returns A TextEdit spanning the token's range
+     */
+    replaceText(token: FixToken, text: string): TextEdit;
+    /**
+     * Replaces an explicit character range with new content.
+     *
+     * @param range - The `[start, end)` character offsets to replace
+     * @param text - The replacement text
+     * @returns A TextEdit spanning the given range
+     */
     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;
+    /**
+     * Inserts text immediately before a token.
+     *
+     * @param token - The token before which to insert
+     * @param text - The text to insert
+     * @returns A zero-width TextEdit at the token's start offset
+     */
+    insertBefore(token: Pick<FixToken, 'startOffset'>, text: string): TextEdit;
+    /**
+     * Inserts text immediately after a token.
+     *
+     * @param token - The token after which to insert
+     * @param text - The text to insert
+     * @returns A zero-width TextEdit at the token's end offset
+     */
+    insertAfter(token: FixToken, text: string): TextEdit;
+    /**
+     * Removes a token's entire text from the source.
+     *
+     * @param token - The token to remove
+     * @returns A TextEdit that replaces the token's range with an empty string
+     */
+    remove(token: FixToken): TextEdit;
+    /**
+     * Removes an explicit character range from the source.
+     *
+     * @param range - The `[start, end)` character offsets to remove
+     * @returns A TextEdit that replaces the range with an empty string
+     */
     removeRange(range: readonly [number, number]): TextEdit;
 }
 /**

package/lib/utils.js

@@ -138,7 +138,7 @@ export function deleteUndefProp(obj) {
     if (!isPlainObject(obj)) {
         return;
     }
-    for (const key in obj) {
+    for (const key of Object.keys(obj)) {
         if (obj[key] === undefined) {
             delete obj[key];
         }

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@markuplint/ml-config",
-	"version": "5.0.0-alpha.2",
+	"version": "5.0.0-dev.5+e96392f56",
 	"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.2",
-		"@markuplint/ml-spec": "5.0.0-alpha.2",
-		"@markuplint/selector": "5.0.0-alpha.2",
-		"@markuplint/shared": "5.0.0-alpha.2",
+		"@markuplint/ml-ast": "5.0.0-dev.5+e96392f56",
+		"@markuplint/ml-spec": "5.0.0-dev.5+e96392f56",
+		"@markuplint/selector": "5.0.0-dev.5+e96392f56",
+		"@markuplint/shared": "5.0.0-dev.5+e96392f56",
 		"@types/mustache": "4.2.6",
 		"is-plain-object": "5.0.0",
 		"mustache": "4.2.0",
 		"type-fest": "5.4.4"
 	},
-	"gitHead": "31ccf1e81443ea3f93597d287595211f1823ddcf"
+	"gitHead": "e96392f56e4bc8165ba59622b41c822703a96372"
 }