hast-util-dl-list 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Yohei Kanamura
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,70 @@
+# hast-util-dl-list
+
+HAST handlers for rendering mdast definition list nodes
+as `<dl>`, `<dt>`, and `<dd>` elements.
+
+This package is designed to be used with `remark-rehype`.
+
+For the detailed definition list syntax,  
+→ **[docs/syntax.md](https://github.com/kanemu/unified-dl-list/blob/main/docs/syntax.md)**.
+
+## Installation
+
+```bash
+npm install hast-util-dl-list
+```
+
+or with pnpm:
+
+```bash
+pnpm add hast-util-dl-list
+```
+
+## Usage
+
+```js
+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 { dlListHandlers } from 'hast-util-dl-list'
+
+const html = await unified()
+    .use(remarkParse)
+    .use(remarkDlList)
+    .use(remarkRehype, {
+        handlers: dlListHandlers()
+    })
+    .use(rehypeStringify)
+    .process(`
+: term
+    : description
+  `)
+
+console.log(String(html))
+```
+
+## What this package does
+
+* Provides HAST handlers for mdast definition list nodes
+* Converts definition lists into `<dl>`, `<dt>`, and `<dd>`
+* Preserves `data.hProperties` and `data.hName`
+
+## What this package does NOT do
+
+* Does not parse markdown
+* Does not serialize markdown
+* Does not install remark or rehype plugins automatically
+
+## Related packages
+
+This package is part of the **[unified-dl-list](https://github.com/kanemu/unified-dl-list)** monorepo:
+
+- [`remark-dl-list`](https://github.com/kanemu/unified-dl-list/tree/main/packages/remark-dl-list)
+- [`micromark-extension-dl-list`](https://github.com/kanemu/unified-dl-list/tree/main/packages/micromark-extension-dl-list)
+- [`mdast-util-dl-list`](https://github.com/kanemu/unified-dl-list/tree/main/packages/mdast-util-dl-list)
+
+## License
+
+MIT

package/dist/index.d.ts

@@ -0,0 +1,38 @@
+import { Handlers, State } from 'mdast-util-to-hast';
+import { Properties, Element } from 'hast';
+import { Data } from 'mdast';
+
+/**
+ * Handlers for mdast definition list nodes.
+ *
+ * These handlers are meant to be passed to `mdast-util-to-hast` / `remark-rehype`.
+ */
+declare function dlListHandlers(): Handlers;
+
+/**
+ * Context object passed to each handler.
+ * This is the same `state` object provided by mdast-util-to-hast.
+ */
+type HastState = State;
+/**
+ * Minimal shape of mdast nodes this package cares about.
+ *
+ * - `data.hName`, `data.hProperties`, `data.hChildren` are respected by `state.applyData`.
+ * - Keep loose: mdast is extensible and downstream plugins may attach fields.
+ */
+interface MdastNode {
+    type: string;
+    children?: MdastNode[];
+    data?: Data & {
+        hName?: string;
+        hProperties?: Properties;
+        hChildren?: MdastNode[];
+        [key: string]: unknown;
+    };
+}
+/**
+ * Resulting hast Element produced by handlers.
+ */
+type HastElement = Element;
+
+export { type HastElement, type HastState, type MdastNode, dlListHandlers };

package/dist/index.js

@@ -0,0 +1,43 @@
+// src/handlers.ts
+import { h } from "hastscript";
+function createDl(state, node) {
+  const children = state.all(node);
+  const dl = h("dl", children);
+  state.applyData(node, dl);
+  return dl;
+}
+function createDlItem(state, node) {
+  return state.all(node);
+}
+function createDt(state, node) {
+  const children = state.all(node);
+  const dt = h("dt", children);
+  state.applyData(node, dt);
+  return dt;
+}
+function createDd(state, node) {
+  const children = state.all(node);
+  const dd = h("dd", children);
+  state.applyData(node, dd);
+  return dd;
+}
+function dlListHandlers() {
+  return {
+    definitionList(state, node) {
+      return createDl(state, node);
+    },
+    definitionItem(state, node) {
+      return createDlItem(state, node);
+    },
+    definitionTerm(state, node) {
+      return createDt(state, node);
+    },
+    definitionDescription(state, node) {
+      return createDd(state, node);
+    }
+  };
+}
+export {
+  dlListHandlers
+};
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/handlers.ts"],"sourcesContent":["import { h } from 'hastscript'\nimport type { Handlers } from 'mdast-util-to-hast'\nimport type { HastState, MdastNode, HastElement } from './types'\n\n/**\n * Create a <dl> element from a definitionList mdast node.\n */\nfunction createDl(state: HastState, node: MdastNode): HastElement {\n    const children = state.all(node as any) as any[]\n    const dl = h('dl', children) as HastElement\n    state.applyData(node as any, dl)\n    return dl\n}\n\n/**\n * definitionItem itself does not map to an HTML element.\n * It expands to dt + dd elements.\n */\nfunction createDlItem(state: HastState, node: MdastNode): HastElement[] {\n    return state.all(node as any) as HastElement[]\n}\n\n/**\n * Create a <dt> element.\n */\nfunction createDt(state: HastState, node: MdastNode): HastElement {\n    const children = state.all(node as any) as any[]\n    const dt = h('dt', children) as HastElement\n    state.applyData(node as any, dt)\n    return dt\n}\n\n/**\n * Create a <dd> element.\n *\n * mdast-util-dl-list may unwrap a single paragraph into phrasing children:\n * - phrasing-only children -> <dd>desc</dd>\n * - block children (paragraph/list/...) -> <dd><p>...</p>...</dd>\n */\nfunction createDd(state: HastState, node: MdastNode): HastElement {\n    const children = state.all(node as any) as any[]\n    const dd = h('dd', children) as HastElement\n    state.applyData(node as any, dd)\n    return dd\n}\n\n/**\n * Handlers for mdast definition list nodes.\n *\n * These handlers are meant to be passed to `mdast-util-to-hast` / `remark-rehype`.\n */\nexport function dlListHandlers(): Handlers {\n    return {\n        definitionList(state: HastState, node: MdastNode) {\n            return createDl(state, node)\n        },\n\n        definitionItem(state: HastState, node: MdastNode) {\n            return createDlItem(state, node)\n        },\n\n        definitionTerm(state: HastState, node: MdastNode) {\n            return createDt(state, node)\n        },\n\n        definitionDescription(state: HastState, node: MdastNode) {\n            return createDd(state, node)\n        }\n    } as unknown as Handlers\n}\n"],"mappings":";AAAA,SAAS,SAAS;AAOlB,SAAS,SAAS,OAAkB,MAA8B;AAC9D,QAAM,WAAW,MAAM,IAAI,IAAW;AACtC,QAAM,KAAK,EAAE,MAAM,QAAQ;AAC3B,QAAM,UAAU,MAAa,EAAE;AAC/B,SAAO;AACX;AAMA,SAAS,aAAa,OAAkB,MAAgC;AACpE,SAAO,MAAM,IAAI,IAAW;AAChC;AAKA,SAAS,SAAS,OAAkB,MAA8B;AAC9D,QAAM,WAAW,MAAM,IAAI,IAAW;AACtC,QAAM,KAAK,EAAE,MAAM,QAAQ;AAC3B,QAAM,UAAU,MAAa,EAAE;AAC/B,SAAO;AACX;AASA,SAAS,SAAS,OAAkB,MAA8B;AAC9D,QAAM,WAAW,MAAM,IAAI,IAAW;AACtC,QAAM,KAAK,EAAE,MAAM,QAAQ;AAC3B,QAAM,UAAU,MAAa,EAAE;AAC/B,SAAO;AACX;AAOO,SAAS,iBAA2B;AACvC,SAAO;AAAA,IACH,eAAe,OAAkB,MAAiB;AAC9C,aAAO,SAAS,OAAO,IAAI;AAAA,IAC/B;AAAA,IAEA,eAAe,OAAkB,MAAiB;AAC9C,aAAO,aAAa,OAAO,IAAI;AAAA,IACnC;AAAA,IAEA,eAAe,OAAkB,MAAiB;AAC9C,aAAO,SAAS,OAAO,IAAI;AAAA,IAC/B;AAAA,IAEA,sBAAsB,OAAkB,MAAiB;AACrD,aAAO,SAAS,OAAO,IAAI;AAAA,IAC/B;AAAA,EACJ;AACJ;","names":[]}

package/package.json

@@ -0,0 +1,65 @@
+{
+  "name": "hast-util-dl-list",
+  "version": "0.1.0",
+  "description": "Handlers only for converting mdast definition list nodes into hast elements (<dl>, <dt>, <dd>) for remark-rehype.",
+  "type": "module",
+  "license": "MIT",
+  "author": "Yohei Kanamura",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/kanemu/unified-dl-list",
+    "directory": "packages/hast-util-dl-list"
+  },
+  "homepage": "https://github.com/kanemu/unified-dl-list/tree/main/packages/hast-util-dl-list",
+  "bugs": {
+    "url": "https://github.com/kanemu/unified-dl-list/issues"
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist/**",
+    "README.md",
+    "LICENSE"
+  ],
+  "dependencies": {
+    "hastscript": "^9.0.1",
+    "mdast-util-to-hast": "^13.2.1"
+  },
+  "devDependencies": {
+    "@types/mdast": "^4.0.4",
+    "@types/hast": "^3.0.4",
+    "hast-util-to-html": "^9.0.5",
+    "mdast-util-dl-list": "^0.1.0",
+    "mdast-util-from-markdown": "^2.0.2",
+    "micromark-extension-dl-list": "^0.1.0",
+    "rimraf": "^6.1.2",
+    "tsup": "^8.5.1",
+    "typescript": "^5.4.0"
+  },
+  "keywords": [
+    "unified",
+    "remark",
+    "rehype",
+    "hast",
+    "mdast",
+    "remark-rehype",
+    "hast-util",
+    "markdown",
+    "definition-list",
+    "dl",
+    "dt",
+    "dd"
+  ],
+  "scripts": {
+    "build": "tsup",
+    "clean": "rimraf dist",
+    "test": "pnpm build && node --test ./test/*.test.js",
+    "typecheck": "tsc -p tsconfig.json --noEmit"
+  }
+}