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

extramark 2.0.3 → 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 (8) hide show

package/LICENSE.md CHANGED Viewed

@@ -1,6 +1,6 @@
 MIT License
-Copyright (c) 2018-2025 Márton Visnovitz
+Copyright (c) 2018-2026 Márton Visnovitz
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

package/README.md CHANGED Viewed

@@ -1,16 +1,12 @@
 # ExtraMark
-[![License][badge-license]][link-license]
-[![Version][badge-version]][link-version]
+[![License][license-badge]][license-link]
+[![Version][version-badge]][version-link]
+[![Build][build-badge]][build-link]
-[badge-license]: https://img.shields.io/npm/l/extramark.svg
-[link-license]: https://github.com/vimtaai/extramark/blob/master/LICENSE.md
-[badge-version]: https://img.shields.io/npm/v/extramark.svg
-[link-version]: https://npmjs.com/package/extramark
+Superset of [CommonMark](https://commonmark.org/) that includes syntax extensions that are commonly used by other Markdown dialects. The list and syntax for the extensions are decided by looking at the most popular Markdown dialects and selecting the most common syntax for each feature. The goal of the project is to create a (somewhat) standard superset of CommonMark that supports the features that are requested by most. The parser is based on [markdown-it](https://github.com/markdown-it/markdown-it) and uses plugins for syntax extensions.
-**ExtraMark** is a superset of [CommonMark](https://commonmark.org/) that includes syntax extensions that are commonly used by other Markdown dialects. The list and syntax for the extensions are decided by looking at the most popular Markdown dialects and selecting the most common syntax for each feature. The goal of the project is to create a (somewhat) standard superset of CommonMark that supports the features that are requested by most. The parser is based on [markdown-it](https://github.com/markdown-it/markdown-it) and uses plugins for syntax extensions.
-## Installation
+## Setup
 Install via `npm`:
@@ -85,4 +81,11 @@ extramark --help
 ## Contributing
-All ideas, recommendations, bug reports, pull requests are welcome. 🙂
+All ideas, recommendations, bug reports, pull requests are welcome. 😊
+[license-badge]: https://img.shields.io/npm/l/extramark.svg
+[license-link]: https://github.com/vimtaai/extramark/blob/master/LICENSE.md
+[version-badge]: https://img.shields.io/npm/v/extramark.svg
+[version-link]: https://npmjs.com/package/extramark
+[build-badge]: https://github.com/vimtaai/extramark/actions/workflows/main.yaml/badge.svg
+[build-link]: https://github.com/vimtaai/extramark/actions/workflows/main.yaml

package/bin/extramark.js CHANGED Viewed

@@ -9,11 +9,11 @@ import { styleText } from "node:util";
 import { program } from "commander";
 import { html } from "common-tags";
-import { render } from "../src/index.js";
+import { render } from "../lib/index.js";
 program
   .description("CLI for converting Markdown documents to HTML with ExtraMark")
-  .usage("<input> [options]")
+  .argument("<input>", "path of the input .md file")
   .option("-o --output [path]", "path of the output .html file")
   .option("-c --css [css]", "path to the CSS file to use for formatting")
   .option("-t --title [title]", "title of the output document")
@@ -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.`);
@@ -54,7 +54,7 @@ try {
     await mkdir(dirname(outputFile), { recursive: true });
     await writeFile(outputFile, data.parsed);
   } else {
-    stdout.write(data.parsed + "\n");
+    stdout.write(`${data.parsed}\n`);
   }
   if (outputFile && !options.quiet) {

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/{src → lib}/index.js RENAMED Viewed

@@ -1,13 +1,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 sup from "markdown-it-sup";
-import sub from "markdown-it-sub";
-import abbr from "markdown-it-abbr";
 import footnote from "markdown-it-footnote";
-import critic from "./critic.js";
+import sub from "markdown-it-sub";
+import sup from "markdown-it-sup";
 const parser = new MarkdownIt("commonmark");

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,40 +1,36 @@
 {
   "name": "extramark",
-  "version": "2.0.3",
-  "description": "CommonMark superset with the most widely used syntax extensions",
-  "author": "Márton Visnovitz <visnovitz.marton@gmail.com>",
+  "version": "3.0.0",
+  "description": "CommonMark superset with widely used syntax extensions",
+  "author": "Márton Visnovitz <vimtaai@pm.me>",
   "license": "MIT",
   "repository": "github:vimtaai/extramark",
   "type": "module",
-  "main": "src/index.js",
+  "main": "lib/index.js",
   "bin": "bin/extramark.js",
   "files": [
-    "src/**/*.js",
-    "bin/**/*.js"
+    "{lib,bin}/**/*.js"
   ],
   "scripts": {
-    "lint": "eslint '{src,bin}/**/*.js'",
-    "format": "prettier --check '{src,bin}/**/*.js'",
-    "release": "semantic-release"
+    "test": "node --test",
+    "test:watch": "node --watch --test",
+    "check": "biome check",
+    "check:ci": "biome ci",
+    "check:fix": "biome check --write"
   },
   "dependencies": {
-    "commander": "^12.1.0",
+    "commander": "^15.0.0",
     "common-tags": "^1.8.2",
-    "critic-markup": "^2.0.0",
-    "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"
   },
   "devDependencies": {
-    "@eslint/js": "^9.17.0",
-    "@semantic-release/changelog": "^6.0.3",
-    "@semantic-release/git": "^10.0.1",
-    "eslint": "^9.17.0",
-    "prettier": "^3.4.2",
-    "semantic-release": "^24.2.2"
+    "@biomejs/biome": "^2.4.2"
   }
 }

package/src/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;