build(src,test,lib): properly build project/ignore build products

.gitignore

@@ -1 +1,26 @@
-node_modules/
+# Ignore Node.js modules dir.
+node_modules/
+
+# Ignore metadata generated by Jekyll.
+_site/
+.sass-cache/
+.jekyll-cache/
+.jekyll-metadata
+
+# Ignore folders generated by Bundler.
+.bundle/
+/vendor/
+
+# Ignore secrets.
+.env
+
+# Ignore macOS-specific files.
+.DS_Store
+
+# Ignore out dirs of build products.
+types/
+lib/
+dist/
+
+# Ignore TypeScript log files.
+tsconfig.tsbuildinfo

.nvmrc

@@ -1 +1 @@
-node
+lts/gallium

package.json

@@ -5,8 +5,8 @@
   "engines": {
     "node": "^14.17.0 || ^16.13.0 || ^18.12.0"
   },
-  "main": "./index.js",
-  "types": "./index.d.ts",
+  "main": "./lib/index.js",
+  "types": "./types/index.d.ts",
   "scripts": {
     "prepare": "npm run compile-src && npm run compile-doc",
     "compile-src": "tsc --project ./",
@@ -19,7 +19,7 @@
   "bugs": "https://github.com/openinf/util-text/issues",
   "homepage": "https://github.com/openinf/util-text#readme",
   "devDependencies": {
-    "@types/node": "18.11.3",
+    "@types/node": "16.11.68",
     "tape": "5.6.1",
     "typescript": "4.8.4"
   },

typings/declaration404.d.ts → src/declaration404.d.ts

@@ -1,2 +1,3 @@
 declare module 'has-unicode';
 declare module 'supports-ansi';
+declare module 'colorette';

test/index.test.js

@@ -0,0 +1,33 @@
+// Copyright 2018-2021 The OpenINF Authors. All rights reserved. MIT license.
+
+const test = require("tape");
+const { mdCodeSpans2html } = require("./index.js");
+
+// @see
+// https://github.com/KyleGobel/MarkdownSharp-GithubCodeBlocks/blob/0ba86dc7ea58ab9ad6b0dc663c3def7558f8f17e/MarkdownSharp.cs#L1352
+test(
+  "should translate multiple backtick delimiters of Markdown `code spans` " +
+    "into HTML code tags",
+  (t) => {
+    let textIn = "Just type ``foo `bar` baz`` at the prompt.";
+    let textOut = "Just type <code>foo `bar` baz</code> at the prompt.";
+    t.strictEquals(mdCodeSpans2html(textIn), textOut);
+    textIn = "... type `` `bar` `` ...";
+    textOut = "... type <code>`bar`</code> ...";
+    t.strictEquals(mdCodeSpans2html(textIn), textOut);
+    t.end();
+  }
+);
+
+test(
+  "should translate single backtick delimiters of Markdown `code spans` " +
+    "into HTML code tags",
+  (t) => {
+    let textIn =
+      "Top-level `await` enables modules to act as big async functions.";
+    let textOut =
+      "Top-level <code>await</code> enables modules to act as big async functions.";
+    t.strictEquals(mdCodeSpans2html(textIn), textOut);
+    t.end();
+  }
+);

tsconfig.base.json

@@ -0,0 +1,32 @@
+{
+  "compilerOptions": {
+    "allowSyntheticDefaultImports": true,
+    "allowUnreachableCode": false,
+    "allowUnusedLabels": false,
+    "composite": true,
+    "declaration": true,
+    "declarationDir": "./types",
+    "declarationMap": true,
+    "downlevelIteration": true,
+    "esModuleInterop": true,
+    "forceConsistentCasingInFileNames": true,
+    "lib": ["ESNext"],
+    "module": "node16",
+    "moduleResolution": "node16",
+    "noImplicitReturns": true,
+    "outDir": "lib",
+    "paths": {},
+    "pretty": true,
+    "resolveJsonModule": true,
+    "rootDir": "src",
+    "rootDirs": ["src", "lib"],
+    "skipLibCheck": true,
+    "sourceMap": true,
+    "strict": true,
+    "strictNullChecks": true,
+    "target": "ESNext",
+    "typeRoots": ["node_modules/@types"],
+    "types": ["node"]
+  },
+  "include": ["src/**/*.ts"]
+}