{
  "url": "https://unifast.dev/ja/docs/packages/core/overview/",
  "locale": "ja",
  "title": "@unifast/core",
  "description": "unifast のランタイムパッケージ間で共有される TypeScript の型定義、HAST ユーティリティ、エラークラスです。",
  "section": "packages",
  "body": "## 概要\n\n`@unifast/core` は、compile オプションや結果、HAST (HTML 抽象構文木) ノード、プラグインインターフェース、エラークラスのための共有 TypeScript 型定義を提供します。`@unifast/node` のようなランタイムパッケージの依存関係であり、通常は直接インストールする **必要はありません**。\n\nコンパイラや組み込みプラグインを利用する場合は [`@unifast/node`](/docs/packages/node/overview) を使用してください。\n\n## インストール\n\n## 型定義\n\n### CompileOptions\n\n`compile()` 関数の設定です。\n\n| プロパティ | 型 | デフォルト | 説明 |\n|----------|------|---------|-------------|\n| `inputKind` | `\"md\" \\| \"mdx\"` | `\"md\"` | 入力フォーマット |\n| `outputKind` | `\"html\" \\| \"hast\" \\| \"mdast\" \\| \"mdxJs\"` | `\"html\"` | 出力フォーマット |\n| `gfm` | `object` | - | GitHub Flavored Markdown の設定 |\n| `gfm.tables` | `boolean` | - | GFM テーブルを有効にする |\n| `gfm.taskList` | `boolean` | - | タスクリストのチェックボックスを有効にする |\n| `gfm.strikethrough` | `boolean` | - | `~~strikethrough~~` を有効にする |\n| `gfm.footnotes` | `boolean` | - | 脚注を有効にする |\n| `gfm.autolink` | `boolean` | - | URL の自動リンクを有効にする |\n| `frontmatter` | `object` | - | frontmatter のパース設定 |\n| `frontmatter.yaml` | `boolean` | - | YAML frontmatter をパースする |\n| `frontmatter.toml` | `boolean` | - | TOML frontmatter をパースする |\n| `frontmatter.json` | `boolean` | - | JSON frontmatter をパースする |\n| `rawHtml` | `\"disallow\" \\| \"allowDangerous\" \\| \"parseAndSanitize\"` | - | ソース内の生の HTML の扱い方 |\n| `sanitize` | `object` | - | HTML サニタイズの設定 |\n| `sanitize.enabled` | `boolean` | - | サニタイズを有効にする |\n| `sanitize.schema` | `SanitizeSchema` | - | カスタムサニタイズルール |\n| `highlight` | `object` | - | シンタックスハイライトの設定 |\n| `highlight.enabled` | `boolean` | - | シンタックスハイライトを有効にする |\n| `highlight.engine` | `\"none\" \\| \"syntect\" \\| \"treeSitter\"` | - | ハイライトエンジン |\n| `slug` | `object` | - | 見出しスラグ生成の設定 |\n| `slug.mode` | `\"github\" \\| \"unicode\"` | - | スラグ生成アルゴリズム |\n| `toc` | `object` | - | 目次の設定 |\n| `toc.enabled` | `boolean` | - | TOC 抽出を有効にする |\n| `toc.maxDepth` | `number` | - | 含める見出しの最大深さ |\n| `diagnostics` | `object` | - | 診断出力の設定 |\n| `diagnostics.format` | `\"compact\" \\| \"verbose\"` | - | 診断フォーマット |\n| `cache` | `object` | - | キャッシュの設定 |\n| `cache.enabled` | `boolean` | - | 結果キャッシュを有効にする |\n| `cache.dir` | `string` | - | キャッシュディレクトリのパス |\n| `plugins` | `UnifastPlugin[]` | `[]` | 適用するプラグインの配列 |\n\n### CompileResult\n\n`compile()` 関数が返す値です。\n\n| プロパティ | 型 | 説明 |\n|----------|------|-------------|\n| `output` | `string \\| object` | コンパイル結果 (HTML 文字列、HAST JSON、または MDAST JSON。`outputKind` によって異なります) |\n| `frontmatter` | `Record<string, unknown>` | パース済みの frontmatter メタデータ |\n| `diagnostics` | `Diagnostic[]` | 警告とエラーの配列 |\n| `stats` | `{ parseMs, transformMs, emitMs }` | ミリ秒単位の処理時間の内訳 |\n| `toc` | `TocEntry[]` | 抽出された目次のエントリ |\n\n### Diagnostic\n\n| プロパティ | 型 | 説明 |\n|----------|------|-------------|\n| `level` | `\"error\" \\| \"warn\"` | 重大度レベル |\n| `message` | `string` | 人間が読めるメッセージ |\n| `start` | `number \\| undefined` | ソース内の開始バイトオフセット |\n| `end` | `number \\| undefined` | ソース内の終了バイトオフセット |\n| `line` | `number \\| undefined` | 行番号 (1 始まり) |\n| `column` | `number \\| undefined` | 列番号 (1 始まり) |\n\n### TocEntry\n\n目次用に抽出された見出し 1 つ分です。\n\n| プロパティ | 型 | 説明 |\n|----------|------|-------------|\n| `depth` | `number` | 見出しレベル (1 〜 6) |\n| `text` | `string` | 見出しのプレーンテキスト内容 |\n| `slug` | `string` | アンカーリンク用に生成されたスラグ |\n\n### SanitizeSchema\n\nカスタムサニタイズルールです。\n\n| プロパティ | 型 | 説明 |\n|----------|------|-------------|\n| `allowedTags` | `string[]` | 許可する HTML タグ |\n| `allowedAttributes` | `Record<string, string[]>` | タグごとに許可する属性 |\n| `allowedProtocols` | `Record<string, string[]>` | 属性ごとに許可する URL プロトコル |\n\n### UnifastPlugin\n\nunifast を拡張するためのプラグインインターフェースです。\n\n| プロパティ | 型 | 説明 |\n|----------|------|-------------|\n| `name` | `string` | 一意なプラグイン名 |\n| `options?` | `Partial<CompileOptions>` | compile オプションにマージするオプション |\n| `hastTransform?` | `(hast: HastRoot) => HastRoot` | コンパイル後に HAST ツリーを変換する |\n\n### HAST ノードの型\n\n| 型 | `type` フィールド | プロパティ | 説明 |\n|------|-------------|------------|-------------|\n| `HastRoot` | `\"root\"` | `children: HastNode[]` | ツリーのルートノード |\n| `HastElement` | `\"element\"` | `tagName`, `properties`, `children` | HTML 要素 |\n| `HastText` | `\"text\"` | `value: string` | テキストノード |\n| `HastRaw` | `\"raw\"` | `value: string` | 生の HTML のパススルー |\n| `HastComment` | `\"comment\"` | `value: string` | HTML コメント |\n| `HastDoctype` | `\"doctype\"` | - | `<!DOCTYPE html>` ノード |\n\n`HastNode` はユニオン型です: `HastRoot | HastElement | HastText | HastRaw | HastComment | HastDoctype`\n\n## エラークラス\n\n| クラス | 継承元 | プロパティ | 説明 |\n|-------|---------|------------|-------------|\n| `UnifastError` | `Error` | `code?: string`, `span?: { start, end }` | すべての unifast エラーの基底クラス |\n| `ParseError` | `UnifastError` | `code: \"PARSE_ERROR\"` | Markdown/MDX 入力をパースできなかった場合にスローされます |\n| `CompileError` | `UnifastError` | `code: \"COMPILE_ERROR\"` | パース後のコンパイルに失敗した場合にスローされます |\n\n```ts\n\ntry {\n  // ... compile something\n} catch (err) {\n  if (err instanceof ParseError) {\n    console.error(`Parse error at ${err.span?.start}: ${err.message}`);\n  } else if (err instanceof CompileError) {\n    console.error(`Compile error: ${err.message}`);\n  }\n}\n```\n\n## エクスポート一覧\n\n| エクスポート | 種類 | 説明 |\n|--------|------|-------------|\n| `CompileOptions` | type | コンパイル設定 |\n| `CompileResult` | type | コンパイル結果 |\n| `TocEntry` | type | 目次のエントリ |\n| `SanitizeSchema` | type | サニタイズルール |\n| `UnifastPlugin` | type | プラグインインターフェース |\n| `HastNode` | type | すべての HAST ノード型のユニオン |\n| `HastRoot` | type | HAST ルートノード |\n| `HastElement` | type | HAST 要素ノード |\n| `HastText` | type | HAST テキストノード |\n| `HastRaw` | type | HAST 生 HTML ノード |\n| `HastComment` | type | HAST コメントノード |\n| `HastDoctype` | type | HAST doctype ノード |\n| `hastToHtml` | function | HAST から HTML へのシリアライザ |\n| `escapeHtml` | function | HTML の特殊文字 (`&`、`<`、`>`、`\"`) をエスケープする |\n| `extractLang` | function | HAST の `<code>` 要素から言語識別子を抽出する |\n| `extractText` | function | HAST ノードからプレーンテキストの内容を抽出する |\n| `findCodeChild` | function | `<pre>` 要素の内部から `<code>` 子要素を見つける |\n| `visitHast` | function | HAST ツリーを走査するビジターパターンのユーティリティ |\n| `UnifastError` | class | 基底エラークラス |\n| `ParseError` | class | パースエラークラス |\n| `CompileError` | class | コンパイルエラークラス |",
  "alternates": [
    {
      "locale": "en",
      "url": "https://unifast.dev/docs/packages/core/overview/",
      "api": "https://unifast.dev//api/docs/packages/core/overview.json"
    },
    {
      "locale": "ja",
      "url": "https://unifast.dev/ja/docs/packages/core/overview/",
      "api": "https://unifast.dev//api/ja/docs/packages/core/overview.json"
    },
    {
      "locale": "zh-CN",
      "url": "https://unifast.dev/zh-CN/docs/packages/core/overview/",
      "api": "https://unifast.dev//api/zh-CN/docs/packages/core/overview.json"
    },
    {
      "locale": "zh-TW",
      "url": "https://unifast.dev/zh-TW/docs/packages/core/overview/",
      "api": "https://unifast.dev//api/zh-TW/docs/packages/core/overview.json"
    },
    {
      "locale": "ko",
      "url": "https://unifast.dev/ko/docs/packages/core/overview/",
      "api": "https://unifast.dev//api/ko/docs/packages/core/overview.json"
    },
    {
      "locale": "fr",
      "url": "https://unifast.dev/fr/docs/packages/core/overview/",
      "api": "https://unifast.dev//api/fr/docs/packages/core/overview.json"
    },
    {
      "locale": "it",
      "url": "https://unifast.dev/it/docs/packages/core/overview/",
      "api": "https://unifast.dev//api/it/docs/packages/core/overview.json"
    },
    {
      "locale": "es",
      "url": "https://unifast.dev/es/docs/packages/core/overview/",
      "api": "https://unifast.dev//api/es/docs/packages/core/overview.json"
    },
    {
      "locale": "pt-BR",
      "url": "https://unifast.dev/pt-BR/docs/packages/core/overview/",
      "api": "https://unifast.dev//api/pt-BR/docs/packages/core/overview.json"
    },
    {
      "locale": "de",
      "url": "https://unifast.dev/de/docs/packages/core/overview/",
      "api": "https://unifast.dev//api/de/docs/packages/core/overview.json"
    },
    {
      "locale": "ru",
      "url": "https://unifast.dev/ru/docs/packages/core/overview/",
      "api": "https://unifast.dev//api/ru/docs/packages/core/overview.json"
    },
    {
      "locale": "hi",
      "url": "https://unifast.dev/hi/docs/packages/core/overview/",
      "api": "https://unifast.dev//api/hi/docs/packages/core/overview.json"
    },
    {
      "locale": "id",
      "url": "https://unifast.dev/id/docs/packages/core/overview/",
      "api": "https://unifast.dev//api/id/docs/packages/core/overview.json"
    },
    {
      "locale": "tr",
      "url": "https://unifast.dev/tr/docs/packages/core/overview/",
      "api": "https://unifast.dev//api/tr/docs/packages/core/overview.json"
    },
    {
      "locale": "vi",
      "url": "https://unifast.dev/vi/docs/packages/core/overview/",
      "api": "https://unifast.dev//api/vi/docs/packages/core/overview.json"
    }
  ]
}