remark-dl-list 0.1.2 → 0.1.3

package/README-ja.md

@@ -6,6 +6,24 @@
 このプラグインは remark に定義リストのサポートを追加し、
 Markdown へのラウンドトリップ（再シリアライズ）を可能にします。
 
+構文:
+
+```md
+: term
+    : description
+    : another description
+```
+
+は次のように変換されます。
+
+```html
+<dl>
+  <dt>term</dt>
+  <dd>description</dd>
+  <dd>another description</dd>
+</dl>
+```
+
 定義リストの詳細な構文については、
 → **[docs/syntax-ja.md](https://github.com/kanemu/unified-dl-list/blob/main/docs/syntax-ja.md)** を参照してください。
 
@@ -29,7 +47,7 @@ pnpm add remark-dl-list
 import { unified } from 'unified'
 import remarkParse from 'remark-parse'
 import remarkStringify from 'remark-stringify'
-import { remarkDlList } from 'remark-dl-list'
+import remarkDlList from 'remark-dl-list'
 
 const md = `
 : term1
@@ -70,7 +88,7 @@ import { unified } from 'unified'
 import remarkParse from 'remark-parse'
 import remarkRehype from 'remark-rehype'
 import rehypeStringify from 'rehype-stringify'
-import { remarkDlList } from 'remark-dl-list'
+import remarkDlList from 'remark-dl-list'
 import { dlListHandlers } from 'hast-util-dl-list'
 
 const html = await unified()
@@ -104,7 +122,7 @@ import remarkGfm from 'remark-gfm'
 import remarkRehype from 'remark-rehype'
 import rehypeStringify from 'rehype-stringify'
 
-import { remarkDlList } from 'remark-dl-list'
+import remarkDlList from 'remark-dl-list'
 import { dlListHandlers } from 'hast-util-dl-list'
 
 const processor = unified()
@@ -162,24 +180,6 @@ console.log(html)
 * 単体で HTML を生成しません
 * 定義リスト構文が存在しない場合の通常の Markdown の挙動は変更しません
 
-## 構文
-
-```md
-: term
-    : description
-    : another description
-```
-
-は次のように変換されます。
-
-```html
-<dl>
-  <dt>term</dt>
-  <dd>description</dd>
-  <dd>another description</dd>
-</dl>
-```
-
 ## 関連パッケージ
 
 このパッケージは **[unified-dl-list](https://github.com/kanemu/unified-dl-list)** モノレポの一部です。

package/README.md

@@ -6,6 +6,24 @@ using `<dl>`, `<dt>`, and `<dd>` syntax.
 This plugin adds support for definition lists to remark and allows
 round-trip serialization back to markdown.
 
+Syntax:
+
+```md
+: term
+    : description
+    : another description
+```
+
+is converted to:
+
+```html
+<dl>
+  <dt>term</dt>
+  <dd>description</dd>
+  <dd>another description</dd>
+</dl>
+```
+
 For the detailed definition list syntax,
 → **[docs/syntax.md](https://github.com/kanemu/unified-dl-list/blob/main/docs/syntax.md)**.
 
@@ -29,7 +47,7 @@ pnpm add remark-dl-list
 import { unified } from 'unified'
 import remarkParse from 'remark-parse'
 import remarkStringify from 'remark-stringify'
-import { remarkDlList } from 'remark-dl-list'
+import remarkDlList from 'remark-dl-list'
 
 const md = `
 : term1
@@ -70,7 +88,7 @@ import { unified } from 'unified'
 import remarkParse from 'remark-parse'
 import remarkRehype from 'remark-rehype'
 import rehypeStringify from 'rehype-stringify'
-import { remarkDlList } from 'remark-dl-list'
+import remarkDlList from 'remark-dl-list'
 import { dlListHandlers } from 'hast-util-dl-list'
 
 const html = await unified()
@@ -103,7 +121,7 @@ import remarkGfm from 'remark-gfm'
 import remarkRehype from 'remark-rehype'
 import rehypeStringify from 'rehype-stringify'
 
-import { remarkDlList } from 'remark-dl-list'
+import remarkDlList from 'remark-dl-list'
 import { dlListHandlers } from 'hast-util-dl-list'
 
 const processor = unified()
@@ -172,24 +190,6 @@ Output:
 * Does **not** generate HTML by itself
 * Does **not** change normal markdown behavior when no dl syntax is present
 
-## Syntax
-
-```md
-: term
-    : description
-    : another description
-```
-
-is converted to:
-
-```html
-<dl>
-  <dt>term</dt>
-  <dd>description</dd>
-  <dd>another description</dd>
-</dl>
-```
-
 ## Related packages
 
 This package is part of the **[unified-dl-list](https://github.com/kanemu/unified-dl-list)** monorepo:

package/dist/index.d.ts

@@ -27,4 +27,4 @@ import { Processor } from 'unified';
  */
 declare function remarkDlList(this: Processor): void;
 
-export { remarkDlList };
+export { remarkDlList as default, remarkDlList };

package/dist/index.js

@@ -17,7 +17,9 @@ function remarkDlList() {
   );
   toMarkdownExtensions.push(dlListToMarkdown());
 }
+var index_default = remarkDlList;
 export {
+  index_default as default,
   remarkDlList
 };
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/index.ts"],"sourcesContent":["import { dlList } from \"micromark-extension-dl-list\";\nimport { dlListFromMarkdown, dlListToMarkdown } from \"mdast-util-dl-list\";\n\nimport type { Processor } from \"unified\";\nimport type { Extension as MicromarkExtension } from \"micromark-util-types\";\nimport type { Extension as FromMarkdownExtension } from \"mdast-util-from-markdown\";\nimport type { Options as ToMarkdownOptions } from \"mdast-util-to-markdown\";\n\ntype ToMarkdownExtension =\n    NonNullable<ToMarkdownOptions[\"extensions\"]>[number];\n\n/**\n * remark plugin that enables colon-based definition lists using `<dl>`, `<dt>`, and `<dd>`.\n *\n * This plugin wires:\n * - micromark extension (syntax)\n * - mdast from-markdown extension (AST generation)\n * - mdast to-markdown extension (serialization)\n *\n * What this plugin intentionally does NOT do:\n * - It does NOT install `remark-rehype`.\n * - It does NOT register hast handlers automatically.\n *\n * If you need HTML output, combine this plugin with:\n * - `remark-rehype`\n * - `hast-util-dl-list`\n *\n * Example:\n *\n * ```ts\n * unified()\n *   .use(remarkParse)\n *   .use(remarkDlList)\n *   .use(remarkRehype, { handlers: dlListHandlers() })\n * ```\n */\nexport function remarkDlList(this: Processor): void {\n    const data = this.data() as Record<string, unknown>;\n\n    const micromarkExtensions =\n        (data.micromarkExtensions as MicromarkExtension[] | undefined) ??\n        ((data.micromarkExtensions = []) as MicromarkExtension[]);\n\n    const fromMarkdownExtensions =\n        (data.fromMarkdownExtensions as FromMarkdownExtension[] | undefined) ??\n        ((data.fromMarkdownExtensions = []) as FromMarkdownExtension[]);\n\n    const toMarkdownExtensions =\n        (data.toMarkdownExtensions as ToMarkdownExtension[] | undefined) ??\n        ((data.toMarkdownExtensions = []) as ToMarkdownExtension[]);\n\n    // Capture “other” extensions that are already registered at this moment.\n    // These will be inherited by dd/dt reparse inside mdast-util-dl-list.\n    const inheritedMicromark = micromarkExtensions.slice();\n    const inheritedFromMd = fromMarkdownExtensions.slice();\n\n    // Register dl-list itself\n    micromarkExtensions.push(dlList());\n\n    // IMPORTANT: pass inherited extensions to dlListFromMarkdown so dd reparse can see them\n    fromMarkdownExtensions.push(\n        dlListFromMarkdown({\n            extensions: inheritedMicromark as any,\n            mdastExtensions: inheritedFromMd as any,\n        })\n    );\n\n    toMarkdownExtensions.push(dlListToMarkdown());\n}"],"mappings":";AAAA,SAAS,cAAc;AACvB,SAAS,oBAAoB,wBAAwB;AAmC9C,SAAS,eAAoC;AAChD,QAAM,OAAO,KAAK,KAAK;AAEvB,QAAM,sBACD,KAAK,wBACJ,KAAK,sBAAsB,CAAC;AAElC,QAAM,yBACD,KAAK,2BACJ,KAAK,yBAAyB,CAAC;AAErC,QAAM,uBACD,KAAK,yBACJ,KAAK,uBAAuB,CAAC;AAInC,QAAM,qBAAqB,oBAAoB,MAAM;AACrD,QAAM,kBAAkB,uBAAuB,MAAM;AAGrD,sBAAoB,KAAK,OAAO,CAAC;AAGjC,yBAAuB;AAAA,IACnB,mBAAmB;AAAA,MACf,YAAY;AAAA,MACZ,iBAAiB;AAAA,IACrB,CAAC;AAAA,EACL;AAEA,uBAAqB,KAAK,iBAAiB,CAAC;AAChD;","names":[]}
+{"version":3,"sources":["../src/index.ts"],"sourcesContent":["import { dlList } from \"micromark-extension-dl-list\";\nimport { dlListFromMarkdown, dlListToMarkdown } from \"mdast-util-dl-list\";\n\nimport type { Processor } from \"unified\";\nimport type { Extension as MicromarkExtension } from \"micromark-util-types\";\nimport type { Extension as FromMarkdownExtension } from \"mdast-util-from-markdown\";\nimport type { Options as ToMarkdownOptions } from \"mdast-util-to-markdown\";\n\ntype ToMarkdownExtension =\n    NonNullable<ToMarkdownOptions[\"extensions\"]>[number];\n\n/**\n * remark plugin that enables colon-based definition lists using `<dl>`, `<dt>`, and `<dd>`.\n *\n * This plugin wires:\n * - micromark extension (syntax)\n * - mdast from-markdown extension (AST generation)\n * - mdast to-markdown extension (serialization)\n *\n * What this plugin intentionally does NOT do:\n * - It does NOT install `remark-rehype`.\n * - It does NOT register hast handlers automatically.\n *\n * If you need HTML output, combine this plugin with:\n * - `remark-rehype`\n * - `hast-util-dl-list`\n *\n * Example:\n *\n * ```ts\n * unified()\n *   .use(remarkParse)\n *   .use(remarkDlList)\n *   .use(remarkRehype, { handlers: dlListHandlers() })\n * ```\n */\nexport function remarkDlList(this: Processor): void {\n    const data = this.data() as Record<string, unknown>;\n\n    const micromarkExtensions =\n        (data.micromarkExtensions as MicromarkExtension[] | undefined) ??\n        ((data.micromarkExtensions = []) as MicromarkExtension[]);\n\n    const fromMarkdownExtensions =\n        (data.fromMarkdownExtensions as FromMarkdownExtension[] | undefined) ??\n        ((data.fromMarkdownExtensions = []) as FromMarkdownExtension[]);\n\n    const toMarkdownExtensions =\n        (data.toMarkdownExtensions as ToMarkdownExtension[] | undefined) ??\n        ((data.toMarkdownExtensions = []) as ToMarkdownExtension[]);\n\n    // Capture “other” extensions that are already registered at this moment.\n    // These will be inherited by dd/dt reparse inside mdast-util-dl-list.\n    const inheritedMicromark = micromarkExtensions.slice();\n    const inheritedFromMd = fromMarkdownExtensions.slice();\n\n    // Register dl-list itself\n    micromarkExtensions.push(dlList());\n\n    // IMPORTANT: pass inherited extensions to dlListFromMarkdown so dd reparse can see them\n    fromMarkdownExtensions.push(\n        dlListFromMarkdown({\n            extensions: inheritedMicromark as any,\n            mdastExtensions: inheritedFromMd as any,\n        })\n    );\n\n    toMarkdownExtensions.push(dlListToMarkdown());\n}\n\nexport default remarkDlList\n"],"mappings":";AAAA,SAAS,cAAc;AACvB,SAAS,oBAAoB,wBAAwB;AAmC9C,SAAS,eAAoC;AAChD,QAAM,OAAO,KAAK,KAAK;AAEvB,QAAM,sBACD,KAAK,wBACJ,KAAK,sBAAsB,CAAC;AAElC,QAAM,yBACD,KAAK,2BACJ,KAAK,yBAAyB,CAAC;AAErC,QAAM,uBACD,KAAK,yBACJ,KAAK,uBAAuB,CAAC;AAInC,QAAM,qBAAqB,oBAAoB,MAAM;AACrD,QAAM,kBAAkB,uBAAuB,MAAM;AAGrD,sBAAoB,KAAK,OAAO,CAAC;AAGjC,yBAAuB;AAAA,IACnB,mBAAmB;AAAA,MACf,YAAY;AAAA,MACZ,iBAAiB;AAAA,IACrB,CAAC;AAAA,EACL;AAEA,uBAAqB,KAAK,iBAAiB,CAAC;AAChD;AAEA,IAAO,gBAAQ;","names":[]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "remark-dl-list",
-  "version": "0.1.2",
+  "version": "0.1.3",
   "description": "A remark plugin that enables colon-based definition lists by wiring micromark and mdast extensions for <dl>, <dt>, and <dd>.",
   "type": "module",
   "license": "MIT",
@@ -29,8 +29,8 @@
     "LICENSE"
   ],
   "dependencies": {
-    "mdast-util-dl-list": "^0.1.2",
-    "micromark-extension-dl-list": "^0.1.2"
+    "mdast-util-dl-list": "^0.1.3",
+    "micromark-extension-dl-list": "^0.1.3"
   },
   "peerDependencies": {
     "unified": "^11.0.5"