remove-markdown 0.6.2 → 0.6.3

package/.claude/settings.local.json

@@ -0,0 +1,8 @@
+{
+  "permissions": {
+    "allow": [
+      "mcp__acp__Bash",
+      "mcp__acp__Write"
+    ]
+  }
+}

package/.github/workflows/default.yaml

@@ -12,7 +12,7 @@ jobs:
 
     strategy:
       matrix:
-        node-version: [14.x, 16.x, 18.x]
+        node-version: [18.x, 20.x, 22.x]
         # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
 
     steps:

package/CHANGELOG.md

@@ -0,0 +1,32 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+## [0.6.3] - 2026-01-14
+
+### Added
+
+- New `separateLinksAndTexts` option to replace inline links with text and URL separated by a custom string ([#101](https://github.com/zuchka/remove-markdown/pull/101) by [@tafel](https://github.com/tafel))
+  - Example: `removeMd('[link](http://example.com)', { separateLinksAndTexts: ': ' })` returns `'link: http://example.com'`
+
+## [0.6.2] - 2025-05-02
+
+### Fixed
+
+- Improved handling of links with square brackets inside them ([#93](https://github.com/zuchka/remove-markdown/pull/93))
+
+## [0.6.1] - 2025-05-02
+
+### Improved
+
+- Better support for multiline code blocks ([#96](https://github.com/zuchka/remove-markdown/pull/96) by [@johnjiang](https://github.com/johnjiang))
+
+## [0.6.0] - 2024-12-16
+
+### Added
+
+- `htmlTagsToSkip` option to preserve specific HTML tags while stripping others ([#88](https://github.com/zuchka/remove-markdown/pull/88))
+
+### Fixed
+
+- Horizontal rules regex pattern ([#91](https://github.com/zuchka/remove-markdown/pull/91))

package/CLAUDE.md

@@ -0,0 +1,70 @@
+# CLAUDE.md
+
+This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
+
+## Project Overview
+
+**remove-markdown** is a Node.js module that strips Markdown formatting from text, leaving only plain text. It's designed for use cases like displaying excerpts without Markdown syntax.
+
+The entire implementation is a single-file module (`index.js`) that exports one function which applies a series of regex replacements to remove various Markdown elements.
+
+## Development Commands
+
+### Running Tests
+```bash
+npm test
+```
+Runs the Mocha test suite with the spec reporter.
+
+### Running a Single Test
+To run a specific test, use Mocha's grep flag:
+```bash
+./node_modules/.bin/mocha -R spec test/remove-markdown.js --grep "test description pattern"
+```
+
+## Code Architecture
+
+### Core Structure
+- **index.js** (97 lines): Main module that exports a single function
+  - Takes markdown text and an options object as parameters
+  - Applies regex replacements in a specific order to strip Markdown syntax
+  - Returns plain text or original input if error occurs (unless `throwError` option is set)
+
+### Key Implementation Details
+
+**Regex Application Order Matters**: The order of regex replacements is critical. For example, horizontal rules must be removed before list leaders to avoid conflicts (see index.js:15).
+
+**Options System**: All options default to specific values if not provided. The module uses `options.hasOwnProperty()` checks rather than simple truthy checks to allow `false` values to be explicitly set.
+
+**Error Handling**: The entire regex processing is wrapped in try-catch. By default, errors are logged and the original markdown is returned. Set `options.throwError: true` to propagate errors.
+
+**HTML Tag Filtering**: The `htmlTagsToSkip` option dynamically builds a regex to preserve specific HTML tags while removing others (see index.js:41-49).
+
+**Link Replacement**: Two mutually exclusive link handling modes:
+- `replaceLinksWithURL: true` - replaces links with URLs (note: implementation at index.js:66 references `$2` which appears to be a bug as it should extract the URL)
+- `separateLinksAndTexts` - replaces `[text](url)` with `text<separator>url` format (applied first at index.js:52)
+
+### Test Structure
+- **test/remove-markdown.js** (258 lines): Comprehensive test suite using Mocha and Chai
+- Tests cover all markdown elements: headers, emphasis, lists, links, images, code blocks, blockquotes, HTML tags
+- Includes performance tests to prevent ReDoS vulnerabilities
+- Tests edge cases like emphasis with spaces, nested brackets, indentation
+
+## Important Considerations
+
+### When Adding Features
+- New regex patterns must be carefully positioned in the replacement chain (index.js:18-89)
+- Test edge cases thoroughly, especially patterns that could conflict with existing ones
+- Consider performance implications - some patterns are vulnerable to ReDoS if not carefully written
+
+### Known Quirks
+- The `replaceLinksWithURL` option appears to have a bug where it references `$2` but the capturing group setup may not work as intended (index.js:66)
+- Empty or invalid markdown input is handled gracefully by returning the original input
+- The module preserves code block content (including newlines) while stripping the fencing
+
+### Testing Strategy
+When modifying regex patterns:
+1. Run the full test suite first
+2. Add specific test cases for your changes
+3. Test performance with large inputs and repeated patterns
+4. Verify your changes don't break the order-dependent behavior

package/README.md

@@ -26,10 +26,14 @@ 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: [])
 });
 ```
 

package/index.d.ts

@@ -1,11 +1,12 @@
-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[];
+}): 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, '')
@@ -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,6 +1,6 @@
 {
   "name": "remove-markdown",
-  "version": "0.6.2",
+  "version": "0.6.3",
   "description": "Remove Markdown formatting from text",
   "main": "index.js",
   "scripts": {

package/test/remove-markdown.js

@@ -62,13 +62,13 @@ describe('remove Markdown', function () {
       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';
@@ -145,7 +145,7 @@ describe('remove Markdown', function () {
             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';
@@ -248,5 +248,11 @@ describe('remove Markdown', function () {
         'HTML content <sub>Superscript</sub> <span>span text</span>',
       )
     })
+
+    it('should replace inline link with text and link, with separator', function () {
+      const string = 'some [inline link](http://www.disney.com/).';
+      const expected = 'some inline link: http://www.disney.com/.';
+      expect(removeMd(string, {separateLinksAndTexts: ': '})).to.equal(expected);
+    });
   });
 });