micromark-extension-block-id 1.0.0

package/README.md

@@ -0,0 +1,67 @@
+# micromark-extension-gfm-strikethrough
+
+Syntax-only [micromark][] extension
+for parsing [Obsidian][]-style inline footnotes.
+
+```md
+Sentence.^[Footnote]
+```
+
+Note this extension does not extend the html compiler.
+Instead, this is intended to be used together with [mdast-util-block-id][]
+which includes a utility for converting inline footnotes to GFM footnote reference/definition pairs.
+
+## Install
+
+This package is [ESM only][esm].
+In Node.js (version 16+), install with [npm][]:
+
+```sh
+npm install micromark-extension-block-id
+```
+
+In Deno with [`esm.sh`][esmsh]:
+
+```js
+import { blockId } from "https://esm.sh/micromark-extension-block-id@1";
+```
+
+In browsers with [`esm.sh`][esmsh]:
+
+```html
+<script type="module">
+	import { blockId } from "https://esm.sh/micromark-extension-block-id@1?bundle";
+</script>
+```
+
+## API
+
+This package exports the identifier [`blockId`][api-block-id].
+There is no default export.
+
+The export map supports the [`development` condition][development].
+Run `node --conditions development module.js` to get instrumented dev code.
+Without this condition, production code is loaded.
+
+### `blockId()`
+
+Create an extension for `micromark` to enable block id syntax.
+
+###### Returns
+
+Extension for `micromark` that can be passed in `extensions`,
+to enable block ids ([`Extension`][micromark-extension]).
+
+## Security
+
+This package is safe.
+
+[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
+[development]: https://nodejs.org/api/packages.html#packages_resolving_user_conditions
+[api-block-id]: #blockid
+[npm]: https://docs.npmjs.com/cli/install
+[Obsidian]: https://obsidian.md

package/index.d.ts

@@ -0,0 +1,15 @@
+export { blockId } from "./lib/index.js";
+
+/**
+ * Augment.
+ */
+declare module "micromark-util-types" {
+	/**
+	 * Token types.
+	 */
+	interface TokenTypeMap {
+		blockId: "blockId";
+		blockIdMarker: "blockIdMarker";
+		blockIdString: "blockIdString";
+	}
+}

package/index.js

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

package/lib/index.js

@@ -0,0 +1,91 @@
+/**
+ * @import {Extension, TokenizeContext, Tokenizer, State, Construct} from "micromark-util-types"
+ */
+
+import { ok as assert } from "devlop";
+import { codes } from "micromark-util-symbol";
+import {
+	asciiAlphanumeric,
+	markdownLineEnding,
+	markdownLineEndingOrSpace,
+} from "micromark-util-character";
+
+/**
+ * Creates an extension for `micromark` to enable Obsidian-style block id syntax
+ *
+ * @returns {Extension}
+ *   Extension for the `micromark` package that can be passed in `extensions` to enable
+ *   Obsidian-style block id syntax.
+ */
+export function blockId() {
+	/** @type {Construct} */
+	const construct = {
+		name: "blockId",
+		tokenize: blockIdTokenize,
+	};
+
+	return {
+		text: {
+			[codes.caret]: construct,
+		},
+		flow: {
+			[codes.caret]: construct,
+		},
+	};
+}
+
+/**
+ * @this {TokenizeContext}
+ * @type {Tokenizer}
+ */
+function blockIdTokenize(effects, ok, nok) {
+	let empty = true;
+	return start;
+
+	/**
+	 * Start of block id
+	 *
+	 * ```markdown
+	 * > | a ^b
+	 *       ^
+	 * ```
+	 *
+	 * @type {State}
+	 */
+	function start(code) {
+		assert(code === codes.caret, "expected `^`");
+		effects.enter("blockId");
+		effects.enter("blockIdMarker");
+		effects.consume(code);
+		effects.exit("blockIdMarker");
+		effects.enter("blockIdString");
+		effects.enter("chunkString", { contentType: "string" });
+
+		return id;
+	}
+
+	/**
+	 * After `^` at word character
+	 *
+	 * ```markdown
+	 * > | a ^b
+	 *        ^
+	 * ```
+	 *
+	 * @type {State}
+	 */
+	function id(code) {
+		if (asciiAlphanumeric(code) || code === codes.dash) {
+			effects.consume(code);
+			empty = false;
+			return id;
+		} else if (!empty && (markdownLineEnding(code) || code === null)) {
+			effects.exit("chunkString");
+			effects.exit("blockIdString");
+			effects.exit("blockId");
+			return ok(code);
+		} else {
+			return nok(code);
+		}
+	}
+}

package/package.json

@@ -0,0 +1,30 @@
+{
+  "author": "James Jensen <jamesarthurjensen@gmail.com> (https://jajaperson.me)",
+  "name": "micromark-extension-block-id",
+  "repository": "https://github.com/jajaperson/unified-block-id/tree/main/packages/micromark-extension-block-id",
+  "type": "module",
+  "main": "index.js",
+  "version": "1.0.0",
+  "keywords": [
+    "remark",
+    "markdown",
+    "obsidian",
+    "micromark"
+  ],
+  "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": {
+    "devlop": "^1.1.0",
+    "micromark-util-symbol": "^2.0.1",
+    "micromark-util-types": "^2.0.2",
+    "micromark-util-character": "^2.1.1"
+  }
+}