Aggregate micromark extensions into one For usability. It's good abstraction IMO. Inclusion of gfm is actually valid, as OFM includes subset of GFM.

Changes

4 changed files (+66/-5)

• content_parser/obsidian_markdown.ts
  • @@ -7,14 +7,11 @@ import * as yamlFrontmatter from "../deps/deno.land/std/front_matter/yaml.ts";
    import type * as Mdast from "../deps/esm.sh/mdast/types.ts"; import { fromMarkdown } from "../deps/esm.sh/mdast-util-from-markdown/mod.ts"; import { gfmFromMarkdown } from "../deps/esm.sh/mdast-util-gfm/mod.ts"; - import { gfm } from "../deps/esm.sh/micromark-extension-gfm/mod.ts"; + import { ofm } from "./obsidian_markdown/micromark_extension_ofm.ts"; import { ofmHighlightFromMarkdown } from "./obsidian_markdown/mdast_util_ofm_highlight.ts"; - import { ofmHighlight } from "./obsidian_markdown/micromark_extension_ofm_highlight.ts"; import { ofmImageSize } from "./obsidian_markdown/mdast_util_ofm_image_size.ts"; - import { ofmWikilink } from "./obsidian_markdown/micromark_extension_ofm_wikilink.ts"; import { ofmWikilinkFromMarkdown } from "./obsidian_markdown/mdast_util_ofm_wikilink.ts"; - import { ofmComment } from "./obsidian_markdown/micromark_extension_ofm_comment.ts"; import { ofmCommentFromMarkdown } from "./obsidian_markdown/mdast_util_ofm_comment.ts"; import { macanaMarkAssets } from "./obsidian_markdown/mdast_util_macana_mark_assets.ts"; import { macanaMarkDocumentToken } from "./obsidian_markdown/mdast_util_macana_mark_document_token.ts";
  • @@ -104,7 +101,7 @@ "getAssetToken" | "getDocumentToken"
    >, ): Promise<Mdast.Root> { const mdast = fromMarkdown(markdown, { - extensions: [gfm(), ofmHighlight(), ofmWikilink(), ofmComment()], + extensions: [ofm()], mdastExtensions: [ ofmCommentFromMarkdown(), gfmFromMarkdown(),
• content_parser/obsidian_markdown/micromark_extension_ofm.ts (new)
  • @@ -0,0 +1,58 @@
    + // SPDX-FileCopyrightText: 2024 Shota FUJI <pockawoooh@gmail.com> + // + // SPDX-License-Identifier: Apache-2.0 + + import { + combineExtensions, + combineHtmlExtensions, + } from "../../deps/esm.sh/micromark-util-combine-extensions/mod.ts"; + import { + gfm, + gfmHtml, + type HtmlOptions, + } from "../../deps/esm.sh/micromark-extension-gfm/mod.ts"; + + import { + ofmComment, + ofmCommentHtml, + } from "./micromark_extension_ofm_comment.ts"; + import { + ofmWikilink, + ofmWikilinkHtml, + } from "./micromark_extension_ofm_wikilink.ts"; + import { + ofmHighlight, + ofmHighlightHtml, + } from "./micromark_extension_ofm_highlight.ts"; + + import type { + Extension, + HtmlExtension, + } from "../../deps/esm.sh/micromark-util-types/types.ts"; + + export function ofm(): Extension { + return combineExtensions([ + ofmComment(), + ofmWikilink(), + ofmHighlight(), + gfm(), + ]); + } + + export interface OfmHtmlOptions extends HtmlOptions { + /** + * Whether to preserve comments as HTML comments (`<!-- -->`). + */ + preserveComment?: boolean; + } + + export function ofmHtml( + { preserveComment = false, ...rest }: OfmHtmlOptions = {}, + ): HtmlExtension { + return combineHtmlExtensions([ + ofmCommentHtml({ preserveAsHtmlComment: preserveComment }), + ofmHighlightHtml(), + ofmWikilinkHtml(), + gfmHtml(rest), + ]); + }
• deno.lock
  • @@ -287,6 +287,7 @@ "https://esm.sh/v135/micromark-util-chunked@2.0.0": "6137fb50257da8a18125ac21ac885bd56f79e6ead241b0b004b0416c7906eaa2",
    "https://esm.sh/v135/micromark-util-chunked@2.0.0/denonext/micromark-util-chunked.mjs": "531cf323ba53649fdc30cd39ebba54253dfd847a4b23f806058ecc6cf67bca69", "https://esm.sh/v135/micromark-util-classify-character@2.0.0": "c92c93be5f8370abbd73783460c6e183f2b31fe74085175389e1c86d96aeef9b", "https://esm.sh/v135/micromark-util-classify-character@2.0.0/denonext/micromark-util-classify-character.mjs": "7e78c1341df2227c29cf5125c17f29bec3887bf8a3178476e129740271bdbd96", + "https://esm.sh/v135/micromark-util-combine-extensions@2.0.0": "c3546a7cc7de06b854d0e18531189576903384d8af607acce2c121b639dd5fa9", "https://esm.sh/v135/micromark-util-combine-extensions@2.0.0/denonext/micromark-util-combine-extensions.mjs": "68268c6cb6119bc8b0865156e81a360a3b94cd73bddbb9a2a33eda627e51573a", "https://esm.sh/v135/micromark-util-decode-numeric-character-reference@2.0.1/denonext/micromark-util-decode-numeric-character-reference.mjs": "284addb1c2303e02ca074d6a5e529c8c9c3cdb58b6815669e2ec65a2f717cf28", "https://esm.sh/v135/micromark-util-decode-string@2.0.0/denonext/micromark-util-decode-string.mjs": "c9abaf0b645a2ca8dd0a8d988a7a25173f4bc5e46154d2875890507c0d2e5a51",
• deps/esm.sh/micromark-util-combine-extensions/mod.ts (new)
  • @@ -0,0 +1,5 @@
    + // SPDX-FileCopyrightText: 2024 Shota FUJI <pockawoooh@gmail.com> + // + // SPDX-License-Identifier: Apache-2.0 + + export * from "https://esm.sh/v135/micromark-util-combine-extensions@2.0.0";