remove-markdown 0.6.4 → 0.7.0-rc.0

package/README.md

@@ -3,7 +3,7 @@
 [![GitHub Actions Build Status](https://github.com/zuchka/remove-markdown/actions/workflows/default.yaml/badge.svg)](https://github.com/zuchka/remove-markdown/actions/workflows/default.yaml)
 
 ## What is it?
-**remove-markdown** is a node.js module that will remove (strip) Markdown formatting from text.
+**remove-markdown** is a JavaScript module that removes (strips) Markdown formatting from text. It supports CommonJS and ES modules in Node.js, plus Deno through npm compatibility.
 *Markdown formatting* means pretty much anything that doesn’t look like regular text, like square brackets, asterisks etc.
 
 ## When do I need it?
@@ -11,17 +11,40 @@ The typical use case is to display an excerpt from some Markdown text, without a
 
 ## Installation
 
-```
+```sh
 npm install remove-markdown
 ```
 
 ## Usage
+
+### CommonJS
+
 ```js
 const removeMd = require('remove-markdown');
 const markdown = '# This is a heading\n\nThis is a paragraph with [a link](http://www.disney.com/) in it.';
 const plainText = removeMd(markdown); // plainText is now 'This is a heading\n\nThis is a paragraph with a link in it.'
 ```
 
+### Node.js ES modules
+
+```js
+import removeMd from 'remove-markdown';
+
+const markdown = '# This is a heading\n\nThis is a paragraph with [a link](http://www.disney.com/) in it.';
+const plainText = removeMd(markdown);
+```
+
+### Deno
+
+```js
+import removeMd from 'npm:remove-markdown@^0.7.0';
+
+const markdown = '# This is a heading\n\nThis is a paragraph with [a link](http://www.disney.com/) in it.';
+const plainText = removeMd(markdown);
+```
+
+Deno support is provided through the npm package; there is no separate JSR package. The package exposes one callable default export in every runtime. Named exports and direct imports from raw GitHub URLs are not supported.
+
 You can also supply an options object to the function. Currently, the following options are supported:
 
 ```js

package/index.d.mts

@@ -0,0 +1,13 @@
+declare function removeMd(md: string, options?: {
+  stripListLeaders?: boolean;
+  listUnicodeChar?: string;
+  gfm?: boolean;
+  useImgAltText?: boolean;
+  abbr?: boolean;
+  replaceLinksWithURL?: boolean;
+  separateLinksAndTexts?: string;
+  htmlTagsToSkip?: string[];
+  throwError?: boolean;
+}): string;
+
+export default removeMd;

package/index.mjs

@@ -0,0 +1,3 @@
+import removeMarkdown from './index.js';
+
+export default removeMarkdown;

package/package.json

@@ -1,20 +1,52 @@
 {
   "name": "remove-markdown",
-  "version": "0.6.4",
+  "version": "0.7.0-rc.0",
   "description": "Remove Markdown formatting from text",
-  "main": "index.js",
+  "type": "commonjs",
+  "main": "./index.js",
+  "types": "./index.d.ts",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./index.d.mts",
+        "default": "./index.mjs"
+      },
+      "require": {
+        "types": "./index.d.ts",
+        "default": "./index.js"
+      },
+      "default": "./index.js"
+    },
+    "./index": "./index.js",
+    "./index.js": "./index.js",
+    "./index.d.mts": "./index.d.mts",
+    "./index.d.ts": "./index.d.ts",
+    "./LICENSE": "./LICENSE",
+    "./README.md": "./README.md",
+    "./package.json": "./package.json"
+  },
   "files": [
     "index.js",
+    "index.mjs",
     "index.d.ts",
+    "index.d.mts",
     "README.md",
     "LICENSE"
   ],
   "scripts": {
-    "test": "./node_modules/.bin/mocha -R spec test/remove-markdown.js"
+    "test": "mocha -R spec test/remove-markdown.js",
+    "test:modules": "node --test test/modules.test.mjs",
+    "test:package": "node --test test/package.test.mjs",
+    "test:types": "node --test test/types.test.mjs",
+    "test:differential": "node --test test/differential.test.mjs",
+    "test:bundlers": "node --test test/bundlers.test.mjs",
+    "test:deno": "deno test test/deno.test.mjs",
+    "test:deno:package": "node --test test/deno-package.test.mjs",
+    "prepublishOnly": "npm test && npm run test:modules && npm run test:package && npm run test:types"
   },
   "repository": {
     "type": "git",
-    "url": "https://github.com/zuchka/remove-markdown.git"
+    "url": "git+https://github.com/zuchka/remove-markdown.git"
   },
   "keywords": [
     "markdown"
@@ -26,8 +58,17 @@
   },
   "homepage": "https://github.com/zuchka/remove-markdown",
   "devDependencies": {
+    "@arethetypeswrong/cli": "^0.18.5",
+    "@rollup/plugin-commonjs": "^29.0.3",
+    "@rollup/plugin-node-resolve": "^16.0.3",
     "chai": "^4.0.2",
-    "mocha": "^10.2.0",
-    "should": "^5.0.0"
+    "esbuild": "^0.28.2",
+    "mocha": "11.3.0",
+    "rollup": "^4.62.5",
+    "should": "^5.0.0",
+    "typescript": "^7.0.2"
+  },
+  "overrides": {
+    "serialize-javascript": "^7.0.5"
   }
 }