macana

Static site generator for Obsidian Vault

  1. 1
  2. 2
  3. 3
  4. 4
  5. 5
  6. 6
  7. 7
  8. 8
  9. 9
  10. 10
  11. 11
  12. 12
  13. 13
  14. 14
  15. 15
  16. 16
  17. 17
  18. 18
  19. 19
  20. 20
  21. 21
  22. 22
  23. 23
  24. 24
  25. 25
  26. 26
  27. 27
  28. 28
  29. 29
  30. 30
  31. 31
  32. 32
  33. 33
  34. 34
  35. 35
  36. 36
  37. 37
  38. 38
  39. 39
  40. 40
  41. 41
  42. 42
  43. 43
  44. 44
  45. 45
  46. 46
  47. 47
  48. 48
  49. 49
  50. 50
  51. 51
  52. 52
  53. 53
  54. 54
  55. 55
  56. 56
  57. 57
  58. 58
  59. 59
  60. 60
  61. 61
  62. 62
  63. 63
  64. 64
  65. 65
  66. 66
  67. 67
  68. 68
  69. 69
  70. 70
  71. 71
  72. 72
  73. 73
  74. 74
  75. 75
  76. 76
  77. 77
  78. 78
  79. 79
  80. 80
  81. 81
  82. 82
  83. 83
  84. 84
  85. 85
  86. 86
  87. 87
  88. 88
  89. 89
  90. 90
  91. 91
  92. 92
  93. 93
  94. 94
  95. 95
  96. 96
  97. 97
  98. 98
  99. 99
  100. 100
  101. 101
  102. 102
  103. 103
  104. 104
  105. 105
  106. 106
  107. 107
  108. 108
  109. 109
  110. 110
  111. 111
  112. 112
// SPDX-FileCopyrightText: 2024 Shota FUJI <pockawoooh@gmail.com>
//
// SPDX-License-Identifier: Apache-2.0

import type { Extension } from "../../deps/npm/mdast-util-from-markdown/mod.ts";
import type { State } from "../../deps/npm/mdast-util-to-hast/mod.ts";
import type * as Hast from "../../deps/npm/hast/types.ts";
import type * as Mdast from "../../deps/npm/mdast/types.ts";
import { visit } from "../../deps/npm/unist-util-visit/mod.ts";

export interface OfmBlockIdentifier extends Mdast.Node {
	type: "ofmBlockIdentifier";

	/**
	 * Identifier name. This does not include the leading caret.
	 */
	value: string;
}

function isOfmBlockIdentifier(node: Mdast.Node): node is OfmBlockIdentifier {
	return node.type === "ofmBlockIdentifier";
}

export interface OfmBlockIdentifierFromMarkdownOptions {
	/**
	 * Whether to set the ID to the parent node, instead of leaving
	 * "ofmBlockIdentifier" node.
	 */
	hoist?: boolean;
}

export function ofmBlockIdentifierFromMarkdown(
	{ hoist = false }: OfmBlockIdentifierFromMarkdownOptions = {},
): Extension {
	return {
		enter: {
			ofmBlockIdentifierIdentifier(token) {
				const ident = this.sliceSerialize(token);

				this.enter(
					{
						type: "ofmBlockIdentifier",
						value: ident,
						data: {
							hName: "span",
							hProperties: {
								id: ident,
							},
						},
					} satisfies OfmBlockIdentifier as unknown as Mdast.Nodes,
					token,
				);
			},
		},
		exit: {
			ofmBlockIdentifierIdentifier(token) {
				this.exit(token);
			},
		},
		transforms: hoist
			? [
				(nodes) => {
					visit(nodes, (node) =>
						isOfmBlockIdentifier(node), (node, index, parent) => {
						if (
							!isOfmBlockIdentifier(node) || typeof index !== "number" ||
							!parent
						) {
							return;
						}

						parent.data = {
							...parent.data,
							hProperties: {
								id: (node as OfmBlockIdentifier).value,
								...(parent.data && "hProperties" in parent.data &&
										parent.data.hProperties || {}),
							},
						};

						parent.children.splice(index, 1);
						return;
					});
				},
			]
			: [],
	};
}

export interface OfmBlockIdentifierToHastHandlersOptions {
	/**
	 * A function takes an identifier string and returns value for `id` attribute.
	 */
	id?(identifier: string): string;
}

export function ofmBlockIdentifierToHastHandlers(
	{ id }: OfmBlockIdentifierToHastHandlersOptions = {},
) {
	return {
		ofmBlockIdentifier(_state: State, node: OfmBlockIdentifier): Hast.Nodes {
			return {
				type: "element",
				tagName: "span",
				properties: {
					id: id ? id(node.value) : node.value,
				},
				children: [],
			};
		},
	};
}