remove-markdown 0.5.2 → 0.5.4

package/README.md

@@ -1,5 +1,3 @@
-![default workflow](https://github.com/stiang/remove-markdown/actions/workflows/default.yaml/badge.svg)
-
 ## What is it?
 **remove-markdown** is a node.js module that will remove (strip) Markdown formatting from text.
 *Markdown formatting* means pretty much anything that doesn’t look like regular text, like square brackets, asterisks etc.

package/index.d.ts

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

package/index.js

@@ -7,6 +7,7 @@ module.exports = function(md, options) {
   options.abbr = options.hasOwnProperty('abbr') ? options.abbr : false;
   options.replaceLinksWithURL = options.hasOwnProperty('replaceLinksWithURL') ? options.replaceLinksWithURL : false;
   options.htmlTagsToSkip = options.hasOwnProperty('htmlTagsToSkip') ? options.htmlTagsToSkip : [];
+  options.throwError = options.hasOwnProperty('throwError') ? options.throwError : false;
 
   var output = md || '';
 
@@ -48,7 +49,7 @@ module.exports = function(md, options) {
       htmlReplaceRegex = new RegExp(
           '<' +
           joinedHtmlTagsToSkip +
-          '[^>]*>', 
+          '[^>]*>',
           'ig'
       );
     }
@@ -74,10 +75,8 @@ module.exports = function(md, options) {
       .replace(/^(\n)?\s{0,}#{1,6}\s*( (.+))? +#+$|^(\n)?\s{0,}#{1,6}\s*( (.+))?$/gm, '$1$3$4$6')
       // Remove * emphasis
       .replace(/([\*]+)(\S)(.*?\S)??\1/g, '$2$3')
-      // Remove _ emphasis. Unlike *, _ emphasis gets rendered only if 
-      //   1. Either there is a whitespace character before opening _ and after closing _.
-      //   2. Or _ is at the start/end of the string.
-      .replace(/(^|\W)([_]+)(\S)(.*?\S)??\2($|\W)/g, '$1$3$4$5')
+      // Remove _ emphasis
+      .replace(/(_+)(.*?\S)(_+)/g, '$1$3$4$5')
       // Remove code blocks
       .replace(/(`{3,})(.*?)\1/gm, '$2')
       // Remove inline code
@@ -89,7 +88,9 @@ module.exports = function(md, options) {
       // Replace strike through
       .replace(/~(.*?)~/g, '$1');
   } catch(e) {
-    console.error(e);
+    if (options.throwError) throw e;
+
+    console.error("remove-markdown encountered error: %s", e);
     return md;
   }
   return output;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "remove-markdown",
-  "version": "0.5.2",
+  "version": "0.5.4",
   "description": "Remove Markdown formatting from text",
   "main": "index.js",
   "scripts": {