mdast-util-block-id 1.0.0

package/README.md

@@ -0,0 +1,61 @@
+# mdast-util-block-id
+
+[mdast][] extensions to parse [Obsidian]-style inline footnotes
+and convert them to [GFM footnotes][gfm-footnote].
+Intended to be used with [micromark-extension-block-id][].
+
+## Install
+
+This package is [ESM only][esm].
+In Node.js (version 16+), install with [npm][]:
+
+```sh
+npm install micromark-extension-block-id mdast-util-block-id
+```
+
+In Deno with [`esm.sh`][esmsh]:
+
+```js
+import { blockIdFromMarkdown } from "https://esm.sh/mdast-util-block-id@1";
+```
+
+In browsers with [`esm.sh`][esmsh]:
+
+```html
+<script type="module">
+	import { blockIdFromMarkdown } from "https://esm.sh/mdast-util-block-id12?bundle";
+</script>
+```
+
+## API
+
+This package exports the identifiers
+[`blockIdFromMarkdown`][api-frommarkdown].
+There is no default export.
+
+### `blockIdFromMarkdown()`
+
+Create an extension for
+[`mdast-util-from-markdown`][mdast-util-from-markdown]
+to enable block ids in markdown.
+
+###### Returns
+
+Extension for `mdast-util-from-markdown`
+([`FromMarkdownExtension`][frommarkdownextension]).
+
+[Obsidian]: https://obsidian.md
+[mdast-util-from-markdown]: https://github.com/syntax-tree/mdast-util-from-markdown
+[micromark]: https://github.com/micromark/micromark
+[mdast-util-block-id]: https://github.com/jajaperson/unified-block-id/tree/main/packages/mdast-util-block-id
+[esmsh]: https://esm.sh
+[esm]: https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c
+[micromark-extension]: https://github.com/micromark/micromark#syntaxextension
+[mdast]: https://github.com/syntax-tree/mdast
+[gfm-footnote]: https://github.com/syntax-tree/mdast-util-gfm-footnote
+[npm]: https://docs.npmjs.com/cli/install
+[api-frommarkdown]: #blockidfrommarkdown
+[frommarkdownextension]: https://github.com/syntax-tree/mdast-util-from-markdown#extension
+[api-togfm]: #inlinefootnotetogfm
+[micromark-extension-block-id]: https://github.com/jajaperson/unified-block-id/tree/main/packages/micromark-extension-block-id
+[micromark-extension-block-id]: https://github.com/jajaperson/unified-block-id/tree/main/packages/micromark-extension-block-id

package/index.d.ts

@@ -0,0 +1,12 @@
+import { Literal } from "mdast";
+export { blockIdFromMarkdown } from "./lib/index.js";
+
+export interface BlockId extends Literal {
+	type: "blockId";
+}
+
+declare module "mdast" {
+	interface RootContentMap {
+		blockId: BlockId;
+	}
+}

package/index.js

@@ -0,0 +1 @@
+export * from "./lib/index.js";

package/lib/index.js

@@ -0,0 +1,58 @@
+/** @import {Extension as FromMarkdownExtension, CompileContext, Handle as FromMarkdownHandle} from "mdast-util-from-markdown" */
+/** @import {Root, FootnoteDefinition, FootnoteReference} from "mdast" */
+import { ok as assert } from "devlop";
+
+/**
+ * Create an extension for `mdast-util-from-markdown` to enable GFM footnotes
+ * in markdown.
+ *
+ * @returns {FromMarkdownExtension}
+ *   Extension for `mdast-util-from-markdown`.
+ */
+export function blockIdFromMarkdown() {
+	return {
+		enter: {
+			blockId: enterBlockId,
+			blockIdString: enterBlockIdString,
+		},
+		exit: {
+			blockIdString: exitBlockIdString,
+			blockId: exitBlockId,
+		},
+	};
+}
+
+/**
+ * @this {CompileContext}
+ * @type {FromMarkdownHandle}
+ */
+function enterBlockId(token) {
+	this.enter({ type: "blockId", value: "" }, token);
+}
+
+/**
+ * @this {CompileContext}
+ * @type {FromMarkdownHandle}
+ */
+function enterBlockIdString(token) {
+	this.buffer();
+}
+
+/**
+ * @this {CompileContext}
+ * @type {FromMarkdownHandle}
+ */
+function exitBlockIdString(token) {
+	const id = this.resume();
+	const node = this.stack[this.stack.length - 1];
+	assert(node.type === "blockId", "expected blockId on top of stack");
+	node.value = id;
+}
+
+/**
+ * @this {CompileContext}
+ * @type {FromMarkdownHandle}
+ */
+function exitBlockId(token) {
+	this.exit(token);
+}

package/package.json

@@ -0,0 +1,37 @@
+{
+  "author": "James Jensen <jamesarthurjensen@gmail.com> (https://jajaperson.me)",
+  "name": "mdast-util-block-id",
+  "repository": "https://github.com/jajaperson/unified-block-id/tree/main/packages/mdast-util-block-id",
+  "type": "module",
+  "main": "index.js",
+  "version": "1.0.0",
+  "keywords": [
+    "remark",
+    "markdown",
+    "obsidian",
+    "ast",
+    "mdast"
+  ],
+  "license": "MIT",
+  "bugs": "https://github.com/jajaperson/unified-block-id/issues",
+  "contributors": [
+    "James Jensen <jamesarthurjensen@gmail.com> (https://jajaperson.me)"
+  ],
+  "files": [
+    "index.js",
+    "index.d.ts",
+    "lib"
+  ],
+  "dependencies": {
+    "@types/mdast": "^4.0.4",
+    "devlop": "^1.1.0"
+  },
+  "devDependencies": {
+    "mdast-util-from-markdown": "^2.0.3",
+    "micromark-extension-block-id": "1.0.0"
+  },
+  "scripts": {
+    "test": "node --conditions development test/index.js",
+    "write-fixtures": "node --conditions development test/write-fixtures.js"
+  }
+}