remove-markdown 0.6.2 → 0.6.4

package/README.md

@@ -26,10 +26,15 @@ You can also supply an options object to the function. Currently, the following
 
 ```js
 const plainText = removeMd(markdown, {
-  stripListLeaders: true , // strip list leaders (default: true)
-  listUnicodeChar: '',     // char to insert instead of stripped list leaders (default: '')
-  gfm: true                // support GitHub-Flavored Markdown (default: true)
-  useImgAltText: true      // replace images with alt-text, if present (default: true)
+  stripListLeaders: true ,     // strip list leaders (default: true)
+  listUnicodeChar: '',         // char to insert instead of stripped list leaders (default: '')
+  gfm: true,                   // support GitHub-Flavored Markdown (default: true)
+  useImgAltText: true,         // replace images with alt-text, if present (default: true)
+  abbr: true,                  // remove abbreviations, if present (default: false)
+  replaceLinksWithURL: true,   // remove inline links, if present (default: false)
+  separateLinksAndTexts: ': ', // replace inline links with text, separator and link, if present (default: null)
+  htmlTagsToSkip: ['a', 'b'],  // HTML tags to skip, if present (default: [])
+  throwError: false,           // throw errors instead of catching and logging (default: false)
 });
 ```
 

package/index.d.ts

@@ -1,11 +1,13 @@
-declare function removeMd(md: string, options?: {
-  stripListLeaders?: boolean;
-  listUnicodeChar?: string;
-  gfm?: boolean;
-  useImgAltText: boolean;
-  abbr?: boolean;
-  replaceLinksWithURL?: boolean;
-  htmlTagsToSkip?: string[];
-}): string;
-
-export = removeMd;
+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 = removeMd;

package/index.js

@@ -6,6 +6,7 @@ module.exports = function(md, options) {
   options.useImgAltText = options.hasOwnProperty('useImgAltText') ? options.useImgAltText : true;
   options.abbr = options.hasOwnProperty('abbr') ? options.abbr : false;
   options.replaceLinksWithURL = options.hasOwnProperty('replaceLinksWithURL') ? options.replaceLinksWithURL : false;
+  options.separateLinksAndTexts = options.hasOwnProperty('separateLinksAndTexts') ? options.separateLinksAndTexts : null;
   options.htmlTagsToSkip = options.hasOwnProperty('htmlTagsToSkip') ? options.htmlTagsToSkip : [];
   options.throwError = options.hasOwnProperty('throwError') ? options.throwError : false;
 
@@ -36,7 +37,7 @@ module.exports = function(md, options) {
       // Remove abbreviations
       output = output.replace(/\*\[.*\]:.*\n/, '');
     }
-    
+
     let htmlReplaceRegex = /<[^>]*>/g
     if (options.htmlTagsToSkip && options.htmlTagsToSkip.length > 0) {
       // Create a regex that matches tags not in htmlTagsToSkip
@@ -47,6 +48,10 @@ module.exports = function(md, options) {
       )
     }
 
+    if (options.separateLinksAndTexts) {
+      output = output.replace(/\[([^\]]+)\]\(([^)]+)\)/g, '$1' + options.separateLinksAndTexts + '$2');
+    }
+
     output = output
       // Remove HTML tags
       .replace(htmlReplaceRegex, '')
@@ -58,7 +63,7 @@ module.exports = function(md, options) {
       // Remove images
       .replace(/\!\[(.*?)\][\[\(].*?[\]\)]/g, options.useImgAltText ? '$1' : '')
       // Remove inline links
-      .replace(/\[([\s\S]*?)\]\s*[\(\[].*?[\)\]]/g, options.replaceLinksWithURL ? '$2' : '$1')
+      .replace(/\[([\s\S]*?)\]\s*[\(\[](.*?)[\)\]]/g, options.replaceLinksWithURL ? '$2' : '$1')
       // Remove blockquotes
       .replace(/^(\n)?\s{0,3}>\s?/gm, '$1')
       // .replace(/(^|\n)\s{0,3}>\s?/g, '\n\n')
@@ -68,7 +73,7 @@ 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 
+      // 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')

package/package.json

@@ -1,8 +1,14 @@
 {
   "name": "remove-markdown",
-  "version": "0.6.2",
+  "version": "0.6.4",
   "description": "Remove Markdown formatting from text",
   "main": "index.js",
+  "files": [
+    "index.js",
+    "index.d.ts",
+    "README.md",
+    "LICENSE"
+  ],
   "scripts": {
     "test": "./node_modules/.bin/mocha -R spec test/remove-markdown.js"
   },

package/.github/workflows/default.yaml

@@ -1,27 +0,0 @@
-name: Run tests
-
-on:
-  push:
-    branches: [ main ]
-  pull_request:
-    branches: [ main ]
-
-jobs:
-  build:
-    runs-on: ubuntu-latest
-
-    strategy:
-      matrix:
-        node-version: [14.x, 16.x, 18.x]
-        # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
-
-    steps:
-    - uses: actions/checkout@v3
-    - name: Use Node.js ${{ matrix.node-version }}
-      uses: actions/setup-node@v3
-      with:
-        node-version: ${{ matrix.node-version }}
-        cache: 'npm'
-    - run: npm ci
-    - run: npm run build --if-present
-    - run: npm test

package/test/remove-markdown.js

@@ -1,252 +0,0 @@
-'use strict';
-const expect = require('chai').expect;
-const removeMd = require('../');
-
-describe('remove Markdown', function () {
-  describe('removeMd', function () {
-    it('should leave a string alone without markdown', function () {
-      const string = 'Javascript Developers are the best.';
-      expect(removeMd(string)).to.equal(string);
-    });
-
-    it('should strip out remaining markdown', function () {
-      const string = '*Javascript* developers are the _best_.';
-      const expected = 'Javascript developers are the best.';
-      expect(removeMd(string)).to.equal(expected);
-    });
-
-    it('should leave non-matching markdown markdown', function () {
-      const string = '*Javascript* developers* are the _best_.';
-      const expected = 'Javascript developers* are the best.';
-      expect(removeMd(string)).to.equal(expected);
-    });
-
-    it('should leave non-matching markdown, but strip empty anchors', function () {
-      const string = '*Javascript* [developers]()* are the _best_.';
-      const expected = 'Javascript developers* are the best.';
-      expect(removeMd(string)).to.equal(expected);
-    });
-
-    it('should strip HTML', function () {
-      const string = '<p>Hello World</p>';
-      const expected = 'Hello World';
-      expect(removeMd(string)).to.equal(expected);
-    });
-
-    it('should strip anchors', function () {
-      const string = '*Javascript* [developers](https://engineering.condenast.io/)* are the _best_.';
-      const expected = 'Javascript developers* are the best.';
-      expect(removeMd(string)).to.equal(expected);
-    });
-
-    it('should strip img tags', function () {
-      const string = '![](https://placebear.com/640/480)*Javascript* developers are the _best_.';
-      const expected = 'Javascript developers are the best.';
-      expect(removeMd(string)).to.equal(expected);
-    });
-
-    it('should use the alt-text of an image, if it is provided', function () {
-      const string = '![This is the alt-text](https://www.example.com/images/logo.png)';
-      const expected = 'This is the alt-text';
-      expect(removeMd(string)).to.equal(expected);
-    });
-
-    it('should strip code tags', function () {
-      const string = 'In `Getting Started` we set up `something` foo.';
-      const expected = 'In Getting Started we set up something foo.';
-      expect(removeMd(string)).to.equal(expected);
-    });
-
-    it('should strip simple multiline code tags', function () {
-      const string = '```\ncode\n```';
-      const expected = 'code';
-      expect(removeMd(string)).to.equal(expected);
-    });
-    
-    it('should strip complex multiline code blocks with language specified', function () {
-      const string = '```javascript\nconst x = 1;\nconst y = 2;\nconsole.log(x + y);\n```';
-      const expected = 'const x = 1;\nconst y = 2;\nconsole.log(x + y);';
-      expect(removeMd(string)).to.equal(expected);
-    });
-    
-    it('should strip multiline code blocks with multiple paragraphs', function () {
-      const string = 'Text before\n\n```\ncode line 1\n\ncode line 2\n```\n\nText after';
-      const expected = 'Text before\n\ncode line 1\n\ncode line 2\n\nText after';
-      expect(removeMd(string)).to.equal(expected);
-    });
-
-    it('should leave hashtags in headings', function () {
-      const string = '## This #heading contains #hashtags';
-      const expected = 'This #heading contains #hashtags';
-      expect(removeMd(string)).to.equal(expected);
-    });
-
-    it('should remove emphasis', function () {
-      const string = 'I italicized an *I* and it _made_ me *sad*.';
-      const expected = 'I italicized an I and it made me sad.';
-      expect(removeMd(string)).to.equal(expected);
-    });
-
-    it('should remove emphasis only if there is no space between word and emphasis characters.', function () {
-      const string = 'There should be no _space_, *before* *closing * _ephasis character _.';
-      const expected = 'There should be no space, before *closing * _ephasis character _.';
-      expect(removeMd(string)).to.equal(expected);
-    });
-
-    it('should remove "_" emphasis only if there is space before opening and after closing emphasis characters.', function () {
-      const string = '._Spaces_ _ before_ and _after _ emphasised character results in no emphasis.';
-      const expected = '.Spaces _ before_ and _after _ emphasised character results in no emphasis.';
-      expect(removeMd(string)).to.equal(expected);
-    });
-
-    it('should remove double emphasis', function () {
-      const string = '**this sentence has __double styling__**';
-      const expected = 'this sentence has double styling';
-      expect(removeMd(string)).to.equal(expected);
-    });
-
-    it('should not mistake a horizontal rule when symbols are mixed ', function () {
-      const string = 'Some text on a line\n\n--*\n\nA line below';
-      const expected = 'Some text on a line\n\n--*\n\nA line below';
-      expect(removeMd(string)).to.equal(expected);
-    });
-
-    it('should remove horizontal rules', function () {
-      const string = 'Some text on a line\n\n---\n\nA line below';
-      const expected = 'Some text on a line\n\nA line below';
-      expect(removeMd(string)).to.equal(expected);
-    });
-
-    it('should remove horizontal rules with space-separated asterisks', function () {
-      const string = 'Some text on a line\n\n* * *\n\nA line below';
-      const expected = 'Some text on a line\n\nA line below';
-      expect(removeMd(string)).to.equal(expected);
-    });
-
-    it('should remove blockquotes', function () {
-      const string = '>I am a blockquote';
-      const expected = 'I am a blockquote';
-      expect(removeMd(string)).to.equal(expected);
-    });
-
-    it('should remove blockquotes with spaces', function () {
-      const string = '> I am a blockquote';
-      const expected = 'I am a blockquote';
-      expect(removeMd(string)).to.equal(expected);
-    });
-
-    it('should remove indented blockquotes', function () {
-        var tests = [
-            { string: ' > I am a blockquote', expected: 'I am a blockquote' },
-            { string: '  > I am a blockquote', expected: 'I am a blockquote' },
-            { string: '   > I am a blockquote', expected: 'I am a blockquote' },
-        ];
-        tests.forEach(function (test) {
-            expect(removeMd(test.string)).to.equal(test.expected);
-        });
-    });
-    
-    it('should remove blockquotes over multiple lines', function () {
-      const string = '> I am a blockquote firstline  \n>I am a blockquote secondline';
-      const expected = 'I am a blockquote firstline  \nI am a blockquote secondline';
-      expect(removeMd(string)).to.equal(expected);
-    });
-
-    it('should remove blockquotes following other content', function () {
-      const string = '## A headline\n\nA paragraph of text\n\n> I am a blockquote';
-      const expected = 'A headline\n\nA paragraph of text\n\nI am a blockquote';
-
-      expect(removeMd(string)).to.equal(expected);
-    });
-
-    it('should not remove greater than signs', function () {
-      var tests = [
-        { string: '100 > 0', expected: '100 > 0' },
-        { string: '100 >= 0', expected: '100 >= 0' },
-        { string: '100>0', expected: '100>0' },
-        { string: '> 100 > 0', expected: '100 > 0' },
-        { string: '1 < 100', expected: '1 < 100' },
-        { string: '1 <= 100', expected: '1 <= 100' },
-      ];
-      tests.forEach(function (test) {
-        expect(removeMd(test.string)).to.equal(test.expected);
-      });
-    });
-
-    it('should strip unordered list leaders', function () {
-      const string = 'Some text on a line\n\n* A list Item\n* Another list item';
-      const expected = 'Some text on a line\n\nA list Item\nAnother list item';
-      expect(removeMd(string)).to.equal(expected);
-    });
-
-    it('should strip ordered list leaders', function () {
-      const string = 'Some text on a line\n\n9. A list Item\n10. Another list item';
-      const expected = 'Some text on a line\n\nA list Item\nAnother list item';
-      expect(removeMd(string)).to.equal(expected);
-    });
-
-    it('should strip list items with bold word in the beginning', function () {
-      const string = 'Some text on a line\n\n- **A** list Item\n- **Another** list item';
-      const expected = 'Some text on a line\n\nA list Item\nAnother list item';
-      expect(removeMd(string)).to.equal(expected);
-    });
-
-    it('should handle paragraphs with markdown', function () {
-      const paragraph = '\n## This is a heading ##\n\nThis is a paragraph with [a link](http://www.disney.com/).\n\n### This is another heading\n\nIn `Getting Started` we set up `something` foo.\n\n  * Some list\n  * With items\n    * Even indented';
-      const expected = '\nThis is a heading\n\nThis is a paragraph with a link.\n\nThis is another heading\n\nIn Getting Started we set up something foo.\n\n  Some list\n  With items\n    Even indented';
-      expect(removeMd(paragraph)).to.equal(expected);
-    });
-
-    it('should remove links', function () {
-      const string = 'This is a [link](http://www.disney.com/).';
-      const expected = 'This is a link.';
-      expect(removeMd(string)).to.equal(expected);
-    });
-
-    it('should remove links with square brackets', function () {
-      const string = 'This is a [link [with brackets]](http://www.disney.com/).';
-      const expected = 'This is a link [with brackets].';
-      expect(removeMd(string)).to.equal(expected);
-    });
-
-    it('should not strip paragraphs without content', function() {
-      const paragraph = '\n#This paragraph\n##This paragraph#';
-      const expected = paragraph;
-      expect(removeMd(paragraph)).to.equal(expected);
-    });
-
-    it('should not trigger ReDoS with atx-headers', function () {
-      const start = Date.now();
-
-      const paragraph = '\n## This is a long "'+' '.repeat(200)+'" heading ##\n';
-      const expected = /\nThis is a long " {200}" heading\n/;
-      expect(removeMd(paragraph)).to.match(expected);
-
-      const duration = Date.now()-start;
-      expect(duration).to.be.lt(1000);
-    });
-
-    it('should work fast even with lots of whitespace', function () {
-      const string = 'Some text with lots of                                                                                                                                                                                                       whitespace';
-      const expected = 'Some text with lots of                                                                                                                                                                                                       whitespace';
-      expect(removeMd(string)).to.equal(expected);
-    });
-
-    it('should still remove escaped markdown syntax', function () {
-      const string = '\# Heading in _italic_';
-      const expected = 'Heading in italic';
-      expect(removeMd(string)).to.equal(expected);
-    });
-
-    it('should skip specified HTML tags when htmlTagsToSkip option is provided', () => {
-      const markdown =
-        '<div>HTML content <sub>Superscript</sub> <span>span text</span></div>'
-      const result = removeMd(markdown, {htmlTagsToSkip: ['sub']})
-      expect(result).to.equal('HTML content <sub>Superscript</sub> span text')
-      const result2 = removeMd(markdown, {htmlTagsToSkip: ['sub', 'span']})
-      expect(result2).to.equal(
-        'HTML content <sub>Superscript</sub> <span>span text</span>',
-      )
-    })
-  });
-});