lezer-markdown-obsidian/__tests__/extensions.ts

import { compareTree } from "@lezer/markdown/test/compare-tree";
import { SpecParser } from "@lezer/markdown/test/spec";
import { parser } from "../src";

/*
  Copyright (C) 2020 by Marijn Haverbeke <marijnh@gmail.com> and others
  https://github.com/lezer-parser/markdown/blob/f49eb8c8c82cfe45aa213ca1fe2cebc95305b88b/LICENSE
*/
const specParser = new SpecParser(parser, {
  __proto__: null as any,
  T: "Task",
  t: "TaskMarker",
  /* End Copyright */
  C: "Comment",
  cm: "CommentMarker",
  EM: "Embed",
  eM: "EmbedMark",
  FN: "Footnote",
  fM: "FootnoteMark",
  fL: "FootnoteLabel",
  FR: "FootnoteReference",
  H: "Hashtag",
  hm: "HashtagMark",
  hl: "HashtagLabel",
  IL: "InternalLink",
  iM: "InternalMark",
  iP: "InternalPath",
  iS: "InternalSubpath",
  iD: "InternalDisplay",
  M: "Mark",
  mm: "MarkMarker",
  XB: "TexBlock",
  XI: "TexInline",
  xm: "TexMarker",
  YF: "YAMLFrontMatter",
  ym: "YAMLMarker",
  yc: "YAMLContent",
});

/*
  Copyright (C) 2020 by Marijn Haverbeke <marijnh@gmail.com> and others
  https://github.com/lezer-parser/markdown/blob/f49eb8c8c82cfe45aa213ca1fe2cebc95305b88b/LICENSE
*/
function test(name: string, spec: string, p = parser, only = false) {
  let f = it;
  if (only) {
    f = it.only;
  }
  f(name, () => {
    const { tree, doc } = specParser.parse(spec, name);
    compareTree(p.parse(doc), tree);
  });
}
/* End Copyright */

describe("Obsidian Extension", () => {
  test(
    "Comment (End Leaf)",
    `
{P:plaintext}
{C:{cm:%%}comment
- still comment
> and still comment
{cm:%%}}
    `
  );

  test(
    "Comment (Tailing Text)",
    `
{C:{cm:%%}comment{cm:%%}} {P:plaintext}
    `
  );

  test(
    "Comment (Unterminated)",
    `
{C:{cm:%%}comment

# this is never terminated
    }`
  );

  test(
    "Comment Inline (1)",
    `
{P:plaintext {C:{cm:%%}comment{cm:%%}} more plaintext}

{P:plaintext %%not a comment
more %% plaintext}
    `
  );

  test(
    "Footnotes",
    `
{P:Some info{FN:{fM:[^}{fL:1}{fM:]}}}

{P:Some more info{FN:{fM:[^}{fL:a$wacky^foot-note}{fM:]}}}
  `
  );

  test(
    "Footnote Reference (Simple)",
    `
{FR:{fM:[^}{fL:1}{fM:]:} Some basic info}
{FR:{fM:[^}{fL:2}{fM:]:} Some {St:{e:**}bold{e:**}} info}
  `
  );

  test(
    "Footnote Reference (Multiline)",
    `
{FR:{fM:[^}{fL:1}{fM:]:} Line 1
Line 2}
{FR:{fM:[^}{fL:2}{fM:]:} Line 3
Line 4
Line 5}
  `
  );

  test(
    "Footnote Reference (Interspersed with Bullets)",
    `
{FR:{fM:[^}{fL:1}{fM:]:} Line 1}
{BL:{LI:{l:-} {P:Line 2
{FN:{fM:[^}{fL:2}{fM:]}}: Line 3}}}

{FR:{fM:[^}{fL:2}{fM:]:} Line 5}
{BL:{LI:{l:-} {P:Line 6}}}
  `
  );

  test(
    "Hashtag",
    `
{P:Some text. {H:{hm:#}{hl:tag}} {H:{hm:#}{hl:other-tag9}}^not part
{H:{hm:#}{hl:ñáø√}}}

{P:Test number #1234}
  `
  );

  test(
    "Internal Link (bare link)",
    `
{P:before {IL:{iM:[[}{iP:Some File}{iM:]]}} after}
  `
  );

  test(
    "Internal Link (heading link)",
    `
{P:{IL:{iM:[[}{iP:Some File}{iS:#heading}{iM:]]}}}
  `
  );

  test(
    "Internal Link (block heading link)",
    `
{P:{IL:{iM:[[}{iP:Some File}{iS:#^blockid}{iM:]]}}}
  `
  );

  test(
    "Internal Link (display text)",
    `
{P:{IL:{iM:[[}{iP:Some File}{iM:|}{iD:something else}{iM:]]}}}
  `
  );

  test(
    "Internal Link (heading and display text)",
    `
{P:{IL:{iM:[[}{iP:Some File}{iS:#heading}{iM:|}{iD:something else}{iM:]]}}}
  `
  );

  test(
    "Internal Embed (file)",
    `
{P:{EM:{eM:!}{IL:{iM:[[}{iP:moon.jpg}{iM:]]}}}}
  `
  );

  test(
    "Internal Embed (file)",
    `
{P:{EM:{eM:!}{IL:{iM:[[}{iP:markdown file}{iS:#a heading}{iM:]]}}}}
  `
  );

  /*
  Copyright (C) 2020 by Marijn Haverbeke <marijnh@gmail.com> and others
  https://github.com/lezer-parser/markdown/blob/f49eb8c8c82cfe45aa213ca1fe2cebc95305b88b/LICENSE
*/
  test(
    "Mark",
    `
{P:{M:{mm:==}Hi{mm:==}} Hello, world!}`
  );

  test(
    "Mark 2",
    `
{P:This ==has a}

{P:new paragraph==.}`
  );

  test(
    "Mark (nested)",
    `
{P:Nesting {St:{e:**}with {M:{mm:==}emphasis{mm:==}}{e:**}}.}`
  );

  test(
    "Mark (overlapping)",
    `
{P:One {St:{e:**}two ==three{e:**}} four==}

{P:One {M:{mm:==}two **three{mm:==}} four**}`
  );

  test(
    "Mark (escaped)",
    `
{P:A {Esc:\\=}=b c==}`
  );

  test(
    "Task list (in unordered list)",
    `
{BL:{LI:{l:-} {T:{t:[ ]} foo}}
{LI:{l:-} {T:{t:[x]} bar}}}`
  );

  test(
    "Task list (in nested list)",
    `
{BL:{LI:{l:-} {T:{t:[x]} foo}
  {BL:{LI:{l:-} {T:{t:[ ]} bar}}
  {LI:{l:-} {T:{t:[x]} baz}}}}
{LI:{l:-} {T:{t:[ ]} bim}}}`
  );

  test(
    "Task list (in ordered list)",
    `
{OL:{LI:{l:1.} {T:{t:[X]} Okay}}}`
  );

  test(
    "Task list (versus setext header)",
    `
{OL:{LI:{l:1.} {SH1:{Ln:{L:[}X{L:]}} foo
   {h:===}}}}`
  );
  /* End Copyright */
  test(
    "Task list (different markers)",
    `
{BL:{LI:{l:-} {T:{t:[a]} foo}}
{LI:{l:-} {T:{t:[[]} bar}}
{LI:{l:-} {T:{t:[]]} baz}}
{LI:{l:-} {T:{t:[\\]} bim}}}
    `
  );

  test(
    "Tex Block (End Leaf)",
    `
{P:plaintext}
{XB:{xm:$$}tex content
- still tex
> and still tex
{xm:$$}}
    `
  );

  test(
    "Tex Block (Tailing Text)",
    `
{XB:{xm:$$}tex content{xm:$$}} {P:plaintext}
    `
  );

  test(
    "Tex Block (Unterminated)",
    `
{XB:{xm:$$}tex content

# this is never terminated
    }`
  );

  test(
    "Tex Inline (1)",
    `
{P:plaintext {XI:{xm:$}tex content{xm:$}} more plaintext}

{P:plaintext {XI:{xm:$}tex content{xm:$}}more plaintext}

{P:{XI:{xm:$}1.234{xm:$}}}
    `
  );

  test(
    "Tex Inline (2)",
    `
{P:$not tex$1.234}

{P:$also not tex $}

{P:$ still not tex$}

{P:{XI:{xm:$}actually tex
{xm:$}}}

{P:{XI:{xm:$}tex
more text
{xm:$}}}
    `
  );

  test(
    "YAMLFrontMatter",
    `
{YF:{ym:---}
{yc:tags: blah}
{ym:---}}

{HR:---}

{P:some text}

{SH2:A header
{h:---}}
  `
  );

  test(
    "YAMLFrontMatter (trailing text)",
    `
{YF:{ym:---}
{yc:tags: blah}
{ym:---}}{P:test}

{HR:---}

{P:some text}

{SH2:A header
{h:---}}
  `
  );

  test(
    "Not YAMLFrontMatter (no close)",
    `
{HR:---}

{P:some text}

{SH1:A header
{h:===}}
  `
  );

  test(
    "Not YAMLFrontMatter (close indented)",
    `
{HR:---}

{P:some text}

 {HR:---}
  `
  );

  test(
    "Not YAMLFrontMatter (space after open)",
    `
{HR:--- }

{P:some text}

{HR:---}
  `
  );

  test(
    "Not YAMLFrontMatter (data before open)",
    `
{P:some text}

{HR:---}

{P:some text}

{HR:---}
  `
  );
});