feat: add CJS entry point

mrazauskas · Feb 20, 2024 · 27fd3c4 · 27fd3c4
1 parent ed9e539
commit 27fd3c4
Show file tree

Hide file tree

Showing 5 changed files with 173 additions and 153 deletions.
diff --git a/c8.config.json b/c8.config.json
@@ -1,6 +1,6 @@
 {
   "all": true,
-  "include": ["**/*.js"],
+  "include": ["**/*.cjs", "**/*.js"],
   "reporter": ["lcovonly", "text"],
   "tempDirectory": "./coverage/temp"
 }
diff --git a/index.cjs b/index.cjs
@@ -0,0 +1,152 @@
+const escape = "\u001b";
+
+const colorText = new Map([
+  ["0", "/"],
+
+  ["1", "bold"],
+  ["2", "dim"],
+  ["3", "italic"],
+  ["4", "underline"],
+
+  ["7", "inverse"],
+  ["8", "hidden"],
+  ["9", "strikethrough"],
+
+  ["22", "/intensity"],
+  ["23", "/italic"],
+  ["24", "/underline"],
+
+  ["27", "/inverse"],
+  ["28", "/hidden"],
+  ["29", "/strikethrough"],
+
+  ["30", "black"],
+  ["31", "red"],
+  ["32", "green"],
+  ["33", "yellow"],
+  ["34", "blue"],
+  ["35", "magenta"],
+  ["36", "cyan"],
+  ["37", "white"],
+
+  ["39", "/color"],
+
+  ["40", "backgroundBlack"],
+  ["41", "backgroundRed"],
+  ["42", "backgroundGreen"],
+  ["43", "backgroundYellow"],
+  ["44", "backgroundBlue"],
+  ["45", "backgroundMagenta"],
+  ["46", "backgroundCyan"],
+  ["47", "backgroundWhite"],
+
+  ["49", "/background"],
+
+  ["53", "overline"],
+
+  ["55", "/overline"],
+
+  ["90", "gray"],
+  ["91", "brightRed"],
+  ["92", "brightGreen"],
+  ["93", "brightYellow"],
+  ["94", "brightBlue"],
+  ["95", "brightMagenta"],
+  ["96", "brightCyan"],
+  ["97", "brightWhite"],
+
+  ["100", "backgroundGray"],
+  ["101", "backgroundBrightRed"],
+  ["102", "backgroundBrightGreen"],
+  ["103", "backgroundBrightYellow"],
+  ["104", "backgroundBrightBlue"],
+  ["105", "backgroundBrightMagenta"],
+  ["106", "backgroundBrightCyan"],
+  ["107", "backgroundBrightWhite"],
+]);
+
+const commandText = new Map([
+  ["A", ["moveCursorUpBy", "Row"]],
+  ["B", ["moveCursorDownBy", "Row"]],
+  ["C", ["moveCursorRightBy", "Column"]],
+  ["D", ["moveCursorLeftBy", "Column"]],
+  ["E", ["moveCursorDownBy", "Row", "ToColumn1"]],
+  ["F", ["moveCursorUpBy", "Row", "ToColumn1"]],
+  ["G", ["moveCursorTo", ["Column"]]],
+  ["H", ["moveCursorTo", ["Row", "Column"]]],
+  ["S", ["scrollUpBy", "Row"]],
+  ["T", ["scrollDownBy", "Row"]],
+  ["f", ["moveCursorTo", ["Row", "Column"]]],
+]);
+
+function colorOrStyleSequenceReplacer(sequenceText) {
+  const replacement = [];
+
+  const colorParameters = sequenceText.match(/\d{1,3}/g) || ["0"];
+
+  colorParameters.forEach((colorParameter) => {
+    replacement.push(colorText.get(colorParameter) || "?");
+  });
+
+  return `<${replacement.join(", ")}>`;
+}
+
+function moveCursorByReplacer(sequenceText) {
+  const replacement = [];
+  sequenceText = sequenceText.trimEnd();
+
+  const parameterValue = sequenceText.match(/\[(\d*)/)[1];
+  const [command, parameterName, tailText] = commandText.get(
+    sequenceText.slice(-1),
+  );
+
+  replacement.push(command, parameterValue || 1, parameterName);
+  replacement.push(parameterValue > 1 ? "s" : "");
+  replacement.push(tailText);
+
+  return `<${replacement.join("")}>\n`;
+}
+
+function moveCursorToReplacer(sequenceText) {
+  const replacement = [];
+  sequenceText = sequenceText.trimEnd();
+
+  const parameterValues = sequenceText.match(/\[(\d*;?\d*)/)[1].split(";");
+  const [command, parameterNames] = commandText.get(sequenceText.slice(-1));
+
+  replacement.push(command);
+
+  parameterNames.forEach((parameterName) => {
+    replacement.push(parameterName, parameterValues.shift() || 1);
+  });
+
+  return `<${replacement.join("")}>\n`;
+}
+
+function prettyAnsi(text) {
+  return text
+    .replace(/\u001b\[(\d*;?)*m/g, colorOrStyleSequenceReplacer)
+    .replace(/.(?=\u001b)/g, (match) => `${match}\n`)
+    .replace(
+      /\u001b\[2J\n?\u001b\[(3J\n?\u001b\[H|0f)\n?/g,
+      "<clearTerminal>\n",
+    )
+    .replace(/\u001b\[\d*[A-FST]\n?/g, moveCursorByReplacer)
+    .replace(/\u001b\[\d*G\n?/g, moveCursorToReplacer)
+    .replace(/\u001b\[\d*;?\d*[Hf]\n?/g, moveCursorToReplacer)
+    .replace(/\u001b\[0?J\n?/g, "<eraseScreenDown>\n")
+    .replace(/\u001b\[1J\n?/g, "<eraseScreenUp>\n")
+    .replace(/\u001b\[2J\n?/g, "<eraseScreen>\n")
+    .replace(/\u001b\[3J\n?/g, "<eraseScreenAndDeleteBuffer>\n")
+    .replace(/\u001b\[0?K\n?/g, "<eraseLineEnd>\n")
+    .replace(/\u001b\[1K\n?/g, "<eraseLineStart>\n")
+    .replace(/\u001b\[2K\n?/g, "<eraseLine>\n")
+    .replace(/\u001b\[6n\n?/g, "<getCursorPosition>\n")
+    .replace(/\u001b(\[s|7)\n?/g, "<saveCursorPosition>\n")
+    .replace(/\u001b(\[u|8)\n?/g, "<restoreCursorPosition>\n")
+    .replace(/\u001b\[\?25h\n?/g, "<showCursor>\n")
+    .replace(/\u001b\[\?25l\n?/g, "<hideCursor>\n")
+    .replace(escape, "<ESC>");
+}
+
+module.exports = prettyAnsi;
diff --git a/index.d.cts b/index.d.cts
@@ -0,0 +1,7 @@
+/**
+ * Converts [ANSI escape sequences](https://en.wikipedia.org/wiki/ANSI_escape_code)
+ * into human readable text.
+ */
+declare function prettyAnsi(text: string): string;
+
+export = prettyAnsi;
diff --git a/index.js b/index.js
@@ -1,152 +1,3 @@
-const escape = "\u001b";
-
-const colorText = new Map([
-  ["0", "/"],
-
-  ["1", "bold"],
-  ["2", "dim"],
-  ["3", "italic"],
-  ["4", "underline"],
-
-  ["7", "inverse"],
-  ["8", "hidden"],
-  ["9", "strikethrough"],
-
-  ["22", "/intensity"],
-  ["23", "/italic"],
-  ["24", "/underline"],
-
-  ["27", "/inverse"],
-  ["28", "/hidden"],
-  ["29", "/strikethrough"],
-
-  ["30", "black"],
-  ["31", "red"],
-  ["32", "green"],
-  ["33", "yellow"],
-  ["34", "blue"],
-  ["35", "magenta"],
-  ["36", "cyan"],
-  ["37", "white"],
-
-  ["39", "/color"],
-
-  ["40", "backgroundBlack"],
-  ["41", "backgroundRed"],
-  ["42", "backgroundGreen"],
-  ["43", "backgroundYellow"],
-  ["44", "backgroundBlue"],
-  ["45", "backgroundMagenta"],
-  ["46", "backgroundCyan"],
-  ["47", "backgroundWhite"],
-
-  ["49", "/background"],
-
-  ["53", "overline"],
-
-  ["55", "/overline"],
-
-  ["90", "gray"],
-  ["91", "brightRed"],
-  ["92", "brightGreen"],
-  ["93", "brightYellow"],
-  ["94", "brightBlue"],
-  ["95", "brightMagenta"],
-  ["96", "brightCyan"],
-  ["97", "brightWhite"],
-
-  ["100", "backgroundGray"],
-  ["101", "backgroundBrightRed"],
-  ["102", "backgroundBrightGreen"],
-  ["103", "backgroundBrightYellow"],
-  ["104", "backgroundBrightBlue"],
-  ["105", "backgroundBrightMagenta"],
-  ["106", "backgroundBrightCyan"],
-  ["107", "backgroundBrightWhite"],
-]);
-
-const commandText = new Map([
-  ["A", ["moveCursorUpBy", "Row"]],
-  ["B", ["moveCursorDownBy", "Row"]],
-  ["C", ["moveCursorRightBy", "Column"]],
-  ["D", ["moveCursorLeftBy", "Column"]],
-  ["E", ["moveCursorDownBy", "Row", "ToColumn1"]],
-  ["F", ["moveCursorUpBy", "Row", "ToColumn1"]],
-  ["G", ["moveCursorTo", ["Column"]]],
-  ["H", ["moveCursorTo", ["Row", "Column"]]],
-  ["S", ["scrollUpBy", "Row"]],
-  ["T", ["scrollDownBy", "Row"]],
-  ["f", ["moveCursorTo", ["Row", "Column"]]],
-]);
-
-function colorOrStyleSequenceReplacer(sequenceText) {
-  const replacement = [];
-
-  const colorParameters = sequenceText.match(/\d{1,3}/g) || ["0"];
-
-  colorParameters.forEach((colorParameter) => {
-    replacement.push(colorText.get(colorParameter) || "?");
-  });
-
-  return `<${replacement.join(", ")}>`;
-}
-
-function moveCursorByReplacer(sequenceText) {
-  const replacement = [];
-  sequenceText = sequenceText.trimEnd();
-
-  const parameterValue = sequenceText.match(/\[(\d*)/)[1];
-  const [command, parameterName, tailText] = commandText.get(
-    sequenceText.slice(-1),
-  );
-
-  replacement.push(command, parameterValue || 1, parameterName);
-  replacement.push(parameterValue > 1 ? "s" : "");
-  replacement.push(tailText);
-
-  return `<${replacement.join("")}>\n`;
-}
-
-function moveCursorToReplacer(sequenceText) {
-  const replacement = [];
-  sequenceText = sequenceText.trimEnd();
-
-  const parameterValues = sequenceText.match(/\[(\d*;?\d*)/)[1].split(";");
-  const [command, parameterNames] = commandText.get(sequenceText.slice(-1));
-
-  replacement.push(command);
-
-  parameterNames.forEach((parameterName) => {
-    replacement.push(parameterName, parameterValues.shift() || 1);
-  });
-
-  return `<${replacement.join("")}>\n`;
-}
-
-function prettyAnsi(text) {
-  return text
-    .replace(/\u001b\[(\d*;?)*m/g, colorOrStyleSequenceReplacer)
-    .replace(/.(?=\u001b)/g, (match) => `${match}\n`)
-    .replace(
-      /\u001b\[2J\n?\u001b\[(3J\n?\u001b\[H|0f)\n?/g,
-      "<clearTerminal>\n",
-    )
-    .replace(/\u001b\[\d*[A-FST]\n?/g, moveCursorByReplacer)
-    .replace(/\u001b\[\d*G\n?/g, moveCursorToReplacer)
-    .replace(/\u001b\[\d*;?\d*[Hf]\n?/g, moveCursorToReplacer)
-    .replace(/\u001b\[0?J\n?/g, "<eraseScreenDown>\n")
-    .replace(/\u001b\[1J\n?/g, "<eraseScreenUp>\n")
-    .replace(/\u001b\[2J\n?/g, "<eraseScreen>\n")
-    .replace(/\u001b\[3J\n?/g, "<eraseScreenAndDeleteBuffer>\n")
-    .replace(/\u001b\[0?K\n?/g, "<eraseLineEnd>\n")
-    .replace(/\u001b\[1K\n?/g, "<eraseLineStart>\n")
-    .replace(/\u001b\[2K\n?/g, "<eraseLine>\n")
-    .replace(/\u001b\[6n\n?/g, "<getCursorPosition>\n")
-    .replace(/\u001b(\[s|7)\n?/g, "<saveCursorPosition>\n")
-    .replace(/\u001b(\[u|8)\n?/g, "<restoreCursorPosition>\n")
-    .replace(/\u001b\[\?25h\n?/g, "<showCursor>\n")
-    .replace(/\u001b\[\?25l\n?/g, "<hideCursor>\n")
-    .replace(escape, "<ESC>");
-}
+import prettyAnsi from "./index.cjs";
 
 export default prettyAnsi;
diff --git a/package.json b/package.json
@@ -13,12 +13,22 @@
     "type": "git",
     "url": "git+https://github.com/mrazauskas/pretty-ansi.git"
   },
-  "license": "MIT",
   "funding": "https://github.com/sponsors/mrazauskas",
+  "license": "MIT",
   "type": "module",
-  "exports": "./index.js",
+  "exports": {
+    ".": {
+      "import": "./index.js",
+      "require": "./index.cjs"
+    },
+    "./package.json": "./package.json"
+  },
+  "main": "./index.cjs",
+  "types": "./index.d.cts",
   "files": [
+    "index.d.cts",
     "index.d.ts",
+    "index.cjs",
     "index.js"
   ],
   "scripts": {