@markuplint/ml-ast 4.4.10 → 4.4.11

package/ARCHITECTURE.ja.md

@@ -0,0 +1,314 @@
+# @markuplint/ml-ast
+
+## 概要
+
+`@markuplint/ml-ast` は、markuplint の言語非依存な抽象構文木（AST）中間表現を定義する純粋な型定義パッケージです。**ランタイムコードはゼロ**、**依存関係もゼロ**で、すべてのパーサーが生成し、すべての下流パッケージが消費する TypeScript 型定義のみを含みます。
+
+すべてのマークアップ言語パーサー（HTML、JSX、Vue、Svelte、Astro、Pug など）はソースコードをここで定義された型にパースし、markuplint のコアとルールがソース言語に関係なく統一された AST 上で動作できるようにします。
+
+## ディレクトリ構成
+
+```
+src/
+├── index.ts   — types.ts からすべての型を再エクスポート
+└── types.ts   — すべての型定義（約470行）
+```
+
+## アーキテクチャ図
+
+```mermaid
+flowchart TD
+    subgraph parsers ["パーサー（上流）"]
+        html["@markuplint/html-parser"]
+        jsx["@markuplint/jsx-parser"]
+        vue["@markuplint/vue-parser"]
+        svelte["@markuplint/svelte-parser"]
+        astro["@markuplint/astro-parser"]
+        pug["@markuplint/pug-parser"]
+        parserUtils["@markuplint/parser-utils"]
+    end
+
+    subgraph ast ["@markuplint/ml-ast"]
+        types["型定義\n(MLASTDocument, MLASTElement,\nMLASTComment, MLASTText, ...)"]
+    end
+
+    subgraph downstream ["下流"]
+        mlCore["@markuplint/ml-core\n(AST → DOM マッピング)"]
+        mlConfig["@markuplint/ml-config"]
+        mlSpec["@markuplint/ml-spec"]
+        rules["@markuplint/rules"]
+        fileResolver["@markuplint/file-resolver"]
+    end
+
+    parsers -->|"生成"| types
+    types -->|"消費"| downstream
+    mlCore -->|"DOM ノードを作成"| types
+```
+
+## 型継承図
+
+```mermaid
+classDiagram
+    class MLASTToken {
+        <<interface>>
+        +uuid: string
+        +raw: string
+        +startOffset: number
+        +endOffset: number
+        +startLine: number
+        +endLine: number
+        +startCol: number
+        +endCol: number
+    }
+
+    class MLASTAbstractNode {
+        <<interface>>
+        +type: MLASTNodeType
+        +nodeName: string
+        +parentNode: MLASTParentNode | null
+    }
+
+    class MLASTDoctype {
+        <<interface>>
+        +type: "doctype"
+        +depth: number
+        +name: string
+        +publicId: string
+        +systemId: string
+    }
+
+    class MLASTElement {
+        <<interface>>
+        +type: "starttag"
+        +depth: number
+        +namespace: string
+        +elementType: ElementType
+        +attributes: MLASTAttr[]
+        +childNodes: MLASTChildNode[]
+        +pairNode: MLASTElementCloseTag | null
+        +isGhost: boolean
+        +isFragment: boolean
+    }
+
+    class MLASTElementCloseTag {
+        <<interface>>
+        +type: "endtag"
+        +depth: number
+        +parentNode: null
+        +pairNode: MLASTElement
+    }
+
+    class MLASTComment {
+        <<interface>>
+        +type: "comment"
+        +depth: number
+        +isBogus: boolean
+    }
+
+    class MLASTText {
+        <<interface>>
+        +type: "text"
+        +depth: number
+    }
+
+    class MLASTPreprocessorSpecificBlock {
+        <<interface>>
+        +type: "psblock"
+        +conditionalType: ...ConditionalType
+        +depth: number
+        +childNodes: MLASTChildNode[]
+        +isBogus: boolean
+    }
+
+    class MLASTInvalid {
+        <<interface>>
+        +type: "invalid"
+        +depth: number
+        +kind: MLASTChildNode type
+        +isBogus: true
+    }
+
+    class MLASTHTMLAttr {
+        <<interface>>
+        +type: "attr"
+        +name: MLASTToken
+        +value: MLASTToken
+        +isDynamicValue: boolean
+        +isDirective: boolean
+    }
+
+    class MLASTSpreadAttr {
+        <<interface>>
+        +type: "spread"
+    }
+
+    MLASTToken <|-- MLASTAbstractNode
+    MLASTAbstractNode <|-- MLASTDoctype
+    MLASTAbstractNode <|-- MLASTElement
+    MLASTAbstractNode <|-- MLASTElementCloseTag
+    MLASTAbstractNode <|-- MLASTComment
+    MLASTAbstractNode <|-- MLASTText
+    MLASTAbstractNode <|-- MLASTPreprocessorSpecificBlock
+    MLASTAbstractNode <|-- MLASTInvalid
+    MLASTToken <|-- MLASTHTMLAttr
+    MLASTToken <|-- MLASTSpreadAttr
+```
+
+## 共用体型
+
+```mermaid
+flowchart TD
+    subgraph MLASTNode ["MLASTNode（全ノード型）"]
+        subgraph MLASTNodeTreeItem ["MLASTNodeTreeItem"]
+            MLASTDoctype["MLASTDoctype"]
+            subgraph MLASTChildNode ["MLASTChildNode"]
+                subgraph MLASTTag ["MLASTTag"]
+                    MLASTElement["MLASTElement"]
+                    MLASTElementCloseTag["MLASTElementCloseTag"]
+                end
+                MLASTText["MLASTText"]
+                MLASTComment["MLASTComment"]
+                MLASTPreprocessorSpecificBlock["MLASTPreprocessorSpecificBlock"]
+                MLASTInvalid["MLASTInvalid"]
+            end
+        end
+        subgraph MLASTAttr ["MLASTAttr"]
+            MLASTHTMLAttr["MLASTHTMLAttr"]
+            MLASTSpreadAttr["MLASTSpreadAttr"]
+        end
+    end
+
+    style MLASTElement fill:#e1f5fe
+    style MLASTPreprocessorSpecificBlock fill:#e1f5fe
+
+    note1["MLASTParentNode = MLASTElement | MLASTPreprocessorSpecificBlock\n(青でハイライト)"]
+```
+
+## ノード型一覧
+
+| 型                               | `type` 値    | 代表例                 | 説明                                     |
+| -------------------------------- | ------------ | ---------------------- | ---------------------------------------- |
+| `MLASTDoctype`                   | `'doctype'`  | `<!DOCTYPE html>`      | DOCTYPE 宣言                             |
+| `MLASTElement`                   | `'starttag'` | `<div class="foo">`    | 開始タグ。属性・子ノード・名前空間を保持 |
+| `MLASTElementCloseTag`           | `'endtag'`   | `</div>`               | 閉じタグ。開始タグとペア                 |
+| `MLASTComment`                   | `'comment'`  | `<!-- ... -->`         | HTML コメント。bogus フラグ付き          |
+| `MLASTText`                      | `'text'`     | テキスト内容           | 要素間の文字データ                       |
+| `MLASTPreprocessorSpecificBlock` | `'psblock'`  | `{#if}`, `<% %>`       | テンプレートエンジン構文                 |
+| `MLASTInvalid`                   | `'invalid'`  | パース不能マークアップ | 不正ノード。意図された種別のヒント付き   |
+| `MLASTHTMLAttr`                  | `'attr'`     | `class="foo"`          | 完全分解された HTML 属性                 |
+| `MLASTSpreadAttr`                | `'spread'`   | `{...props}`           | JSX スプレッド属性                       |
+
+各型の詳細は[ノードリファレンス](docs/node-reference.ja.md)を参照してください。
+
+## AST から MLDOM へのマッピング
+
+各 AST ノードは、最終的に `@markuplint/ml-core` によって **MLDOM** ノードに変換されます。MLDOM は [DOM Standard](https://dom.spec.whatwg.org/) に準拠しており、各クラスは対応する DOM インターフェース（`Node`、`Element`、`DocumentType`、`Comment`、`Text` など）を実装しているため、リントルールは標準 DOM API を使って検査できます。
+
+| AST 型（`ml-ast`）                   | MLDOM クラス（`ml-core`）  | DOM インターフェース     | `nodeType` |
+| ------------------------------------ | -------------------------- | ------------------------ | ---------- |
+| `MLASTDoctype`                       | `MLDocumentType`           | `DocumentType`           | `10`       |
+| `MLASTElement`                       | `MLElement`                | `Element`, `HTMLElement` | `1`        |
+| `MLASTComment`                       | `MLComment`                | `Comment`                | `8`        |
+| `MLASTText`                          | `MLText`                   | `Text`                   | `3`        |
+| `MLASTPreprocessorSpecificBlock`     | `MLBlock`                  | _（markuplint 独自）_    | `101`      |
+| `MLASTInvalid`（`kind: 'starttag'`） | `MLElement`（`x-invalid`） | `Element`, `HTMLElement` | `1`        |
+| `MLASTInvalid`（その他）             | `MLText`                   | `Text`                   | `3`        |
+| `MLASTHTMLAttr` / `MLASTSpreadAttr`  | `MLAttr`                   | `Attr`                   | `2`        |
+
+**特殊なノード：**
+
+- **`MLBlock`**（`nodeType: 101`）は DOM Standard に相当するものがない markuplint 独自の拡張です。透過的なコンテナとして機能し、子ノードはツリー走査時に親に属するものとして扱われます。
+- **`MLElementCloseTag`** は `createNode()` で生成されません。代わりに `MLElement` が内部で `pairNode` 参照から生成します。ペアとなる要素の付属物としてのみ存在し、DOM ツリー走査の対象ではありません。
+- **`MLASTInvalid`** はリカバリノードです。MLDOM にそのまま保持されることはなく、`kind` フィールドに応じて `MLElement`（タグ名 `x-invalid`）または `MLText` に変換されます。
+
+詳細は[ノードリファレンス -- AST から MLDOM へのマッピング](docs/node-reference.ja.md#ast-から-mldom-へのマッピング)を参照してください。
+
+## 属性分解モデル
+
+`MLASTHTMLAttr` は各属性を完全な位置情報を持つ個別のトークンに分解します：
+
+```
+ ·class="container"
+ ↑     ↑↑         ↑
+ │     ││         └─ endQuote
+ │     │└─ value
+ │     └─ startQuote
+ │        equal
+ └─ spacesBeforeName
+    name
+```
+
+これにより、リントルールは `=` 前後のホワイトスペース、引用符スタイル、属性命名規則を正確なソース位置で検証できます。完全なフィールドドキュメントは[ノードリファレンス](docs/node-reference.ja.md#mlasthtmlattr)を参照してください。
+
+## パーサーインターフェース
+
+| 型                       | 説明                                                     |
+| ------------------------ | -------------------------------------------------------- |
+| `MLParser`               | markuplint 互換パーサーのインターフェース                |
+| `MLParserModule`         | パーサーインスタンスをエクスポートするモジュールラッパー |
+| `MLMarkupLanguageParser` | 非推奨（v5 で削除予定）。代わりに `MLParser` を使用      |
+| `Parse`                  | 非推奨。パース関数シグネチャの型エイリアス               |
+
+`MLParser` は `MLASTDocument` を返す `parse(sourceCode, options?)` メソッドを必要とします。オプションフィールドには `endTag`（終了タグ処理戦略）、`booleanish`（ブール属性検出）、`tagNameCaseSensitive`（XHTML/JSX 用）があります。
+
+## 設定型
+
+| 型                                        | 説明                                                                   |
+| ----------------------------------------- | ---------------------------------------------------------------------- |
+| `MLASTNodeType`                           | ノード種別の判別共用体タグ                                             |
+| `ElementType`                             | 要素分類：`'html' \| 'web-component' \| 'authored'`                    |
+| `EndTagType`                              | 終了タグ戦略：`'xml' \| 'omittable' \| 'never'`                        |
+| `Namespace`                               | 短い名前空間識別子：`'html' \| 'svg' \| 'mml' \| 'xlink'`              |
+| `NamespaceURI`                            | HTML、SVG、MathML、XLink の完全な名前空間 URI                          |
+| `ParserOptions`                           | パーサーに渡すオプション（`ignoreFrontMatter`、`authoredElementName`） |
+| `ParserAuthoredElementNameDistinguishing` | 著者定義要素を区別するための設定                                       |
+| `Walker<Node>`                            | AST ノードを走査するコールバック                                       |
+
+## 外部依存関係
+
+なし。このパッケージはランタイム依存関係がゼロです。TypeScript の型定義のみをエクスポートします。
+
+## 統合ポイント
+
+```mermaid
+flowchart TD
+    subgraph upstream ["上流（パーサー）"]
+        htmlParser["@markuplint/html-parser"]
+        parserUtils["@markuplint/parser-utils"]
+        jsxParser["@markuplint/jsx-parser"]
+        astroParser["@markuplint/astro-parser"]
+        vueParser["@markuplint/vue-parser"]
+        svelteParser["@markuplint/svelte-parser"]
+        pugParser["@markuplint/pug-parser"]
+    end
+
+    subgraph pkg ["@markuplint/ml-ast"]
+        astTypes["型定義"]
+    end
+
+    subgraph downstream ["下流"]
+        mlCore["@markuplint/ml-core"]
+        mlConfig["@markuplint/ml-config"]
+        mlSpec["@markuplint/ml-spec"]
+        fileResolver["@markuplint/file-resolver"]
+    end
+
+    upstream -->|"MLParser を実装\nMLASTDocument を生成"| astTypes
+    astTypes -->|"MLASTNode 型\nMLParser インターフェース"| downstream
+```
+
+### 上流
+
+すべてのパーサーは `MLParser` インターフェースを実装し、このパッケージで定義された AST ノード型を含む `MLASTDocument` インスタンスを生成します。
+
+### 下流
+
+- **`@markuplint/ml-core`** は AST ノードを消費し、`createNode()` を通じて DOM ノードにマッピングします。`MLASTElement` が `MLElement` に、`MLASTText` が `MLText` になるなど、主要な統合ポイントです。
+- **`@markuplint/ml-config`** は設定スキーマ定義で AST 型を参照します。
+- **`@markuplint/ml-spec`** は名前空間と要素型の定義を使用します。
+- **`@markuplint/file-resolver`** はパーサー関連の型を参照します。
+
+## ドキュメントマップ
+
+- [ノードリファレンス](docs/node-reference.ja.md) -- 各 AST ノード型の詳細ドキュメント
+- [メンテナンスガイド](docs/maintenance.ja.md) -- コマンド、レシピ、トラブルシューティング

package/ARCHITECTURE.md

@@ -0,0 +1,314 @@
+# @markuplint/ml-ast
+
+## Overview
+
+`@markuplint/ml-ast` is a pure type-definition package that defines the language-independent Abstract Syntax Tree (AST) intermediate representation for markuplint. It contains **zero runtime code** and **zero dependencies** -- only TypeScript type definitions that all parsers must produce and all downstream packages consume.
+
+Every markup language parser (HTML, JSX, Vue, Svelte, Astro, Pug, etc.) parses source code into the types defined here, enabling markuplint's core and rules to operate on a unified AST regardless of the source language.
+
+## Directory Structure
+
+```
+src/
+├── index.ts   — Re-exports all types from types.ts
+└── types.ts   — All type definitions (~470 lines)
+```
+
+## Architecture Diagram
+
+```mermaid
+flowchart TD
+    subgraph parsers ["Parsers (upstream)"]
+        html["@markuplint/html-parser"]
+        jsx["@markuplint/jsx-parser"]
+        vue["@markuplint/vue-parser"]
+        svelte["@markuplint/svelte-parser"]
+        astro["@markuplint/astro-parser"]
+        pug["@markuplint/pug-parser"]
+        parserUtils["@markuplint/parser-utils"]
+    end
+
+    subgraph ast ["@markuplint/ml-ast"]
+        types["Type Definitions\n(MLASTDocument, MLASTElement,\nMLASTComment, MLASTText, ...)"]
+    end
+
+    subgraph downstream ["Downstream"]
+        mlCore["@markuplint/ml-core\n(AST → DOM mapping)"]
+        mlConfig["@markuplint/ml-config"]
+        mlSpec["@markuplint/ml-spec"]
+        rules["@markuplint/rules"]
+        fileResolver["@markuplint/file-resolver"]
+    end
+
+    parsers -->|"produce"| types
+    types -->|"consumed by"| downstream
+    mlCore -->|"creates DOM nodes from"| types
+```
+
+## Type Inheritance Diagram
+
+```mermaid
+classDiagram
+    class MLASTToken {
+        <<interface>>
+        +uuid: string
+        +raw: string
+        +startOffset: number
+        +endOffset: number
+        +startLine: number
+        +endLine: number
+        +startCol: number
+        +endCol: number
+    }
+
+    class MLASTAbstractNode {
+        <<interface>>
+        +type: MLASTNodeType
+        +nodeName: string
+        +parentNode: MLASTParentNode | null
+    }
+
+    class MLASTDoctype {
+        <<interface>>
+        +type: "doctype"
+        +depth: number
+        +name: string
+        +publicId: string
+        +systemId: string
+    }
+
+    class MLASTElement {
+        <<interface>>
+        +type: "starttag"
+        +depth: number
+        +namespace: string
+        +elementType: ElementType
+        +attributes: MLASTAttr[]
+        +childNodes: MLASTChildNode[]
+        +pairNode: MLASTElementCloseTag | null
+        +isGhost: boolean
+        +isFragment: boolean
+    }
+
+    class MLASTElementCloseTag {
+        <<interface>>
+        +type: "endtag"
+        +depth: number
+        +parentNode: null
+        +pairNode: MLASTElement
+    }
+
+    class MLASTComment {
+        <<interface>>
+        +type: "comment"
+        +depth: number
+        +isBogus: boolean
+    }
+
+    class MLASTText {
+        <<interface>>
+        +type: "text"
+        +depth: number
+    }
+
+    class MLASTPreprocessorSpecificBlock {
+        <<interface>>
+        +type: "psblock"
+        +conditionalType: ...ConditionalType
+        +depth: number
+        +childNodes: MLASTChildNode[]
+        +isBogus: boolean
+    }
+
+    class MLASTInvalid {
+        <<interface>>
+        +type: "invalid"
+        +depth: number
+        +kind: MLASTChildNode type
+        +isBogus: true
+    }
+
+    class MLASTHTMLAttr {
+        <<interface>>
+        +type: "attr"
+        +name: MLASTToken
+        +value: MLASTToken
+        +isDynamicValue: boolean
+        +isDirective: boolean
+    }
+
+    class MLASTSpreadAttr {
+        <<interface>>
+        +type: "spread"
+    }
+
+    MLASTToken <|-- MLASTAbstractNode
+    MLASTAbstractNode <|-- MLASTDoctype
+    MLASTAbstractNode <|-- MLASTElement
+    MLASTAbstractNode <|-- MLASTElementCloseTag
+    MLASTAbstractNode <|-- MLASTComment
+    MLASTAbstractNode <|-- MLASTText
+    MLASTAbstractNode <|-- MLASTPreprocessorSpecificBlock
+    MLASTAbstractNode <|-- MLASTInvalid
+    MLASTToken <|-- MLASTHTMLAttr
+    MLASTToken <|-- MLASTSpreadAttr
+```
+
+## Union Types
+
+```mermaid
+flowchart TD
+    subgraph MLASTNode ["MLASTNode (all node types)"]
+        subgraph MLASTNodeTreeItem ["MLASTNodeTreeItem"]
+            MLASTDoctype["MLASTDoctype"]
+            subgraph MLASTChildNode ["MLASTChildNode"]
+                subgraph MLASTTag ["MLASTTag"]
+                    MLASTElement["MLASTElement"]
+                    MLASTElementCloseTag["MLASTElementCloseTag"]
+                end
+                MLASTText["MLASTText"]
+                MLASTComment["MLASTComment"]
+                MLASTPreprocessorSpecificBlock["MLASTPreprocessorSpecificBlock"]
+                MLASTInvalid["MLASTInvalid"]
+            end
+        end
+        subgraph MLASTAttr ["MLASTAttr"]
+            MLASTHTMLAttr["MLASTHTMLAttr"]
+            MLASTSpreadAttr["MLASTSpreadAttr"]
+        end
+    end
+
+    style MLASTElement fill:#e1f5fe
+    style MLASTPreprocessorSpecificBlock fill:#e1f5fe
+
+    note1["MLASTParentNode = MLASTElement | MLASTPreprocessorSpecificBlock\n(highlighted in blue)"]
+```
+
+## Node Types at a Glance
+
+| Type                             | `type` Value | Example             | Description                                              |
+| -------------------------------- | ------------ | ------------------- | -------------------------------------------------------- |
+| `MLASTDoctype`                   | `'doctype'`  | `<!DOCTYPE html>`   | DOCTYPE declaration                                      |
+| `MLASTElement`                   | `'starttag'` | `<div class="foo">` | Opening element tag with attributes, children, namespace |
+| `MLASTElementCloseTag`           | `'endtag'`   | `</div>`            | Closing element tag, paired with its opening tag         |
+| `MLASTComment`                   | `'comment'`  | `<!-- ... -->`      | HTML comment, with bogus flag                            |
+| `MLASTText`                      | `'text'`     | text content        | Character data between elements                          |
+| `MLASTPreprocessorSpecificBlock` | `'psblock'`  | `{#if}`, `<% %>`    | Template engine constructs                               |
+| `MLASTInvalid`                   | `'invalid'`  | unparsable markup   | Invalid node with intended kind hint                     |
+| `MLASTHTMLAttr`                  | `'attr'`     | `class="foo"`       | Fully decomposed HTML attribute                          |
+| `MLASTSpreadAttr`                | `'spread'`   | `{...props}`        | JSX spread attribute                                     |
+
+See [Node Reference](docs/node-reference.md) for detailed documentation of each type.
+
+## AST to MLDOM Mapping
+
+Each AST node is ultimately converted into an **MLDOM** node by `@markuplint/ml-core`. MLDOM conforms to the [DOM Standard](https://dom.spec.whatwg.org/) -- each class implements the corresponding DOM interface (`Node`, `Element`, `DocumentType`, `Comment`, `Text`, etc.), so lint rules can use standard DOM APIs for inspection.
+
+| AST Type (`ml-ast`)                 | MLDOM Class (`ml-core`)   | DOM Interface            | `nodeType` |
+| ----------------------------------- | ------------------------- | ------------------------ | ---------- |
+| `MLASTDoctype`                      | `MLDocumentType`          | `DocumentType`           | `10`       |
+| `MLASTElement`                      | `MLElement`               | `Element`, `HTMLElement` | `1`        |
+| `MLASTComment`                      | `MLComment`               | `Comment`                | `8`        |
+| `MLASTText`                         | `MLText`                  | `Text`                   | `3`        |
+| `MLASTPreprocessorSpecificBlock`    | `MLBlock`                 | _(markuplint-specific)_  | `101`      |
+| `MLASTInvalid` (`kind: 'starttag'`) | `MLElement` (`x-invalid`) | `Element`, `HTMLElement` | `1`        |
+| `MLASTInvalid` (other)              | `MLText`                  | `Text`                   | `3`        |
+| `MLASTHTMLAttr` / `MLASTSpreadAttr` | `MLAttr`                  | `Attr`                   | `2`        |
+
+**Special nodes:**
+
+- **`MLBlock`** (`nodeType: 101`) is a markuplint-specific extension with no DOM Standard equivalent. It acts as a transparent container -- its children are treated as belonging to the parent for tree traversal.
+- **`MLElementCloseTag`** is not created by `createNode()`. Instead, `MLElement` internally creates it from its `pairNode` reference. It exists only as a satellite of its paired element and is not part of the DOM tree traversal.
+- **`MLASTInvalid`** is a recovery node -- it is never preserved as-is in MLDOM, but converted to either an `MLElement` (with tag name `x-invalid`) or an `MLText`, depending on its `kind` field.
+
+See [Node Reference -- AST to MLDOM Mapping](docs/node-reference.md#ast-to-mldom-mapping) for details.
+
+## Attribute Decomposition Model
+
+`MLASTHTMLAttr` decomposes each attribute into individual tokens with full positional information:
+
+```
+ ·class="container"
+ ↑     ↑↑         ↑
+ │     ││         └─ endQuote
+ │     │└─ value
+ │     └─ startQuote
+ │        equal
+ └─ spacesBeforeName
+    name
+```
+
+This enables lint rules to validate whitespace around `=`, quoting style, and attribute naming conventions with precise source locations. See [Node Reference](docs/node-reference.md#mlasthtmlattr) for complete field documentation.
+
+## Parser Interface
+
+| Type                     | Description                                            |
+| ------------------------ | ------------------------------------------------------ |
+| `MLParser`               | Interface for a markuplint-compatible parser           |
+| `MLParserModule`         | Module wrapper that exports a parser instance          |
+| `MLMarkupLanguageParser` | Deprecated (v5 removal). Use `MLParser` instead        |
+| `Parse`                  | Deprecated type alias for the parse function signature |
+
+`MLParser` requires a `parse(sourceCode, options?)` method that returns an `MLASTDocument`. Optional fields include `endTag` (end tag handling strategy), `booleanish` (boolean attribute detection), and `tagNameCaseSensitive` (for XHTML/JSX).
+
+## Configuration Types
+
+| Type                                      | Description                                                            |
+| ----------------------------------------- | ---------------------------------------------------------------------- |
+| `MLASTNodeType`                           | Discriminant union tag for node kinds                                  |
+| `ElementType`                             | Element classification: `'html' \| 'web-component' \| 'authored'`      |
+| `EndTagType`                              | End tag strategy: `'xml' \| 'omittable' \| 'never'`                    |
+| `Namespace`                               | Short namespace identifiers: `'html' \| 'svg' \| 'mml' \| 'xlink'`     |
+| `NamespaceURI`                            | Full namespace URIs for HTML, SVG, MathML, XLink                       |
+| `ParserOptions`                           | Options passed to parsers (`ignoreFrontMatter`, `authoredElementName`) |
+| `ParserAuthoredElementNameDistinguishing` | Configuration for distinguishing authored elements                     |
+| `Walker<Node>`                            | Callback for walking AST nodes                                         |
+
+## External Dependencies
+
+None. This package has zero runtime dependencies. It exports only TypeScript type definitions.
+
+## Integration Points
+
+```mermaid
+flowchart TD
+    subgraph upstream ["Upstream (Parsers)"]
+        htmlParser["@markuplint/html-parser"]
+        parserUtils["@markuplint/parser-utils"]
+        jsxParser["@markuplint/jsx-parser"]
+        astroParser["@markuplint/astro-parser"]
+        vueParser["@markuplint/vue-parser"]
+        svelteParser["@markuplint/svelte-parser"]
+        pugParser["@markuplint/pug-parser"]
+    end
+
+    subgraph pkg ["@markuplint/ml-ast"]
+        astTypes["Type Definitions"]
+    end
+
+    subgraph downstream ["Downstream"]
+        mlCore["@markuplint/ml-core"]
+        mlConfig["@markuplint/ml-config"]
+        mlSpec["@markuplint/ml-spec"]
+        fileResolver["@markuplint/file-resolver"]
+    end
+
+    upstream -->|"implement MLParser\nproduce MLASTDocument"| astTypes
+    astTypes -->|"MLASTNode types\nMLParser interface"| downstream
+```
+
+### Upstream
+
+All parsers implement the `MLParser` interface and produce `MLASTDocument` instances containing the AST node types defined in this package.
+
+### Downstream
+
+- **`@markuplint/ml-core`** consumes AST nodes and maps them to DOM nodes via `createNode()`. This is the primary integration point where `MLASTElement` becomes `MLElement`, `MLASTText` becomes `MLText`, etc.
+- **`@markuplint/ml-config`** references AST types in configuration schema definitions.
+- **`@markuplint/ml-spec`** uses namespace and element type definitions.
+- **`@markuplint/file-resolver`** references parser-related types.
+
+## Documentation Map
+
+- [Node Reference](docs/node-reference.md) -- Detailed documentation of each AST node type
+- [Maintenance Guide](docs/maintenance.md) -- Commands, recipes, and troubleshooting

package/CHANGELOG.md

@@ -3,6 +3,10 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [4.4.11](https://github.com/markuplint/markuplint/compare/@markuplint/ml-ast@4.4.10...@markuplint/ml-ast@4.4.11) (2026-02-10)
+
+**Note:** Version bump only for package @markuplint/ml-ast
+
 ## [4.4.10](https://github.com/markuplint/markuplint/compare/@markuplint/ml-ast@4.4.9...@markuplint/ml-ast@4.4.10) (2025-08-13)
 
 ### Bug Fixes

package/README.md

@@ -16,3 +16,9 @@ $ yarn add @markuplint/ml-ast
 ```
 
 </details>
+
+## Documentation
+
+- [Architecture](ARCHITECTURE.md) -- Package overview, type hierarchy diagrams, and integration points
+- [Node Reference](docs/node-reference.md) -- Detailed documentation of each AST node type
+- [Maintenance Guide](docs/maintenance.md) -- Commands, recipes, and troubleshooting