npm - extramark - Versions diffs - 2.1.0 → 3.0.0 - Mend

extramark 2.1.0 → 3.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (6) hide show

package/bin/extramark.js CHANGED Viewed

@@ -41,8 +41,8 @@ try {
   data.parsed = html`
     <!DOCTYPE html>
     <meta charset="utf-8" />
-    <title>${program.title || `Markdown document`}</title>
-    ${program.css ? `<link rel="stylesheet" href="${program.css}">` : ``} ${await render(data.raw)}
+    <title>${options.title || `Markdown document`}</title>
+    ${options.css ? `<link rel="stylesheet" href="${options.css}">` : ``} ${await render(data.raw)}
   `;
 } catch {
   error(`${styleText("red", "!")} Could not parse input data.`);

package/bin/extramark.test.js ADDED Viewed

@@ -0,0 +1,93 @@
+import { strict as assert } from "node:assert";
+import { readFile, writeFile } from "node:fs/promises";
+import { join } from "node:path";
+import { describe, it } from "node:test";
+import { createCliRunner } from "../test/cli-runner.js";
+import { setupTempDir, writeInputFile } from "../test/temp-dir.js";
+const cliPath = new URL("./extramark.js", import.meta.url).pathname;
+const runCli = createCliRunner(cliPath);
+const getTempDir = setupTempDir();
+describe("extramark CLI", () => {
+  it("renders Markdown to HTML with no options", async () => {
+    const inputFile = await writeInputFile(getTempDir(), "# Heading");
+    const result = await runCli([inputFile]);
+    assert.equal(result.exitCode, 0);
+    assert.ok(result.stdout.includes("<title>Markdown document</title>"));
+    assert.match(result.stdout, /<h1[^>]*>Heading<\/h1>/);
+  });
+  it("fails with a clear error and exit 1 on a nonexistent input file", async () => {
+    const inputFile = join(getTempDir(), "does-not-exist.md");
+    const result = await runCli([inputFile]);
+    assert.equal(result.exitCode, 1);
+    assert.ok(result.stderr.includes(`Could not read input file '${inputFile}'`));
+  });
+  it("uses the --title option for the output document's title", async () => {
+    const inputFile = await writeInputFile(getTempDir(), "# Heading");
+    const result = await runCli([inputFile, "--title", "My Title"]);
+    assert.ok(result.stdout.includes("<title>My Title</title>"));
+  });
+  it("uses the --css option to link a stylesheet in the output document", async () => {
+    const inputFile = await writeInputFile(getTempDir(), "# Heading");
+    const result = await runCli([inputFile, "--css", "style.css"]);
+    assert.ok(result.stdout.includes('<link rel="stylesheet" href="style.css">'));
+  });
+  it("writes the rendered output to disk with -o, creating missing parent directories", async () => {
+    const dir = getTempDir();
+    const inputFile = await writeInputFile(dir, "# Heading");
+    const outputFile = join(dir, "nested", "output.html");
+    const result = await runCli([inputFile, "-o", outputFile]);
+    assert.equal(result.exitCode, 0);
+    const written = await readFile(outputFile, "utf-8");
+    assert.match(written, /<h1[^>]*>Heading<\/h1>/);
+  });
+  it("logs a confirmation after writing with -o by default", async () => {
+    const dir = getTempDir();
+    const inputFile = await writeInputFile(dir, "# Heading");
+    const outputFile = join(dir, "output.html");
+    const result = await runCli([inputFile, "-o", outputFile]);
+    assert.ok(result.stdout.includes(`Created: ${outputFile}`));
+  });
+  it("suppresses the confirmation with -o and --quiet", async () => {
+    const dir = getTempDir();
+    const inputFile = await writeInputFile(dir, "# Heading");
+    const outputFile = join(dir, "output.html");
+    const result = await runCli([inputFile, "-o", outputFile, "-q"]);
+    assert.ok(!result.stdout.includes("Created:"));
+  });
+  it("fails with a clear error and exit 1 when -o's directory is blocked by an existing file", async () => {
+    const dir = getTempDir();
+    const blockerFile = join(dir, "blocker");
+    await writeFile(blockerFile, "");
+    const inputFile = await writeInputFile(dir, "# Heading");
+    const outputFile = join(blockerFile, "output.html");
+    const result = await runCli([inputFile, "-o", outputFile]);
+    assert.equal(result.exitCode, 1);
+    assert.ok(result.stderr.includes(`Could not write output file '${outputFile}'`));
+  });
+});

package/lib/index.js CHANGED Viewed

@@ -2,13 +2,12 @@ import MarkdownIt from "markdown-it";
 import abbr from "markdown-it-abbr";
 import anchor from "markdown-it-anchor";
+import critic from "markdown-it-critic";
 import deflist from "markdown-it-deflist";
 import footnote from "markdown-it-footnote";
 import sub from "markdown-it-sub";
 import sup from "markdown-it-sup";
-import critic from "./critic.js";
 const parser = new MarkdownIt("commonmark");
 parser.set({ typographer: true });

package/lib/index.test.js ADDED Viewed

@@ -0,0 +1,176 @@
+import { strict as assert } from "node:assert";
+import { describe, it } from "node:test";
+import { parse, render } from "./index.js";
+function inlineChildTypes(tokens) {
+  const inline = tokens.find((token) => token.type === "inline");
+  return inline.children.map((child) => child.type);
+}
+function topLevelTypes(tokens) {
+  return tokens.map((token) => token.type);
+}
+describe("extramark", () => {
+  describe("markdown-it-critic", () => {
+    it("renders CriticMarkup additions as <ins>", () => {
+      const input = "Lorem {++added++} dolor.";
+      const expectedOutput = "<p>Lorem <ins>added</ins> dolor.</p>\n";
+      assert.equal(render(input), expectedOutput);
+    });
+    it("parses CriticMarkup additions as first-class tokens", () => {
+      const input = "Lorem {++added++} dolor.";
+      const childTypes = inlineChildTypes(parse(input, {}));
+      assert.ok(childTypes.includes("critic_ins_open"));
+    });
+  });
+  describe("markdown-it-abbr", () => {
+    it("renders abbreviations as <abbr>", () => {
+      const input = "*[HTML]: HyperText Markup Language\n\nHTML is great.";
+      const expectedOutput =
+        '<p><abbr title="HyperText Markup Language">HTML</abbr> is great.</p>\n';
+      assert.equal(render(input), expectedOutput);
+    });
+    it("parses abbreviations as first-class tokens", () => {
+      const input = "*[HTML]: HyperText Markup Language\n\nHTML is great.";
+      const childTypes = inlineChildTypes(parse(input, {}));
+      assert.ok(childTypes.includes("abbr_open"));
+    });
+  });
+  describe("markdown-it-anchor", () => {
+    it("renders heading anchors with an id", () => {
+      const input = "# My Heading";
+      const expectedOutput = '<h1 id="my-heading" tabindex="-1">My Heading</h1>\n';
+      assert.equal(render(input), expectedOutput);
+    });
+    it("parses headings with an id attribute", () => {
+      const input = "# My Heading";
+      const tokens = parse(input, {});
+      const heading = tokens.find((token) => token.type === "heading_open");
+      assert.equal(heading.attrGet("id"), "my-heading");
+    });
+  });
+  describe("markdown-it-deflist", () => {
+    it("renders definition lists as <dl>", () => {
+      const input = "Term\n: Definition";
+      const expectedOutput = "<dl>\n<dt>Term</dt>\n<dd>Definition</dd>\n</dl>\n";
+      assert.equal(render(input), expectedOutput);
+    });
+    it("parses definition lists as first-class tokens", () => {
+      const input = "Term\n: Definition";
+      const types = topLevelTypes(parse(input, {}));
+      assert.ok(types.includes("dl_open"));
+    });
+  });
+  describe("markdown-it-footnote", () => {
+    it("renders footnotes with backrefs", () => {
+      const input = "Note.[^1]\n\n[^1]: Footnote text.";
+      const output = render(input);
+      assert.ok(output.includes('class="footnote-ref"'));
+      assert.ok(output.includes('class="footnote-item"'));
+    });
+    it("parses footnote references as first-class tokens", () => {
+      const input = "Note.[^1]\n\n[^1]: Footnote text.";
+      const childTypes = inlineChildTypes(parse(input, {}));
+      assert.ok(childTypes.includes("footnote_ref"));
+    });
+  });
+  describe("markdown-it-sub", () => {
+    it("renders subscript as <sub>", () => {
+      const input = "H~2~O";
+      const expectedOutput = "<p>H<sub>2</sub>O</p>\n";
+      assert.equal(render(input), expectedOutput);
+    });
+    it("parses subscript as first-class tokens", () => {
+      const input = "H~2~O";
+      const childTypes = inlineChildTypes(parse(input, {}));
+      assert.ok(childTypes.includes("sub_open"));
+    });
+  });
+  describe("markdown-it-sup", () => {
+    it("renders superscript as <sup>", () => {
+      const input = "29^th^";
+      const expectedOutput = "<p>29<sup>th</sup></p>\n";
+      assert.equal(render(input), expectedOutput);
+    });
+    it("parses superscript as first-class tokens", () => {
+      const input = "29^th^";
+      const childTypes = inlineChildTypes(parse(input, {}));
+      assert.ok(childTypes.includes("sup_open"));
+    });
+  });
+  describe("typographic replacements", () => {
+    it("renders (c)/--/... in their typographic form", () => {
+      const input = "(c) 2024";
+      const expectedOutput = "<p>© 2024</p>\n";
+      assert.equal(render(input), expectedOutput);
+    });
+    it("parses replacements into the text token's content", () => {
+      const input = "(c) 2024";
+      const tokens = parse(input, {});
+      const inline = tokens.find((token) => token.type === "inline");
+      const text = inline.children.find((child) => child.type === "text");
+      assert.equal(text.content, "© 2024");
+    });
+  });
+  describe("table syntax", () => {
+    it("renders tables as <table>", () => {
+      const input = "| a |\n| - |\n| 1 |";
+      const expectedOutput =
+        "<table>\n<thead>\n<tr>\n<th>a</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>1</td>\n" +
+        "</tr>\n</tbody>\n</table>\n";
+      assert.equal(render(input), expectedOutput);
+    });
+    it("parses tables as first-class tokens", () => {
+      const input = "| a |\n| - |\n| 1 |";
+      const types = topLevelTypes(parse(input, {}));
+      assert.ok(types.includes("table_open"));
+    });
+  });
+});

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "extramark",
-  "version": "2.1.0",
+  "version": "3.0.0",
   "description": "CommonMark superset with widely used syntax extensions",
   "author": "Márton Visnovitz <vimtaai@pm.me>",
   "license": "MIT",
@@ -12,18 +12,20 @@
     "{lib,bin}/**/*.js"
   ],
   "scripts": {
+    "test": "node --test",
+    "test:watch": "node --watch --test",
     "check": "biome check",
     "check:ci": "biome ci",
     "check:fix": "biome check --write"
   },
   "dependencies": {
-    "commander": "^14.0.3",
+    "commander": "^15.0.0",
     "common-tags": "^1.8.2",
-    "critic-markup": "^2.0.1",
-    "markdown-it": "^14.1.0",
+    "markdown-it": "^15.0.2",
+    "markdown-it-critic": "^1.0.1",
     "markdown-it-abbr": "^2.0.0",
-    "markdown-it-anchor": "^9.2.0",
-    "markdown-it-deflist": "^3.0.0",
+    "markdown-it-anchor": "^10.0.0",
+    "markdown-it-deflist": "^4.0.0",
     "markdown-it-footnote": "^4.0.0",
     "markdown-it-sub": "^2.0.0",
     "markdown-it-sup": "^2.0.0"

package/lib/critic.js DELETED Viewed

@@ -1,11 +0,0 @@
-import { render } from "critic-markup";
-function criticMarkupRule(state) {
-  state.src = render(state.src);
-}
-function markdownItCriticMarkup(md) {
-  md.core.ruler.before("block", "critic-markup", criticMarkupRule);
-}
-export default markdownItCriticMarkup;