comment-block-transformer 0.5.5 → 0.6.1

package/CHANGELOG.md

@@ -3,6 +3,44 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [0.6.1](https://github.com/DavidWells/markdown-magic/compare/comment-block-transformer@0.6.0...comment-block-transformer@0.6.1) (2026-01-19)
+
+**Note:** Version bump only for package comment-block-transformer
+
+
+
+
+
+# [0.6.0](https://github.com/DavidWells/markdown-magic/compare/comment-block-transformer@0.5.7...comment-block-transformer@0.6.0) (2026-01-19)
+
+
+### Features
+
+* **block-transformer:** add forceRemoveComments option ([7503338](https://github.com/DavidWells/markdown-magic/commit/7503338ee182a935b04e7162276fd3df072b59a9))
+
+
+
+
+
+## [0.5.7](https://github.com/DavidWells/markdown-magic/compare/comment-block-transformer@0.5.6...comment-block-transformer@0.5.7) (2026-01-19)
+
+**Note:** Version bump only for package comment-block-transformer
+
+
+
+
+
+## [0.5.6](https://github.com/DavidWells/markdown-magic/compare/comment-block-transformer@0.5.5...comment-block-transformer@0.5.6) (2026-01-19)
+
+
+### Bug Fixes
+
+* enable pattern mode for custom open tags ([904d4dc](https://github.com/DavidWells/markdown-magic/commit/904d4dc391a36848d5bb142d54835423df0b9d05))
+
+
+
+
+
 ## [0.5.5](https://github.com/DavidWells/markdown-magic/compare/comment-block-transformer@0.5.4...comment-block-transformer@0.5.5) (2026-01-19)
 
 **Note:** Version bump only for package comment-block-transformer

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "comment-block-transformer",
-  "version": "0.5.5",
+  "version": "0.6.1",
   "description": "Transform markdown blocks based on configured transforms",
   "main": "src/index.js",
   "types": "types/index.d.ts",
@@ -25,5 +25,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "3d60211919bdc910870a92270b64a7aeed5e44fc"
+  "gitHead": "e149a2e69992f108553ed3f84dc5cbd1db361987"
 }

package/src/index.js

@@ -66,6 +66,7 @@ const CLOSE_WORD = '/block'
  * @property {Array<Middleware>}  [beforeMiddleware=[]] - Middleware functions change inner block content before transforms.
  * @property {Array<Middleware>}  [afterMiddleware=[]] - Middleware functions change inner block content after transforms.
  * @property {boolean} [removeComments=false] - Remove comments from the processed contents.
+ * @property {boolean} [forceRemoveComments=false] - Force remove comments even when srcPath === outputPath, strips comments directly in updatedContents.
  * @property {string} [srcPath] - The source path.
  * @property {string} [outputPath] - The output path.
  * @property {import('comment-block-parser').CustomPatterns} [customPatterns] - Custom regex patterns for open and close tags.
@@ -98,14 +99,16 @@ async function blockTransformer(inputText, config) {
     srcPath,
     outputPath,
     open = OPEN_WORD,
-    close = CLOSE_WORD,
     syntax = SYNTAX,
     transforms = {},
     beforeMiddleware = [],
     afterMiddleware = [],
     removeComments = false,
+    forceRemoveComments = false,
     customPatterns
   } = opts
+  // Don't default close - let undefined pass through to enable pattern mode in block-parser
+  const close = opts.close !== undefined ? opts.close : (opts.open ? undefined : CLOSE_WORD)
 
   let foundBlocks = {}
   try {
@@ -284,15 +287,19 @@ async function blockTransformer(inputText, config) {
 
   const isNewPath = srcPath !== outputPath
 
-  if (removeComments && !isNewPath) {
+  if (removeComments && !isNewPath && !forceRemoveComments) {
     throw new Error('"removeComments" can only be used if "outputPath" option is set. Otherwise this will break doc generation.')
   }
 
-  const stripComments = isNewPath && removeComments
+  const stripComments = (isNewPath && removeComments) || forceRemoveComments
 
+  let finalContents = updatedContents
+  if (forceRemoveComments && openPattern && closePattern) {
+    finalContents = updatedContents.replace(openPattern, '').replace(closePattern, '')
+  }
 
   // console.log('inputText', inputText)
-  // console.log('updatedContents', updatedContents) 
+  // console.log('updatedContents', updatedContents)
   return {
     isChanged: inputText !== updatedContents,
     isNewPath,
@@ -302,7 +309,7 @@ async function blockTransformer(inputText, config) {
     transforms: transformsToRun,
     missingTransforms,
     originalContents: inputText,
-    updatedContents,
+    updatedContents: finalContents,
     patterns: regexInfo,
   }
 }

package/test/error-handling.test.js

@@ -248,4 +248,44 @@ original content
   assert.ok(result.updatedContents.includes('original content'))
 })
 
+test('forceRemoveComments bypasses safety check and strips comments from updatedContents', async () => {
+  const text = `
+<!-- block test -->
+content
+<!-- /block -->
+`
+  const result = await blockTransformer(text, {
+    srcPath: '/same/path.md',
+    outputPath: '/same/path.md',
+    forceRemoveComments: true,
+    transforms: {
+      test: (api) => 'transformed'
+    }
+  })
+
+  assert.is(result.stripComments, true)
+  assert.not.ok(result.updatedContents.includes('<!-- block'))
+  assert.not.ok(result.updatedContents.includes('<!-- /block'))
+  assert.ok(result.updatedContents.includes('transformed'))
+})
+
+test('forceRemoveComments works without outputPath', async () => {
+  const text = `
+<!-- block test -->
+content
+<!-- /block -->
+`
+  const result = await blockTransformer(text, {
+    forceRemoveComments: true,
+    transforms: {
+      test: (api) => 'transformed'
+    }
+  })
+
+  assert.is(result.stripComments, true)
+  assert.not.ok(result.updatedContents.includes('<!-- block'))
+  assert.not.ok(result.updatedContents.includes('<!-- /block'))
+  assert.ok(result.updatedContents.includes('transformed'))
+})
+
 test.run()