@markuplint/ml-core 4.13.2 → 5.0.0-alpha.0

package/docs/rule-system.ja.md

@@ -0,0 +1,287 @@
+# ルールシステム
+
+`@markuplint/ml-core` のルールフレームワークの詳細リファレンスです。
+
+## 概要
+
+ルールフレームワークはリントルールの完全なライフサイクルを処理します：定義、設定、ノードへのマッピング、実行、違反収集。主要コンポーネント：
+
+- **RuleSeed** — ルール定義型（verify/fix 関数 + デフォルト値）
+- **MLRule** — ルール実行クラス（シードを名前と設定解決でラップ）
+- **MLRuleContext** — ルールの実行コンテキスト（ドキュメントアクセス、翻訳、違反報告）
+- **RuleMapper** — セレクタ詳細度に基づいてルール設定を特定の DOM ノードにマッピング
+- **Ruleset** — Config から rules、nodeRules、childNodeRules を抽出
+
+## RuleSeed
+
+ソース: `src/ml-rule/types.ts`
+
+`RuleSeed<T, O>` 型はルールの実装を定義します。
+
+```typescript
+type RuleSeed<T extends RuleConfigValue = boolean, O extends PlainData = undefined> = {
+  readonly meta?: {
+    readonly category?: 'validation' | 'style' | 'naming-convention' | 'a11y' | 'maintainability';
+  };
+  readonly defaultSeverity?: Severity;
+  readonly defaultValue?: T;
+  readonly defaultOptions?: O;
+  verify(context: ProvidedContext<T, O>): void | Promise<void>;
+  fix?(context: ProvidedContext<T, O>): void | Promise<void>;
+};
+```
+
+### カテゴリ値
+
+| カテゴリ              | 説明                                 |
+| --------------------- | ------------------------------------ |
+| `'validation'`        | HTML 標準準拠チェック                |
+| `'style'`             | コードスタイルとフォーマットのルール |
+| `'naming-convention'` | 命名規則の強制                       |
+| `'a11y'`              | アクセシビリティチェック             |
+| `'maintainability'`   | コード保守性のルール                 |
+
+### デフォルト値
+
+- `defaultSeverity` — 未指定の場合 `'error'`
+- `defaultValue` — 未指定の場合 `true`
+- `defaultOptions` — 未指定の場合 `undefined`
+
+## createRule
+
+ソース: `src/ml-rule/create-rule.ts`
+
+型安全なルールシード作成のためのファクトリ関数：
+
+```typescript
+function createRule<T extends RuleConfigValue, O extends PlainData = undefined>(
+  seed: Readonly<RuleSeed<T, O>>,
+): RuleSeed<T, O>;
+```
+
+シードをそのまま返します。主に TypeScript の型推論のためのヘルパーとして機能します。
+
+### 使用例
+
+```typescript
+import { createRule } from '@markuplint/ml-core';
+
+export default createRule({
+  defaultSeverity: 'error',
+  defaultValue: true,
+  async verify({ document, report, t }) {
+    await document.walkOn('Element', el => {
+      if (/* 違反条件 */) {
+        report({ scope: el, message: t('エラーメッセージ') });
+      }
+    });
+  },
+});
+```
+
+## MLRule
+
+ソース: `src/ml-rule/ml-rule.ts`
+
+`MLRule<T, O>` は `RuleSeed` を名前でラップし、設定解決と検証実行を提供します。
+
+### コンストラクタ
+
+```typescript
+constructor(o: Readonly<RuleSeed<T, O>> & { readonly name: string })
+```
+
+### プロパティ
+
+| プロパティ        | 型                             | 説明                                                               |
+| ----------------- | ------------------------------ | ------------------------------------------------------------------ |
+| `name`            | `string`                       | ルール識別子（例: `"attr-duplication"` または `"a11y/html-lang"`） |
+| `defaultSeverity` | `Severity`                     | デフォルトの重大度レベル（シードまたは `'error'`）                 |
+| `defaultValue`    | `T`                            | デフォルト設定値（シードまたは `true`）                            |
+| `defaultOptions`  | `O`                            | デフォルトオプション（シードから）                                 |
+| `baseRuleId`      | `string \| undefined`          | 仮想ルールの場合: ベースルール名（例: `"required-attr"`）          |
+| `groupName`       | `string \| undefined`          | 複数エントリ仮想ルールの場合: 一括無効化用のグループ名             |
+| `specConformance` | `SpecConformance \| undefined` | 仮想ルールの場合: `'normative'` または `'non-normative'`           |
+
+### メソッド
+
+#### `verify(document, locale, fix): Promise<Violation[]>`
+
+ドキュメントに対してルールを実行します。
+
+**フロー:**
+
+1. `document.setRule(this)` — ドキュメントに現在のルールコンテキストを設定
+2. `new MLRuleContext(document, locale)` — 実行コンテキストを作成
+3. `context.provide()` — 提供可能なコンテキストオブジェクトを生成
+4. `await seed.verify(context)` — 検証を実行
+5. `await seed.fix(context)` — 修正を実行（`fix=true` かつ fix 関数がある場合）
+6. `context.reports` → `Violation[]` — レポートを違反にマッピング
+7. `document.setRule(null)` — ルールコンテキストをクリア
+
+**Report → Violation のマッピング:**
+
+- スコープベースのレポート: `report.scope`（ノード）から `line`, `col`, `raw` を抽出、重大度は `report.scope.rule.severity` から
+- 直接レポート: `report.line`, `report.col`, `report.raw` を直接使用、重大度は `document.rule.severity` から
+
+#### `getRuleInfo(ruleSet, ruleName): GlobalRuleInfo<T, O>`
+
+ルールセットから完全なルール情報を解決します。
+
+戻り値:
+
+```typescript
+{
+  ...RuleInfo<T, O>,               // グローバルルール設定
+  nodeRules: RuleInfo<T, O>[],     // 無効でないノードレベルのオーバーライド
+  childNodeRules: RuleInfo<T, O>[], // 無効でない子ノードレベルのオーバーライド
+}
+```
+
+#### `createAlias(aliasName, options?): MLRule<T, O>`
+
+このルールの verify/fix ロジックを別名で再利用する仮想ルールを作成します。named nodeRules を実装するために `expandNamedNodeRules()` が内部的に使用します。
+
+オプション:
+
+| オプション        | 型                | 説明                                                                                                   |
+| ----------------- | ----------------- | ------------------------------------------------------------------------------------------------------ |
+| `defaultSeverity` | `Severity`        | ベースルールのデフォルト重大度をオーバーライド（明示的な指定のみ。specConformance による自動設定なし） |
+| `specConformance` | `SpecConformance` | `'normative'` または `'non-normative'`                                                                 |
+| `groupName`       | `string`          | 複数エントリ named nodeRule のグループ名                                                               |
+
+エイリアスルールはベースルールの verify/fix 関数、meta、デフォルト値を継承します。`baseRuleId` プロパティでベースルール名を返します。
+
+#### `optimizeOption(configSettings): RuleInfo<T, O>`
+
+生のルール設定を解決済み `RuleInfo` に正規化します。
+
+| 入力                       | 結果                                                                                          |
+| -------------------------- | --------------------------------------------------------------------------------------------- |
+| `undefined` または `false` | `{ disabled: true, severity: デフォルト, value: デフォルト, options: デフォルト }`            |
+| `true`                     | `{ disabled: false, severity: デフォルト, value: デフォルト, options: デフォルト }`           |
+| `RuleConfig` オブジェクト  | `{ disabled: false, severity: 設定/デフォルト, value: 設定/デフォルト, options: マージ済み }` |
+| プリミティブ値             | `{ disabled: false, severity: デフォルト, value: 入力値, options: デフォルト }`               |
+
+オプションのマージ: 配列はスプレッド（`[...a, ...b]`）、オブジェクトはスプレッド（`{...a, ...b}`）、それ以外は `b ?? a` にフォールバック。
+
+## MLRuleContext
+
+ソース: `src/ml-rule/ml-rule-context.ts`
+
+`MLRuleContext<T, O>` はルールの実行コンテキストを提供します。
+
+### コンストラクタ
+
+```typescript
+constructor(document: MLDocument<T, O>, locale: LocaleSet)
+```
+
+ロケールから翻訳関数を作成し、ドキュメント参照を保存します。
+
+### プロパティ
+
+| プロパティ  | 型                 | 説明                    |
+| ----------- | ------------------ | ----------------------- |
+| `document`  | `MLDocument<T, O>` | 検証対象のドキュメント  |
+| `locale`    | `string`           | ロケール文字列          |
+| `translate` | `Translator`       | i18n メッセージ翻訳関数 |
+
+### `provide(): ProvidedContext`
+
+`RuleSeed.verify()` と `RuleSeed.fix()` に渡されるコンテキストオブジェクトを返します：
+
+```typescript
+{
+  document: MLDocument<T, O>,
+  translate: Translator,
+  t: Translator,        // translate のエイリアス
+  reports: Report<T, O>[],
+  report: (report) => void | boolean,
+}
+```
+
+### `report(report)`
+
+2 つのオーバーロード：
+
+1. **直接レポート**（`Report<T, O>`）: レポートを直接プッシュ。`undefined` を返す。
+2. **チェッカーレポート**（`CheckerReport<T, O>`）: 翻訳関数で関数を呼び出す。レポートが返された場合プッシュして `true` を返す。`null`/`undefined` の場合 `false` を返す。
+
+### 重複排除
+
+レポートは `_push()` で以下の基準で重複排除されます：
+
+- **スコープベース**: 同じ `scope` オブジェクト + 同じ `message`
+- **位置ベース**: 同じ `col` + `line` + `message` + `raw`
+
+### メッセージの最終処理
+
+英語ロケール（`'en'`）の場合、最初の小文字が大文字に変換されます。他のロケールはそのまま通過します。
+
+## チェッカー型
+
+ソース: `src/ml-rule/types.ts`
+
+チェッカー関数を構築するためのユーティリティ型：
+
+| 型                        | シグネチャ                                                   | 説明               |
+| ------------------------- | ------------------------------------------------------------ | ------------------ |
+| `Checker<T, O, P>`        | `(params: P) => CheckerReport<T, O>`                         | 汎用チェッカー     |
+| `ElementChecker<T, O, P>` | `(params: P & { el: Element<T, O> }) => CheckerReport<T, O>` | 要素固有チェッカー |
+| `AttrChecker<T, O, P>`    | `(params: P & { attr: Attr<T, O> }) => CheckerReport<T, O>`  | 属性固有チェッカー |
+| `CheckerReport<T, O>`     | `(t: Translator) => Report<T, O> \| undefined \| null`       | 遅延レポート関数   |
+
+## ルールマッピング
+
+`RuleMapper`、ルール設定の解決（`rules`、`nodeRules`、`childNodeRules` の3層処理）、詳細度ベースの競合解決、マージ動作、正規表現セレクタのテンプレート変数についての詳細なドキュメントは、専用の[ルールマッピング](./ml-dom/rule-mapping.ja.md)リファレンスを参照してください。
+
+## Ruleset
+
+ソース: `src/ruleset/index.ts`
+
+`Config` オブジェクトからルール設定を抽出します。
+
+```typescript
+class Ruleset {
+  readonly rules: Rules;
+  readonly nodeRules: readonly NodeRule[];
+  readonly childNodeRules: readonly ChildNodeRule[];
+
+  constructor(config: Config);
+}
+```
+
+- `rules` — グローバルルール定義（`config.rules` から、デフォルトは `{}`）
+- `nodeRules` — ノード固有のオーバーライド（`config.nodeRules` から、デフォルトは `[]`）
+- `childNodeRules` — 子ノード固有のオーバーライド（`config.childNodeRules` から、デフォルトは `[]`）
+
+## テストユーティリティ
+
+ソース: `src/ml-rule/create-test-rule.ts`
+
+### createTestRule
+
+```typescript
+function createRule<T, O>(seed: Readonly<RuleSeed<T, O>> & { readonly name: string }): MLRule<T, O>;
+```
+
+テスト用の `MLRule` インスタンスを作成します。`create-rule.ts` の `createRule()` とは異なり、`name` プロパティが必須で、実際の `MLRule` インスタンスを返します。
+
+### テストパターン
+
+```typescript
+import { createRule } from '@markuplint/ml-core/test';
+import { createTestDocument } from '@markuplint/ml-core/test';
+
+const rule = createRule({
+  name: 'my-rule',
+  defaultSeverity: 'error',
+  async verify({ document, report, t }) {
+    // 検証ロジック
+  },
+});
+
+const doc = createTestDocument('<div></div>');
+const violations = await rule.verify(doc, { locale: 'en' }, false);
+```

package/docs/rule-system.md

@@ -0,0 +1,287 @@
+# Rule System
+
+Detailed reference for the rule framework in `@markuplint/ml-core`.
+
+## Overview
+
+The rule framework handles the full lifecycle of lint rules: definition, configuration, mapping to nodes, execution, and violation collection. The key components are:
+
+- **RuleSeed** -- Rule definition type (verify/fix functions + defaults)
+- **MLRule** -- Rule execution class (wraps a seed with name and config resolution)
+- **MLRuleContext** -- Execution context for rules (document access, translation, violation reporting)
+- **RuleMapper** -- Maps rule configurations to specific DOM nodes based on selector specificity
+- **Ruleset** -- Extracts rules, nodeRules, and childNodeRules from Config
+
+## RuleSeed
+
+Source: `src/ml-rule/types.ts`
+
+The `RuleSeed<T, O>` type defines a rule's implementation.
+
+```typescript
+type RuleSeed<T extends RuleConfigValue = boolean, O extends PlainData = undefined> = {
+  readonly meta?: {
+    readonly category?: 'validation' | 'style' | 'naming-convention' | 'a11y' | 'maintainability';
+  };
+  readonly defaultSeverity?: Severity;
+  readonly defaultValue?: T;
+  readonly defaultOptions?: O;
+  verify(context: ProvidedContext<T, O>): void | Promise<void>;
+  fix?(context: ProvidedContext<T, O>): void | Promise<void>;
+};
+```
+
+### Category Values
+
+| Category              | Description                     |
+| --------------------- | ------------------------------- |
+| `'validation'`        | HTML standard compliance checks |
+| `'style'`             | Code style and formatting rules |
+| `'naming-convention'` | Naming convention enforcement   |
+| `'a11y'`              | Accessibility checks            |
+| `'maintainability'`   | Code maintainability rules      |
+
+### Default Values
+
+- `defaultSeverity` defaults to `'error'` if not specified
+- `defaultValue` defaults to `true` if not specified
+- `defaultOptions` defaults to `undefined`
+
+## createRule
+
+Source: `src/ml-rule/create-rule.ts`
+
+Factory function for type-safe rule seed creation:
+
+```typescript
+function createRule<T extends RuleConfigValue, O extends PlainData = undefined>(
+  seed: Readonly<RuleSeed<T, O>>,
+): RuleSeed<T, O>;
+```
+
+Returns the seed as-is. Serves primarily as a type helper for TypeScript inference.
+
+### Usage
+
+```typescript
+import { createRule } from '@markuplint/ml-core';
+
+export default createRule({
+  defaultSeverity: 'error',
+  defaultValue: true,
+  async verify({ document, report, t }) {
+    await document.walkOn('Element', el => {
+      if (/* violation condition */) {
+        report({ scope: el, message: t('Error message') });
+      }
+    });
+  },
+});
+```
+
+## MLRule
+
+Source: `src/ml-rule/ml-rule.ts`
+
+`MLRule<T, O>` wraps a `RuleSeed` with a name and provides configuration resolution and verification execution.
+
+### Constructor
+
+```typescript
+constructor(o: Readonly<RuleSeed<T, O>> & { readonly name: string })
+```
+
+### Properties
+
+| Property          | Type                           | Description                                                        |
+| ----------------- | ------------------------------ | ------------------------------------------------------------------ |
+| `name`            | `string`                       | Rule identifier (e.g., `"attr-duplication"` or `"a11y/html-lang"`) |
+| `defaultSeverity` | `Severity`                     | Default severity level (from seed or `'error'`)                    |
+| `defaultValue`    | `T`                            | Default config value (from seed or `true`)                         |
+| `defaultOptions`  | `O`                            | Default options (from seed)                                        |
+| `baseRuleId`      | `string \| undefined`          | For virtual rules: the base rule's name (e.g., `"required-attr"`)  |
+| `groupName`       | `string \| undefined`          | For multi-entry virtual rules: group name for batch disable        |
+| `specConformance` | `SpecConformance \| undefined` | For virtual rules: `'normative'` or `'non-normative'`              |
+
+### Methods
+
+#### `verify(document, locale, fix): Promise<Violation[]>`
+
+Executes the rule against a document.
+
+**Flow:**
+
+1. `document.setRule(this)` -- sets current rule context on document
+2. `new MLRuleContext(document, locale)` -- creates execution context
+3. `context.provide()` -- generates providable context object
+4. `await seed.verify(context)` -- runs verification
+5. `await seed.fix(context)` -- runs fix (if `fix=true` and fix function exists)
+6. `context.reports` -> `Violation[]` -- maps reports to violations
+7. `document.setRule(null)` -- clears rule context
+
+**Report -> Violation mapping:**
+
+- Scope-based reports: extracts `line`, `col`, `raw` from `report.scope` (the node), severity from `report.scope.rule.severity`
+- Direct reports: uses `report.line`, `report.col`, `report.raw` directly, severity from `document.rule.severity`
+
+#### `getRuleInfo(ruleSet, ruleName): GlobalRuleInfo<T, O>`
+
+Resolves the full rule information from a ruleset.
+
+Returns:
+
+```typescript
+{
+  ...RuleInfo<T, O>,               // Global rule config
+  nodeRules: RuleInfo<T, O>[],     // Non-disabled node-level overrides
+  childNodeRules: RuleInfo<T, O>[], // Non-disabled child-node-level overrides
+}
+```
+
+#### `createAlias(aliasName, options?): MLRule<T, O>`
+
+Creates a virtual rule that reuses this rule's verify/fix logic under a different name. Used internally by `expandNamedNodeRules()` to implement named nodeRules.
+
+Options:
+
+| Option            | Type              | Description                                                                           |
+| ----------------- | ----------------- | ------------------------------------------------------------------------------------- |
+| `defaultSeverity` | `Severity`        | Override the base rule's default severity (explicit only; not set by specConformance) |
+| `specConformance` | `SpecConformance` | `'normative'` or `'non-normative'`                                                    |
+| `groupName`       | `string`          | Group name for multi-entry named nodeRules                                            |
+
+The alias rule inherits the base rule's verify/fix functions, meta, and defaults. Its `baseRuleId` property returns the base rule's name.
+
+#### `optimizeOption(configSettings): RuleInfo<T, O>`
+
+Normalizes raw rule settings into resolved `RuleInfo`.
+
+| Input                  | Result                                                                                  |
+| ---------------------- | --------------------------------------------------------------------------------------- |
+| `undefined` or `false` | `{ disabled: true, severity: default, value: default, options: default }`               |
+| `true`                 | `{ disabled: false, severity: default, value: default, options: default }`              |
+| `RuleConfig` object    | `{ disabled: false, severity: config/default, value: config/default, options: merged }` |
+| Primitive value        | `{ disabled: false, severity: default, value: input, options: default }`                |
+
+Options merging: arrays are spread (`[...a, ...b]`), objects are spread (`{...a, ...b}`), otherwise fallback to `b ?? a`.
+
+## MLRuleContext
+
+Source: `src/ml-rule/ml-rule-context.ts`
+
+`MLRuleContext<T, O>` provides the execution context for rules.
+
+### Constructor
+
+```typescript
+constructor(document: MLDocument<T, O>, locale: LocaleSet)
+```
+
+Creates translator from locale, stores document reference.
+
+### Properties
+
+| Property    | Type               | Description                 |
+| ----------- | ------------------ | --------------------------- |
+| `document`  | `MLDocument<T, O>` | The document being verified |
+| `locale`    | `string`           | Locale string               |
+| `translate` | `Translator`       | i18n message translator     |
+
+### `provide(): ProvidedContext`
+
+Returns the context object passed to `RuleSeed.verify()` and `RuleSeed.fix()`:
+
+```typescript
+{
+  document: MLDocument<T, O>,
+  translate: Translator,
+  t: Translator,        // alias for translate
+  reports: Report<T, O>[],
+  report: (report) => void | boolean,
+}
+```
+
+### `report(report)`
+
+Two overloads:
+
+1. **Direct report** (`Report<T, O>`): Pushes the report directly. Returns `undefined`.
+2. **Checker report** (`CheckerReport<T, O>`): Calls the function with translator. If it returns a report, pushes it and returns `true`. If `null`/`undefined`, returns `false`.
+
+### Deduplication
+
+Reports are deduplicated in `_push()` using:
+
+- **Scope-based**: same `scope` object + same `message`
+- **Position-based**: same `col` + `line` + `message` + `raw`
+
+### Message Finalization
+
+For English locale (`'en'`), the first lowercase letter is capitalized. Other locales pass through unchanged.
+
+## Checker Types
+
+Source: `src/ml-rule/types.ts`
+
+Utility types for building checker functions:
+
+| Type                      | Signature                                                    | Description                |
+| ------------------------- | ------------------------------------------------------------ | -------------------------- |
+| `Checker<T, O, P>`        | `(params: P) => CheckerReport<T, O>`                         | Generic checker            |
+| `ElementChecker<T, O, P>` | `(params: P & { el: Element<T, O> }) => CheckerReport<T, O>` | Element-specific checker   |
+| `AttrChecker<T, O, P>`    | `(params: P & { attr: Attr<T, O> }) => CheckerReport<T, O>`  | Attribute-specific checker |
+| `CheckerReport<T, O>`     | `(t: Translator) => Report<T, O> \| undefined \| null`       | Deferred report function   |
+
+## Rule Mapping
+
+For detailed documentation on `RuleMapper`, rule configuration resolution (three-layer processing with `rules`, `nodeRules`, `childNodeRules`), specificity-based conflict resolution, merging behavior, and regex selector templates, see the dedicated [Rule Mapping](./ml-dom/rule-mapping.md) reference.
+
+## Ruleset
+
+Source: `src/ruleset/index.ts`
+
+Extracts rule configuration from a `Config` object.
+
+```typescript
+class Ruleset {
+  readonly rules: Rules;
+  readonly nodeRules: readonly NodeRule[];
+  readonly childNodeRules: readonly ChildNodeRule[];
+
+  constructor(config: Config);
+}
+```
+
+- `rules` -- Global rule definitions (from `config.rules`, defaults to `{}`)
+- `nodeRules` -- Node-specific overrides (from `config.nodeRules`, defaults to `[]`)
+- `childNodeRules` -- Child-node-specific overrides (from `config.childNodeRules`, defaults to `[]`)
+
+## Test Utilities
+
+Source: `src/ml-rule/create-test-rule.ts`
+
+### createTestRule
+
+```typescript
+function createRule<T, O>(seed: Readonly<RuleSeed<T, O>> & { readonly name: string }): MLRule<T, O>;
+```
+
+Creates an `MLRule` instance for testing. Unlike `createRule()` in `create-rule.ts`, this requires a `name` property and returns an actual `MLRule` instance.
+
+### Test Pattern
+
+```typescript
+import { createRule } from '@markuplint/ml-core/test';
+import { createTestDocument } from '@markuplint/ml-core/test';
+
+const rule = createRule({
+  name: 'my-rule',
+  defaultSeverity: 'error',
+  async verify({ document, report, t }) {
+    // verification logic
+  },
+});
+
+const doc = createTestDocument('<div></div>');
+const violations = await rule.verify(doc, { locale: 'en' }, false);
+```

package/lib/convert-ruleset.d.ts

@@ -1,3 +1,10 @@
 import type { Config } from '@markuplint/ml-config';
 import { Ruleset } from './ruleset/index.js';
+/**
+ * Converts a markuplint {@link Config} object into a {@link Ruleset} instance
+ * that can be used by the linting engine.
+ *
+ * @param config - The configuration to convert (defaults to an empty config)
+ * @returns A new Ruleset instance
+ */
 export declare function convertRuleset(config?: Config): Ruleset;

package/lib/convert-ruleset.js

@@ -1,4 +1,11 @@
 import { Ruleset } from './ruleset/index.js';
+/**
+ * Converts a markuplint {@link Config} object into a {@link Ruleset} instance
+ * that can be used by the linting engine.
+ *
+ * @param config - The configuration to convert (defaults to an empty config)
+ * @returns A new Ruleset instance
+ */
 export function convertRuleset(config = {}) {
     return new Ruleset(config);
 }

package/lib/debug.d.ts

@@ -1,3 +1,7 @@
 import debug from 'debug';
 export declare const log: debug.Debugger;
+/**
+ * Enables debug logging for the `ml-core` namespace and the CLI namespace.
+ * No-op if debug logging is already enabled.
+ */
 export declare function enableDebug(): void;

package/lib/debug.js

@@ -1,6 +1,10 @@
 import debug from 'debug';
 const CLI_NS = 'markuplint-cli';
 export const log = debug('ml-core');
+/**
+ * Enables debug logging for the `ml-core` namespace and the CLI namespace.
+ * No-op if debug logging is already enabled.
+ */
 export function enableDebug() {
     if (!log.enabled) {
         debug.enable(`${log.namespace}*`);

package/lib/index.d.ts

@@ -1,4 +1,4 @@
-export { RuleInfo, RuleConfig, RuleConfigValue } from '@markuplint/ml-config';
+export type { RuleInfo, RuleConfig, RuleConfigValue } from '@markuplint/ml-config';
 export { ariaSpecs, contentModelCategoryToTagNames, getAttrSpecs, getComputedRole, getImplicitRole, getPermittedRoles, getRoleSpec, getSpec, resolveNamespace, } from '@markuplint/ml-spec';
 export { Ruleset } from './ruleset/index.js';
 export { enableDebug } from './debug.js';
@@ -9,7 +9,8 @@ export * from './ml-dom/index.js';
 export * from './ml-rule/index.js';
 export * from './plugin/index.js';
 export * from './test/index.js';
-export * from './types.js';
+export type * from './types.js';
 export * from './utils/index.js';
 export * from './violation-collector.js';
-export { AccessibilityProperties } from './ml-dom/node/types.js';
+export * from './virtual-rule.js';
+export type { AccessibilityProperties } from './ml-dom/node/types.js';

package/lib/index.js

@@ -8,6 +8,6 @@ export * from './ml-dom/index.js';
 export * from './ml-rule/index.js';
 export * from './plugin/index.js';
 export * from './test/index.js';
-export * from './types.js';
 export * from './utils/index.js';
 export * from './violation-collector.js';
+export * from './virtual-rule.js';