Update property names and add performance benchmark tests

Author: DavidWells

packages/block-parser/src/index-1.js

@@ -66,8 +66,8 @@ const defaultOptions = {
 /**
  * @typedef {Object} ParseBlocksResult
  * @property {RegExp} pattern - The regex pattern used
- * @property {RegExp} COMMENT_OPEN_REGEX - Regex for open comments
- * @property {RegExp} COMMENT_CLOSE_REGEX - Regex for close comments
+ * @property {RegExp} openPattern - Regex for open comments
+ * @property {RegExp} closePattern - Regex for close comments
  * @property {BlockData[]} blocks - Array of parsed blocks
  */
 
@@ -257,10 +257,10 @@ Details:
     // Close but no single line newPattern: newGetBlockRegex({ openComment, commentClose, start: START, ending: END }),
     // pattern: regexToUse,
     pattern: newerRegex,
-    // COMMENT_OPEN_REGEX: openTagRegex,
-    // COMMENT_CLOSE_REGEX: closeTagRegex,
-    COMMENT_OPEN_REGEX: patterns.openPattern,
-    COMMENT_CLOSE_REGEX: patterns.closePattern,
+    // openPattern: openTagRegex,
+    // closePattern: closeTagRegex,
+    openPattern: patterns.openPattern,
+    closePattern: patterns.closePattern,
     blocks: newBlocks
   }
 }

packages/block-parser/test/dedent.bench.js

@@ -0,0 +1,53 @@
+const { performance } = require('perf_hooks')
+const { dedentInline } = require('./text.test')
+
+function dedentInlineManual(text) {
+  if (!text) return { minIndent: 0, text: '' }
+  const lines = text.split('\n')
+  let minIndent = null
+  for (let i = 0; i < lines.length; i++) {
+    const line = lines[i]
+    if (line.trim() === '') continue
+    let indent = 0
+    while (indent < line.length && (line[indent] === ' ' || line[indent] === '\t')) indent++
+    if (minIndent === null || indent < minIndent) minIndent = indent
+  }
+  if (minIndent === null) return { minIndent: 0, text: text.trim() }
+  
+  let result = ''
+  for (let i = 0; i < lines.length; i++) {
+    const line = lines[i]
+    let leading = 0
+    while (leading < line.length && (line[leading] === ' ' || line[leading] === '\t')) leading++
+    const toRemove = Math.min(leading, minIndent)
+    result += line.slice(toRemove) + '\n'
+  }
+  result = result.slice(0, -1) // Remove trailing newline
+  const cleanResult = result.replace(/^[\r\n]+|[\r\n]+$/g, '')
+  return { minIndent, text: cleanResult }
+}
+
+function makeTestString(lines = 10000, indent = 4) {
+  const pad = ' '.repeat(indent)
+  let out = ''
+  for (let i = 0; i < lines; i++) {
+    out += pad + 'line ' + i + '\n'
+  }
+  return out
+}
+
+const bigString = makeTestString(10000, 6)
+
+console.log('Benchmarking dedentInline (regex)...')
+let t0 = performance.now()
+for (let i = 0; i < 20; i++) dedentInline(bigString)
+let t1 = performance.now()
+console.log('dedentInline (regex) avg:', ((t1 - t0) / 20).toFixed(2), 'ms')
+
+console.log('Benchmarking dedentInlineManual (manual)...')
+t0 = performance.now()
+for (let i = 0; i < 20; i++) dedentInlineManual(bigString)
+t1 = performance.now()
+console.log('dedentInlineManual (manual) avg:', ((t1 - t0) / 20).toFixed(2), 'ms')
+
+module.exports = { dedentInlineManual } 

packages/block-parser/test/manual/_yaml-example.js

@@ -0,0 +1,55 @@
+const fs = require('fs')
+const path = require('path')
+const { parseBlocks } = require('../../src')
+const { getTextBetweenChars, getBlockText, dedentString } = require('../../src/text')
+
+const util = require('util')
+
+let DEBUG = process.argv.includes('--debug') ? true : false
+// DEBUG = true
+const logger = DEBUG ? deepLog : () => {}
+
+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 = fs.readFileSync(path.join(__dirname, '_yaml.yml'), 'utf8')
+
+const details = parseBlocks(yaml, {
+  syntax: 'yaml',
+  open: 'block',
+  close: '/block',
+})
+
+deepLog(details)
+
+const block = details.blocks
+console.log('Raw text between open and close tags')
+console.log(getTextBetweenChars(yaml, block[0].block.start, block[0].block.end))
+
+console.log('───────────────────────────────')
+console.log('Full block text')
+const getText = getBlockText(yaml, block[0].block)
+console.log(getText)
+
+console.log(getText === block[0].block.match)
+
+console.log('───────────────────────────────')
+console.log('Dedented block text')
+const dedentText = dedentString(getText)
+console.log(dedentText)

packages/block-parser/test/manual/_yaml.yml

@@ -0,0 +1,36 @@
+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
+
+      ## block remove ##
+        - name: Run tests two
+          run: npm test two
+      ## /block ##
+
+    ## block x ##
+        - name: Run tests two
+          run: npm test two
+      ## /block ##
+
+  build:
+    runs-on: ubuntu-latest
+    needs: test
+    steps:
+      - name: Build project
+        run: npm run build