render.test.ts

import { expect, it, describe } from "vitest";
import { md } from "../src";

const renderTests = {
  bold: [["Hello, World!", "**Hello, World!**"]],
  blockquote: [["Hello, World!", "> Hello, World!"]],
  boldAndItalic: [["Hello, World!", "***Hello, World!***"]],
  codeBlock: [
    [
      'console.log("Hello, World!");',
      '```\nconsole.log("Hello, World!");\n```',
    ],
    [
      'console.log("Hello, World!");',
      "js",
      { ext: '[name="index.js"]' },
      '```js [name="index.js"]\nconsole.log("Hello, World!");\n```',
    ],
    [
      'console.log("Hello, World!");',
      "js",
      '```js\nconsole.log("Hello, World!");\n```',
    ],
  ],
  strikethrough: [["Hello, World!", "~~Hello, World!~~"]],
  italic: [["Hello, World!", "_Hello, World!_"]],
  hr: [["---"], [5, "-----"]],
  image: [
    // Basic
    [
      "https://cataas.com/cat",
      "Cute Cat",
      "![Cute Cat](https://cataas.com/cat)",
    ],
    // With title
    [
      "https://cataas.com/cat",
      "Cute Cat",
      { title: "title" },
      '![Cute Cat](https://cataas.com/cat "title")',
    ],
    // No text
    ["https://cataas.com/cat", "![](https://cataas.com/cat)"],
    // No url
    ["", "Cute Cat", "![Cute Cat](#)"],
    ["", "", "![](#)"],
  ],
  heading: [
    ["Hello, World!", "\n# Hello, World!\n"],
    ["Hello, World!", 1, "\n# Hello, World!\n"],
    ["Hello, World!", 3, "\n### Hello, World!\n"],
  ],
  link: [
    // Basic
    [
      "https://www.example.com",
      "Example",
      "[Example](https://www.example.com)",
    ],
    // External
    [
      "https://www.example.com",
      "Example",
      { external: true, title: "title" },
      '<a href="https://www.example.com" title="title" target="_blank">Example</a>',
    ],
    // With title
    [
      "https://www.example.com",
      "Example",
      { title: "title" },
      '[Example](https://www.example.com "title")',
    ],
    // No text
    ["http://example.com", "[http://example.com](http://example.com)"],
    // No link
    ["", "Title", "[Title](#)"],
    ["", "", "[](#)"],
    // Relative path
    ["./src/markdown.md", "Markdown", "[Markdown](./src/markdown.md)"],
    // URL
    [
      new URL("https://www.example.com/"),
      "Example",
      "[Example](https://www.example.com/)",
    ],
  ],
  list: [
    [["Item 1", "Item 2"], "- Item 1\n- Item 2"],
    [["Item 1", "Item 2"], { ordered: true }, "1. Item 1\n2. Item 2"],
    [["Item 1", "Item 2"], { char: "- [ ]" }, "- [ ] Item 1\n- [ ] Item 2"],
  ],
} as Record<keyof typeof md, any[][]>;

describe("mdbox", () => {
  for (const [fn, tests] of Object.entries(renderTests)) {
    describe(fn, () => {
      for (const t of tests) {
        const output = t.pop();
        it(`${fn}(${t.map((i) => JSON.stringify(i)).join(", ")})`, () => {
          expect(md[fn](...t)).toBe(output);
        });
      }
    });
  }

  it("table", () => {
    expect(
      md.table({
        columns: ["Breed", "Origin", "Size", "Temperament"],
        rows: [
          ["Abyssinian", "Egypt", "Medium", "Active"],
          ["Aegean", "Greece", "Medium", "Active"],
          ["American Bobtail", "United States", "Medium", "Active"],
          ["Applehead Siamese", "Thailand", "Medium", "Active"],
        ],
      }),
    ).toMatchInlineSnapshot(`
      "| Breed | Origin | Size | Temperament |
      | --- | --- | --- | --- |
      | Abyssinian | Egypt | Medium | Active |
      | Aegean | Greece | Medium | Active |
      | American Bobtail | United States | Medium | Active |
      | Applehead Siamese | Thailand | Medium | Active |"
    `);
  });
});