extramark 0.3.2 → 2.0.0

package/LICENSE.md

@@ -1,9 +1,9 @@
-MIT License
-
-Copyright (c) 2018-2019 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:
-
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+MIT License
+
+Copyright (c) 2018-2025 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:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -1,96 +1,88 @@
-# ExtraMark
-
-[![Version][badge-version]](https://npmjs.com/package/extramark)
-[![License][badge-license]](https://github.com/vimtaai/extramark/blob/master/LICENSE.md)
-[![Code style][badge-style]](https://github.com/prettier/prettier)
-
-> CommonMark superset with the most widely used 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
-
-Install via `npm`:
-
-```bash
-npm install extramark
-```
-
-Load from a CDN:
-
-```html
-<script src="https://cdn.jsdelivr.net/npm/extramark"></script>
-```
-
-## Usage
-
-The `extramark` package exposes two functions, `parse()` and `render()`. The `parse()` function creates an abstract syntax tree from the input while the `render()` function returns the generated HTML code (see [markdown-it](https://github.com/markdown-it/markdown-it)).
-
-```js
-const { parse, render } = require("extramark");
-
-parse("# Heading");
-// [Object] - AST of the Markdown code
-
-render("# Heading");
-// <h1>Heading</h1>
-```
-
-In a browser environment you can access the `parse()` and `render()` functions via the `ExtraMark` global object.
-
-```js
-const { parse, render } = ExtraMark;
-```
-
-### CLI
-
-To transform documents in the command line you have to install the `extramark` package globally.
-
-```bash
-npm install -g extramark
-```
-
-After the installation the `extramark` command becomes available. The command can be used to transform the input text (file or `stdin`) to HTML (file or `stdout`).
-
-```bash
-extramark input.md -o output.html -c style.css
-```
-
-To see all options of the `extramark` see it's help:
-
-```bash
-extramark --help
-```
-
-### Features
-
-- Defined clearly as a superset of CommonMark
-- Syntax extensions
-  - [Automatic typographic replacements][typographer]
-  - [Tables][table]
-  - [Anchors for headings][anchor] (up to heading level 3)
-  - [Definition lists][deflist]
-  - [Superscript][superscript]
-  - [Subscript][subscript]
-  - [Abbreviations][abbreviation]
-  - [Footnotes][footnote]
-  - [Critic Markup][critic-markup]
-- Integrated CLI tool for command-line conversion to HTML
-
-[typographer]: https://github.com/markdown-it/markdown-it/blob/master/lib/rules_core/replacements.js
-[table]: https://help.github.com/articles/organizing-information-with-tables/
-[anchor]: https://github.com/valeriangalliat/markdown-it-anchor
-[deflist]: https://github.com/markdown-it/markdown-it-deflist
-[superscript]: https://github.com/markdown-it/markdown-it-sup
-[subscript]: https://github.com/markdown-it/markdown-it-sub
-[abbreviation]: https://github.com/markdown-it/markdown-it-abbr
-[footnote]: https://github.com/markdown-it/markdown-it-footnote
-[critic-markup]: http://criticmarkup.com/
-
-## Contributing
-
-All ideas, recommendations, bug reports, pull requests are welcome. :smile:
-
-[badge-version]: https://img.shields.io/npm/v/extramark.svg?style=flat-square
-[badge-license]: https://img.shields.io/npm/l/extramark.svg?style=flat-square
-[badge-style]: https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square
+# ExtraMark
+
+[![License][badge-license]][link-license]
+[![Version][badge-version]][link-version]
+
+[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
+
+**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
+
+Install via `npm`:
+
+```bash
+npm install extramark
+```
+
+## Usage
+
+The `extramark` package exposes two functions, `parse()` and `render()`. The `parse()` function creates an abstract syntax tree from the input while the `render()` function returns the generated HTML code (see [markdown-it](https://github.com/markdown-it/markdown-it)).
+
+```js
+const { parse, render } = require("extramark");
+
+parse("# Heading");
+// [Object] - AST of the Markdown code
+
+render("# Heading");
+// <h1>Heading</h1>
+```
+
+In a browser environment you can access the `parse()` and `render()` functions via the `ExtraMark` global object.
+
+```js
+const { parse, render } = ExtraMark;
+```
+
+### CLI
+
+To transform documents in the command line you have to install the `extramark` package globally.
+
+```bash
+npm install -g extramark
+```
+
+After the installation the `extramark` command becomes available. The command can be used to transform the input text (file or `stdin`) to HTML (file or `stdout`).
+
+```bash
+extramark input.md -o output.html -c style.css
+```
+
+To see all options of the `extramark` see it's help:
+
+```bash
+extramark --help
+```
+
+### Features
+
+- Defined clearly as a superset of CommonMark
+- Syntax extensions
+  - [Automatic typographic replacements][typographer]
+  - [Tables][table]
+  - [Anchors for headings][anchor] (up to heading level 3)
+  - [Definition lists][definition-list]
+  - [Superscript][superscript]
+  - [Subscript][subscript]
+  - [Abbreviations][abbreviation]
+  - [Footnotes][footnote]
+  - [Critic Markup][critic-markup]
+- Integrated CLI tool for command-line conversion to HTML
+
+[typographer]: https://github.com/markdown-it/markdown-it/blob/master/lib/rules_core/replacements.js
+[table]: https://help.github.com/articles/organizing-information-with-tables/
+[anchor]: https://github.com/valeriangalliat/markdown-it-anchor
+[definition-list]: https://github.com/markdown-it/markdown-it-deflist
+[superscript]: https://github.com/markdown-it/markdown-it-sup
+[subscript]: https://github.com/markdown-it/markdown-it-sub
+[abbreviation]: https://github.com/markdown-it/markdown-it-abbr
+[footnote]: https://github.com/markdown-it/markdown-it-footnote
+[critic-markup]: http://criticmarkup.com/
+
+## Contributing
+
+All ideas, recommendations, bug reports, pull requests are welcome. 🙂

package/bin/extramark.js

@@ -1,73 +1,64 @@
-#!/usr/bin/env node
+import { error, log } from "node:console";
+import { mkdir, readFile, writeFile } from "node:fs/promises";
+import { dirname } from "node:path";
+import { argv, exit, stdin, stdout } from "node:process";
+import { styleText } from "node:util";
 
-const path = require("path");
-const program = require("commander");
+import { program } from "commander";
+import { html } from "common-tags";
 
-const { ensureDir, readFile, writeFile } = require("fs-extra");
-const { html } = require("common-tags");
-const { render } = require("../lib/extramark");
-const { logger } = require("./utils/logger");
+import { render } from "../src/index.js";
 
 program
   .description("CLI for converting Markdown documents to HTML with ExtraMark")
   .usage("<input> [options]")
-  .option("-i --input [path]", "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")
   .option("-q --quiet", "omit console output")
-  .parse(process.argv);
+  .parse(argv);
 
-async function convert(program) {
-  const input = {
-    file: program.input || program.args[0] || process.stdin.fd
-  };
+const options = program.opts();
+const inputFile = program.args[0];
+const outputFile = options.output;
+const data = {};
 
-  const output = {
-    dir: program.output ? path.dirname(program.output) : "",
-    file: program.output || process.stdout.fd
-  };
-
-  if (program.quiet || output.file === process.stdout.fd) {
-    logger.disable();
-  }
-
-  try {
-    logger.await("Reading input...");
-    input.data = await readFile(input.file, "utf-8");
-  } catch (err) {
-    logger.error(`Could not read input file \`${input.file}\`.\n`, err);
-    return;
+try {
+  if (inputFile) {
+    data.raw = await readFile(inputFile, "utf-8");
+  } else {
+    const buffer = await Array.fromAsync(stdin);
+    data.raw = buffer.toString();
   }
+} catch {
+  error(`${styleText("red", "!")} Could not read input file '${inputFile}'.`);
+  exit(1);
+}
 
-  try {
-    logger.await("Generating output...");
-    output.data = html`
-      <!DOCTYPE html>
-      <meta charset="utf-8" />
-      <title>${program.title || `Markdown document`}</title>
-      ${program.css ? `<link rel="stylesheet" href="${program.css}">` : ``}
-      ${await render(input.data)}
-    `;
-  } catch (err) {
-    logger.error(`Could not parse input data.\n`, err);
-    return;
-  }
+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)}
+  `;
+} catch {
+  error(`${styleText("red", "!")} Could not parse input data.`);
+  exit(1);
+}
 
-  try {
-    await ensureDir(output.dir);
-  } catch (err) {
-    logger.error(`Could not create output dir \`${output.dir}\`.\n`, err);
-    return;
+try {
+  if (outputFile) {
+    await mkdir(dirname(outputFile), { recursive: true });
+    await writeFile(outputFile, data.parsed);
+  } else {
+    stdout.write(data.parsed + "\n");
   }
 
-  try {
-    logger.await("Writing output...");
-    await writeFile(output.file, output.data);
-    logger.success(`Created: ${output.file}`);
-  } catch (err) {
-    logger.error(`Could not write output file \`${output.file}\`.\n`, err);
+  if (outputFile && !options.quiet) {
+    log(`${styleText("green", "✔")} Created: ${outputFile}`);
   }
+} catch (e) {
+  error(`${styleText("red", "!")} Could not write output file '${outputFile}'.`, e);
+  exit(1);
 }
-
-convert(program);

package/package.json

@@ -1,57 +1,40 @@
 {
   "name": "extramark",
-  "version": "0.3.2",
+  "version": "2.0.0",
   "description": "CommonMark superset with the most widely used syntax extensions",
-  "author": "Márton Visnovitz <vimtaai@inf.elte.hu>",
+  "author": "Márton Visnovitz <visnovitz.marton@gmail.com>",
   "license": "MIT",
   "repository": "github:vimtaai/extramark",
-  "module": "src/index.js",
-  "main": "lib/extramark.js",
-  "browser": "dist/extramark.min.js",
+  "type": "module",
+  "main": "src/index.js",
   "bin": "bin/extramark.js",
   "files": [
-    "/src",
-    "/lib",
-    "/dist",
-    "/bin"
+    "src/**/.js",
+    "bin/**/*.js"
   ],
   "scripts": {
-    "lint": "eslint src/**/*.js",
-    "build:node": "rollup -c --environment TARGET:node",
-    "build:browser": "rollup -c --environment TARGET:browser,BUILD:development",
-    "build:browser:production": "rollup -c --environment TARGET:browser,BUILD:production",
-    "watch:node": "rollup -c -w --environment TARGET:node",
-    "watch:browser": "rollup -c -w --environment TARGET:browser,BUILD:development",
-    "prepare": "npm run build:node && npm run build:browser && npm run build:browser:production"
+    "lint": "eslint '{src,bin}/**/*.js'",
+    "format": "prettier --check '{src,bin}/**/*.js'",
+    "release": "semantic-release"
   },
   "dependencies": {
-    "commander": "^3.0.2",
-    "common-tags": "^1.8.0",
-    "critic-markup": "^0.4.0",
-    "fs-extra": "^8.1.0",
-    "markdown-it": "^10.0.0",
-    "markdown-it-abbr": "^1.0.4",
-    "markdown-it-anchor": "^5.2.4",
-    "markdown-it-deflist": "^2.0.3",
-    "markdown-it-footnote": "^3.0.2",
-    "markdown-it-sub": "^1.0.0",
-    "markdown-it-sup": "^1.0.0",
-    "signale": "^1.4.0"
+    "commander": "^12.1.0",
+    "common-tags": "^1.8.2",
+    "critic-markup": "^1.1.3",
+    "markdown-it": "^14.1.0",
+    "markdown-it-abbr": "^2.0.0",
+    "markdown-it-anchor": "^9.2.0",
+    "markdown-it-deflist": "^3.0.0",
+    "markdown-it-footnote": "^4.0.0",
+    "markdown-it-sub": "^2.0.0",
+    "markdown-it-sup": "^2.0.0"
   },
   "devDependencies": {
-    "@babel/core": "^7.6.2",
-    "@babel/preset-env": "^7.6.2",
-    "eslint": "^6.5.1",
-    "eslint-config-prettier": "^6.3.0",
-    "eslint-config-problems": "^3.0.1",
-    "eslint-plugin-prettier": "^3.1.1",
-    "prettier": "^1.18.2",
-    "rollup": "^1.22.0",
-    "rollup-plugin-babel": "^4.3.3",
-    "rollup-plugin-babel-minify": "^9.1.0",
-    "rollup-plugin-commonjs": "^10.1.0",
-    "rollup-plugin-json": "^4.0.0",
-    "rollup-plugin-node-builtins": "^2.1.2",
-    "rollup-plugin-node-resolve": "^5.2.0"
+    "@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"
   }
 }

package/src/index.js

@@ -1,26 +1,19 @@
-import MarkdownIt from "markdown-it";
-
-import anchor from "markdown-it-anchor";
-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 "./syntax/critic";
-
-const parser = new MarkdownIt("commonmark");
-
-parser.set({ typographer: true });
-parser.enable("replacements").enable("table");
-parser
-  .use(anchor, [1, 2, 3])
-  .use(deflist)
-  .use(sup)
-  .use(sub)
-  .use(abbr)
-  .use(footnote)
-  .use(critic);
-
-export const parse = parser.parse.bind(parser);
-export const render = parser.render.bind(parser);
+import MarkdownIt from "markdown-it";
+
+import anchor from "markdown-it-anchor";
+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";
+
+const parser = new MarkdownIt("commonmark");
+
+parser.set({ typographer: true });
+parser.enable("replacements").enable("table");
+parser.use(anchor, [1, 2, 3]).use(deflist).use(sup).use(sub).use(abbr).use(footnote).use(critic);
+
+export const parse = parser.parse.bind(parser);
+export const render = parser.render.bind(parser);

package/CHANGELOG.md

@@ -1,26 +0,0 @@
-# Changelog
-
-## [0.3.2] - 2019-10-03
-
-- 🔺 Dependency update
-
-## [0.3.1] - 2019-09-11
-
-- 🔺 Dependency update
-
-## [0.3.0] - 2019-09-11
-
-- 🔺 Dependency update
-- 🔺 Changed list of supported browsers - dropped support for IE and Opera Mini (⚡)
-- 
-## [0.2.1] - 2019-09-09
-
-- 🔺 Dependency update
-
-## [0.2.0] - 2019-06-28
-
-- 🔺 Change function export style in Node.js (⚡)
-
-## [0.1.0] - 2019-02-06
-
-- ✨ **Initial release**

package/bin/utils/logger.js

@@ -1,5 +0,0 @@
-const { Signale } = require("signale");
-
-const logger = new Signale({ scope: "extramark", interactive: true });
-
-module.exports = { logger };