comment-block-transformer 0.1.1 → 0.2.0

package/CHANGELOG.md

@@ -0,0 +1,17 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
+
+# 0.2.0 (2025-10-25)
+
+
+### Bug Fixes
+
+* exclude manual test directory from test runner ([f2e9b1a](https://github.com/DavidWells/markdown-magic/commit/f2e9b1ad0754cfd7f797ed3b09a3df622675525f)), closes [#105](https://github.com/DavidWells/markdown-magic/issues/105)
+
+
+### Features
+
+* add comprehensive tests for block-transformer with multiple plugins and middleware ([1c7df35](https://github.com/DavidWells/markdown-magic/commit/1c7df357a41933e98d3da377277829b6b628c76b)), closes [#86](https://github.com/DavidWells/markdown-magic/issues/86)
+* setup pnpm workspace with proper dependency linking ([0c8c2f9](https://github.com/DavidWells/markdown-magic/commit/0c8c2f9e10e11918f0e446e1793878825ec88c14)), closes [#88](https://github.com/DavidWells/markdown-magic/issues/88)

package/package.json

@@ -1,11 +1,21 @@
 {
   "name": "comment-block-transformer",
-  "version": "0.1.1",
+  "version": "0.2.0",
   "description": "Transform markdown blocks based on configured transforms",
   "main": "src/index.js",
   "types": "types/index.d.ts",
+  "scripts": {
+    "test": "uvu test '.test.([mc]js|[jt]sx?)$'",
+    "build": "pnpm run types",
+    "types": "tsc --emitDeclarationOnly --outDir types",
+    "clean": "rimraf types",
+    "publish": "git push origin && git push origin --tags",
+    "release:patch": "pnpm run build && pnpm version patch && pnpm publish",
+    "release:minor": "pnpm run build && pnpm version minor && pnpm publish",
+    "release:major": "pnpm run build && pnpm version major && pnpm publish"
+  },
   "dependencies": {
-    "comment-block-parser": "1.0.7"
+    "comment-block-parser": "1.1.0"
   },
   "devDependencies": {
     "typescript": "^5.0.0",
@@ -14,13 +24,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "scripts": {
-    "test": "uvu test",
-    "build": "pnpm run types",
-    "types": "tsc --emitDeclarationOnly --outDir types",
-    "clean": "rimraf types",
-    "release:patch": "pnpm run build && pnpm version patch && pnpm publish",
-    "release:minor": "pnpm run build && pnpm version minor && pnpm publish",
-    "release:major": "pnpm run build && pnpm version major && pnpm publish"
-  }
-}
+  "gitHead": "546a15fac58d28315057449adf122a5ab8575901"
+}

package/src/index.js

@@ -121,7 +121,7 @@ async function blockTransformer(inputText, config) {
   }
 
 
-  const { COMMENT_OPEN_REGEX, COMMENT_CLOSE_REGEX } = foundBlocks
+  const { openPattern, closePattern } = foundBlocks
 
 
   const blocksWithTransforms = foundBlocks.blocks
@@ -136,8 +136,8 @@ async function blockTransformer(inputText, config) {
 
   const regexInfo = {
     blocks: foundBlocks.pattern,
-    open: COMMENT_OPEN_REGEX,
-    close: COMMENT_CLOSE_REGEX,
+    open: openPattern,
+    close: closePattern,
   }
 
   const transformsToRun = sortTransforms(blocksWithTransforms, transforms)
@@ -211,6 +211,8 @@ async function blockTransformer(inputText, config) {
     }
 
     let newContent = afterContent.content.value
+
+    // console.log("afterContent.content.rawValue", afterContent.content.rawValue)
     /* handle different cases of typeof newContent. @TODO: make this an option */
     if (typeof newContent === 'number') {
       newContent = String(newContent)
@@ -220,14 +222,28 @@ async function blockTransformer(inputText, config) {
       newContent = JSON.stringify(newContent, null, 2)
     }
 
-    const formattedNewContent = (options.noTrim) ? newContent : trimString(newContent)
-    const fix = removeConflictingComments(formattedNewContent, COMMENT_OPEN_REGEX, COMMENT_CLOSE_REGEX)
+    // console.log('options', options)
+    // console.log('newContent', `"${newContent}"`)
+
+    const formattedNewContent = (options.noTrim) ? newContent : newContent
+    // const formattedNewContent = newContent//.trim()
+    // console.log('formattedNewContent', `"${formattedNewContent}"`)
+    const fix = removeConflictingComments(formattedNewContent, openPattern, closePattern)
+
+    // console.log('fix', `"${fix}"`)
 
     let preserveIndent = 0
-    if (match.content.indentation) {
-      preserveIndent = match.content.indentation.length
+    // console.log('match.content.indent', match.content.indent)
+    if (match.content.indent) {
+      preserveIndent = match.content.indent
+      // console.log('preserveIndent', preserveIndent)
     } else if (preserveIndent === 0) {
-      preserveIndent = block.indentation.length
+      preserveIndent = block.indent
+    }
+
+    // Don't apply indentation for single-line content when original was also single-line
+    if (!context.isMultiline && !block.match.includes('\n')) {
+      preserveIndent = 0
     }
 
     let addTrailingNewline = ''
@@ -259,6 +275,9 @@ async function blockTransformer(inputText, config) {
 
   const stripComments = isNewPath && removeComments
 
+
+  // console.log('inputText', inputText)
+  // console.log('updatedContents', updatedContents) 
   return {
     isChanged: inputText !== updatedContents,
     isNewPath,
@@ -300,7 +319,7 @@ function getDetails({
   }
 
   if (srcPath) {
-    const location = getCodeLocation(srcPath, foundBlock.block.lines[0])
+    const location = getCodeLocation(srcPath, foundBlock.lines[0])
     foundBlock.sourceLocation = location
   }
   return foundBlock
@@ -387,10 +406,30 @@ function trimString(str) {
   return str.trim()
 }
 
+/**
+ * Trim leading and trailing lines from a string
+ * @param {string} str - The string to trim
+ * @returns {string} The string with leading and trailing lines removed
+ */
+function trimLeadingAndTrailing(str) {
+  if (!str) return str
+  return str.replace(/^\s*\n+/, '').replace(/\n+\s*$/, '')
+}
+
 function getCodeLocation(srcPath, line, column = '0') {
   return `${srcPath}:${line}:${column}`
 }
 
+if (require.main === module) {
+  const yaml = `
+  - name: Run tests two
+    run: npm test two
+  `
+
+  // console.log(indentString(yaml, 4))
+}
+
 module.exports = {
-  blockTransformer
+  blockTransformer,
+  indentString,
 } 

package/test/manual/_run.js

@@ -0,0 +1,90 @@
+const core = require('@actions/core')
+const github = require('@actions/github')
+
+async function main() {
+  const context = github.context
+
+  let issueNumber, prNumber, headRef, baseRef, headSha, isPR = false;
+  let triggerText = '';
+
+  if (context.eventName === 'pull_request_target') {
+    // When a PR is created or updated
+    isPR = true;
+    issueNumber = context.payload.pull_request.number;
+    prNumber = context.payload.pull_request.number;
+    headRef = context.payload.pull_request.head.ref;
+    baseRef = context.payload.pull_request.base.ref;
+    headSha = context.payload.pull_request.head.sha;
+    triggerText = context.payload.pull_request.body;
+    
+    console.log(`PR #${prNumber}: ${baseRef} <- ${headRef} (${headSha})`);
+    
+  } else if (context.eventName === 'issues') {
+    // When an Issue is created or assigned
+    isPR = false;
+    issueNumber = context.payload.issue.number;
+    triggerText = `${context.payload.issue.title} ${context.payload.issue.body}`;
+    
+    console.log(`Issue #${issueNumber} created`);
+    
+  } else if (context.eventName === 'issue_comment') {
+    // Issue/PR comment
+    issueNumber = context.payload.issue.number;
+    triggerText = context.payload.comment.body;
+    
+    if (context.payload.issue.pull_request) {
+      // Comment on a PR
+      isPR = true;
+      try {
+        const pr = await github.rest.pulls.get({
+          owner: context.repo.owner,
+          repo: context.repo.repo,
+          pull_number: issueNumber
+        });
+        prNumber = issueNumber;
+        headRef = pr.data.head.ref;
+        baseRef = pr.data.base.ref;
+        headSha = pr.data.head.sha;
+        
+        console.log(`PR Comment #${prNumber}: ${baseRef} <- ${headRef}`);
+      } catch (error) {
+        console.error('Error fetching PR info:', error);
+        // In case of error, treat as a regular Issue
+        isPR = false;
+      }
+    } else {
+      // Regular Issue comment
+      isPR = false;
+      console.log(`Issue Comment #${issueNumber}`);
+    }
+    
+  } else if (context.eventName === 'pull_request_review_comment' || context.eventName === 'pull_request_review') {
+    // PR review related
+    isPR = true;
+    issueNumber = context.payload.pull_request.number;
+    prNumber = context.payload.pull_request.number;
+    headRef = context.payload.pull_request.head.ref;
+    baseRef = context.payload.pull_request.base.ref;
+    headSha = context.payload.pull_request.head.sha;
+    
+    if (context.eventName === 'pull_request_review_comment') {
+      triggerText = context.payload.comment.body;
+    } else {
+      triggerText = context.payload.review.body;
+    }
+    
+    console.log(`PR Review #${prNumber}: ${baseRef} <- ${headRef}`);
+  }
+
+  // Set outputs
+  core.setOutput('issue-number', issueNumber);
+  core.setOutput('pr-number', prNumber || '');
+  core.setOutput('head-ref', headRef || '');
+  core.setOutput('base-ref', baseRef || '');
+  core.setOutput('head-sha', headSha || '');
+  core.setOutput('is-pr', isPR);
+  core.setOutput('trigger-text', triggerText);
+
+  console.log(`Final Context: Issue #${issueNumber}, isPR: ${isPR}, Event: ${context.eventName}`);
+
+}

package/test/manual/_test.yml

@@ -0,0 +1,2 @@
+- name: New thing
+  run: npm test four

package/test/manual/_yaml-example.js

@@ -0,0 +1,85 @@
+const { blockTransformer, indentString } = require('../../src')
+const fs = require('fs')
+const path = require('path')
+const util = require('util')
+
+function logValue(value, isFirst, isLast) {
+  const prefix = `${isFirst ? '> ' : ''}`
+  if (typeof value === 'object') {
+    console.log(`${util.inspect(value, false, null, true)}\n`)
+    return
+  }
+  if (isFirst) {
+    console.log(`\n\x1b[33m${prefix}${value}\x1b[0m`)
+    return
+  }
+  console.log((typeof value === 'string' && value.includes('\n')) ? `\`${value}\`` : value)
+  // isLast && console.log(`\x1b[37m\x1b[1m${'─'.repeat(94)}\x1b[0m\n`)
+}
+
+function deepLog() {
+  for (let i = 0; i < arguments.length; i++) logValue(arguments[i], i === 0, i === arguments.length - 1)
+}
+
+const yaml = `
+name: Test Workflow
+description: A simple test workflow for testing purposes
+version: 1.0.0
+
+on:
+  push:
+    branches: [main, develop]
+  pull_request:
+    branches: [main]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+      
+      - name: Run tests
+        run: npm test
+
+      ## include file src="_test.yml" ##
+      - name: Run tests two
+        run: npm test two
+      ## /include ##
+
+      ## include js src="_run.js" ##
+      - name: Run tests two
+        run: npm test two
+      ## /include ##
+
+  build:
+    runs-on: ubuntu-latest
+    needs: test
+    steps:
+      - name: Build project
+        run: npm run build
+`
+
+blockTransformer(yaml, {
+  syntax: 'yaml',
+  open: 'include',
+  close: '/include',
+  transforms: {
+    file: ({ content, options }) => {
+      const { src } = options
+      const blockContent = fs.readFileSync(path.join(__dirname, src), 'utf8')
+      return blockContent
+    },
+    js: (api) => {
+      console.log('api', api)
+      const { content, options } = api
+      console.log('XYZ', content)
+      const jsContent = fs.readFileSync(path.join(__dirname, options.src), 'utf8')
+      return `
+- name: Run tests two
+  run: |
+${indentString(jsContent, 4)}
+`
+    }
+  }
+}).then(deepLog)