markdown-magic 2.6.1 → 3.0.1

package/lib/utils/md/fixtures/file-with-links.md

@@ -0,0 +1,153 @@
+---
+title: Welcome to ABC
+description: 'Lorem ipsum dolor sit amet, consectetur adipiscing elit.'
+date: '2020-06-30'
+thumbnail: https://dope-frontmatter.com/img/deploy/button.svg
+components:
+  - type: PageHeading
+    heading: Nice
+    subHeading: Add it
+  - type: content
+    content: >-
+      Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur
+
+      <a href="https://funky-frontmatter.com">funky</a>
+
+      <img src='/img/in-nested-frontmatter/button.svg' />
+
+      ![The San Juan Mountains are beautiful!](/assets/images/lol-frontmatter.jpg)
+
+      <img src='https://frontmatter.com/img/deploy/button.svg' />
+
+      we've created a [detailed blog post](https://www.front.com/blog/open-beta-changes) to help those with the migration process. We're confident these changes, once released, will make for a significantly better experience for current and future users.
+categories:
+  - company
+authors:
+  - Bob Bob
+  - Joe Smoe
+---
+
+**Welcome to ABC!** Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur [keynote presentation](https://youtu.be/A1bL4pHuivU).
+
+<img src='/img/deploy/button.svg' />
+
+<img src='./img/deploy/button.svg' />
+
+<img src='../img/deploy/button.svg' />
+
+<img src="https://www.netlify.com/img/deploy/button.svg" />
+
+<img src="https://www.netlify.com/img/deploy/button.svg" />
+
+<img src='https://fooo.com/img/deploy/button.svg' />
+
+![The San Juan Mountains are beautiful!](/assets/images/lol.jpg)
+
+![The San Juan Mountains are beautiful!](assets/images/san-juan-mountains.jpg)
+
+![](https://res.cloudinary.com/ABC/image/upload/f_auto,q_auto/c_fill,w_1200/v1668114635/what-you-can-build_p8uape.png)
+
+![](https://avatars2.githubusercontent.com/u/532272?v=3&s=400)
+
+This is the weird markdown link syntax <https://foooooooooooo.com>
+
+this is less than sign
+
+Hear Bob Bobster discuss the evolution of Serverless and the launch of ABC at the AWS Serverless Community Day.
+
+<iframe width="560" height="315" src="https://www.youtube.com/embed/KX7tj3giizI" frameBorder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowFullScreen></iframe>
+
+<a href="https://app.netlify.com/start/deploy">
+  <img src="/img/deploy/button.svg">
+</a>
+
+<a href="/foobar">
+  <img src="/img/deploy/button.svg">
+</a>
+
+
+<a href="https://www.yoursite.com/pricing?utm_source=active%20users&utm_medium=email&utm_campaign=feature%20launch&utm_content=bottom%20cta%20button">
+  Utm params link
+</a>
+
+
+Title xyz
+============================
+
+Sed ut perspiciatis unde omnis iste natus error sit voluptatem accusantium doloremque laudantium, totam rem aperiam, eaque ipsa quae ab illo inventore veritatis et quasi architecto beatae vitae dicta sunt explicabo. Nemo enim ipsam voluptatem quia voluptas sit aspernatur aut odit aut fugit, sed quia consequuntur magni dolores eos qui ratione voluptatem sequi nesciunt. Neque porro quisquam est, qui dolorem ipsum quia dolor sit amet, consectetur, adipisci velit, sed quia non numquam eius modi tempora incidunt ut labore et dolore magnam aliquam quaerat voluptatem
+
+Sed ut perspiciatis unde omnis iste natus error sit voluptatem accusantium doloremque laudantium, totam rem aperiam, eaque ipsa quae ab illo inventore veritatis et quasi architecto beatae vitae dicta sunt explicabo. Nemo enim ipsam voluptatem quia voluptas sit aspernatur aut odit aut fugit, sed quia consequuntur magni dolores eos qui ratione voluptatem sequi nesciunt. Neque porro quisquam est, qui dolorem ipsum quia dolor sit amet, consectetur, adipisci velit, sed quia non numquam eius modi tempora incidunt ut labore et dolore magnam aliquam quaerat voluptatem
+
+Legacy Alternatives
+===================
+
+It vero eos et accusamus et iusto odio dignissimos ducimus qui blanditiis praesentium voluptatum deleniti atque corrupti quos dolores et quas molestias excepturi sint occaecati cupiditate non provident, similique sunt in culpa qui officia deserunt mollitia animi, id est laborum et dolorum fuga. Et harum quidem rerum facilis est et expedita distinctio. Nam libero tempore, cum soluta nobis est eligendi optio cumque nihil impedit quo minus id 
+
+Escaping the "Single Box" Blockchain Limitation
+===============================================
+
+Sed ut perspiciatis unde omnis iste natus error sit voluptatem accusantium doloremque laudantium, totam rem aperiam, eaque ipsa quae ab illo inventore veritatis et quasi architecto beatae vitae dicta sunt explicabo. Nemo enim ipsam voluptatem quia voluptas sit aspernatur aut odit aut fugit, sed quia consequuntur magni dolores eos qui ratione voluptatem sequi nesciunt. Neque porro quisquam est, qui dolorem ipsum quia dolor sit amet, consectetur, adipisci velit, sed quia non numquam eius modi tempora incidunt ut labore et dolore magnam aliquam quaerat voluptatem.
+
+<Author foo='bar' foo='bing'>
+  <Child />
+</Author>
+
+```graphql
+mutation _files__add($input: ABC_File_Input_!, $syncMode: ABC_SyncMode = NODE_COMMITTED)
+```
+
+To override the default, include the `syncMode` option as such:
+
+```js
+/* Hello there */
+const response = await entities.product.add(
+  {
+    name: 'super-widget',
+    inventory: 100,
+  },
+  {
+    syncMode: 'ASYNC',    <-- example syncMode instruction
+  }
+);
+
+console.log(response?.transaction?.transactionId);
+console.log(response?.transaction?._id);
+```
+
+Title xyz
+===========================
+
+At vero eos et accusamus et iusto odio dignissimos ducimus qui blanditiis praesentium voluptatum deleniti atque corrupti quos dolores et quas molestias excepturi sint occaecati cupiditate non provident, similique sunt in culpa qui officia deserunt mollitia animi, id est laborum et dolorum fuga. Et harum quidem rerum facilis est et expedita distinctio. Nam libero tempore, cum soluta nobis est eligendi optio cumque nihil impedit quo minus id quod maxime placeat facere possimus, omnis voluptas assumenda est, omnis dolor repellendus. Temporibus autem quibusdam et aut officiis debitis aut rerum necessitatibus saepe eveniet ut et voluptates repudiandae sint et molestiae non recusandae. Itaque earum rerum hic tenetur a sapiente delectus, ut aut reiciendis voluptatibus maiores alias consequatur aut perferendis doloribus asperiores repellat
+
+At vero eos et accusamus et iusto odio dignissimos ducimus qui blanditiis praesentium voluptatum deleniti atque corrupti quos dolores et quas molestias excepturi sint occaecati cupiditate non provident, similique sunt in culpa qui officia deserunt mollitia animi, id est laborum et dolorum fuga. Et harum quidem rerum facilis est et expedita distinctio. Nam libero tempore, cum soluta nobis est eligendi optio cumque nihil impedit quo minus id quod maxime placeat facere possimus, omnis voluptas assumenda est, omnis dolor repellendus. Temporibus autem quibusdam et aut officiis debitis aut rerum necessitatibus saepe eveniet ut et voluptates repudiandae sint et molestiae non recusandae. Itaque earum rerum hic tenetur a sapiente delectus, ut aut reiciendis voluptatibus maiores alias consequatur aut perferendis doloribus asperiores repellat
+
+<!-- doc-gen {{functionName}} foo={{ rad: 'yellow' }} -->
+xyz
+<!-- end-doc-gen -->
+
+Hello title
+=======================
+
+At vero eos et accusamus et iusto odio dignissimos ducimus qui blanditiis praesentium voluptatum deleniti atque corrupti quos dolores et quas molestias excepturi sint occaecati cupiditate non provident, similique sunt in culpa qui officia deserunt mollitia animi, id est laborum et dolorum fuga. Et harum quidem rerum facilis est et expedita distinctio. Nam libero tempore, cum soluta nobis est eligendi optio cumque nihil impedit quo minus id quod maxime placeat facere possimus, omnis voluptas assumenda est, omnis dolor repellendus. Temporibus autem quibusdam et aut officiis debitis aut rerum necessitatibus saepe eveniet ut et voluptates repudiandae sint et molestiae non recusandae. Itaque earum rerum hic tenetur a sapiente delectus, ut aut reiciendis voluptatibus maiores alias consequatur aut perferendis doloribus asperiores repellat remaining confident that their solutions will work on _any_ public cloud, not just a single vendor. Interested in experiencing it for yourself? [Sign up](https://ABC.com/sign-up) to join our preview access program, starting in late July.
+
+
+<!-- doc-gen {{functionName}} 
+  foo={{ rad: 'yellow' }}
+  baz=bar
+  fun=['array']
+-->
+xyz
+<!-- end-doc-gen -->
+
+
+We’re excited to be on this journey to help customers solve some of their greatest challenges by making code and data easier to share, protect, and secure. **Welcome to ABC and welcome to a new era of sharing made easy!**
+
+<Author 
+  arr={['one', 'two']}
+  foo={{ "bar": true }}
+  baz='string' 
+/>
+
+_Bob & Joe_
+
+_Looking for your next great opportunity?_ [_We’re hiring!_](http://jobs.ABC.net)

package/lib/utils/md/md.test.js

@@ -0,0 +1,105 @@
+const fs = require('fs')
+const path = require('path')
+const { test } = require('uvu')
+const assert = require('uvu/assert')
+const { deepLog } = require('../logs')
+const { parseMarkdown } = require('./parse')
+const { findLinks } = require('./find-links')
+const { parseFrontmatter } = require('./find-frontmatter')
+
+const FILE_PATH = path.join(__dirname, 'fixtures/file-with-links.md')
+// const FILE_PATH = path.join(__dirname, 'fixtures/2022-01-22-date-in-filename.md')
+const fileContents = fs.readFileSync(FILE_PATH, 'utf-8')
+
+test('parseMarkdown API', async () => {
+  const res = parseMarkdown(fileContents, { filePath: FILE_PATH })
+  assert.is(typeof res, 'object')
+  assert.is(typeof res.ast, 'object')
+  assert.is(typeof res.data, 'object')
+  assert.is(typeof res.content, 'string')
+  assert.is(typeof res.codeBlocks, 'object')
+  assert.is(Array.isArray(res.errors), true)
+})
+
+test('Verify contents', async () => {
+  const res = parseMarkdown(fileContents, { 
+    filePath: FILE_PATH 
+  })
+  deepLog('Results:', res)
+  assert.equal(res.links, [
+    'https://funky-frontmatter.com',
+    'https://www.front.com/blog/open-beta-changes',
+    'https://youtu.be/A1bL4pHuivU',
+    'https://foooooooooooo.com',
+    'https://www.youtube.com/embed/KX7tj3giizI',
+    'https://app.netlify.com/start/deploy',
+    'https://www.yoursite.com/pricing?utm_source=active%20users&utm_medium=email&utm_campaign=feature%20launch&utm_content=bottom%20cta%20button',
+    'https://ABC.com/sign-up',
+    'http://jobs.ABC.net',
+    '/foobar'
+  ])
+  assert.equal(res.images, [
+    '/assets/images/lol-frontmatter.jpg',
+    '/assets/images/lol.jpg',
+    'assets/images/san-juan-mountains.jpg',
+    'https://res.cloudinary.com/ABC/image/upload/f_auto,q_auto/c_fill,w_1200/v1668114635/what-you-can-build_p8uape.png',
+    'https://avatars2.githubusercontent.com/u/532272?v=3&s=400',
+    'https://dope-frontmatter.com/img/deploy/button.svg',
+    'https://frontmatter.com/img/deploy/button.svg',
+    '/img/in-nested-frontmatter/button.svg',
+    'https://www.netlify.com/img/deploy/button.svg',
+    'https://fooo.com/img/deploy/button.svg',
+    '/img/deploy/button.svg',
+    'img/deploy/button.svg',
+    '../img/deploy/button.svg'
+  ])
+})
+
+test('opts - includeAst false', async () => {
+  const res = parseMarkdown(fileContents, { 
+    filePath: FILE_PATH,
+  })
+  // deepLog('Results:', res)
+  assert.ok(Array.isArray(res.ast))
+  /* Disable AST */
+  const resTwo = parseMarkdown(fileContents, { 
+    filePath: FILE_PATH,
+    includeAst: false,
+  })
+  // deepLog('Results two:', resTwo)
+  assert.ok(typeof resTwo.ast === 'undefined')
+})
+
+test('opts - includeImages false', async () => {
+  const res = parseMarkdown(fileContents, { 
+    filePath: FILE_PATH,
+    // includeAst: false,
+    includeImages: false,
+  })
+  deepLog('Results:', res)
+  assert.ok(typeof res.links === 'object')
+  assert.ok(typeof res.images === 'undefined')
+})
+
+test('opts - includeLinks false', async () => {
+  const res = parseMarkdown(fileContents, { 
+    filePath: FILE_PATH,
+    includeLinks: false,
+  })
+  deepLog('Results:', res)
+  assert.ok(typeof res.links === 'undefined')
+  assert.ok(typeof res.images === 'object')
+})
+
+// test('File have correct extensions', async () => {
+//   const { data } = parseFrontmatter(fileWithLinks, FILE_PATH)
+//   console.log('frontmatter data', data)
+//   const links = findLinks(fileWithLinks, { frontmatter: data })
+//   // console.log('links', links)
+//   // console.log('FILE_PATH', FILE_PATH)
+//   // console.log('parseMarkdown')
+//   // const x = parseMarkdown(fileWithLinks, { filePath: FILE_PATH })
+//   // deepLog(x)
+// })
+
+test.run()

package/lib/utils/md/parse.js

@@ -0,0 +1,146 @@
+const { parse } = require('micro-mdx-parser')
+const { parseFrontmatter } = require('./find-frontmatter')
+const { findUnmatchedHtmlTags } = require('./find-unmatched-html-tags')
+const { findLinks } = require('./find-links')
+const { findDate } = require('./find-date')
+const { findCodeBlocks, REMOVE_CODE_BLOCK_REGEX } = require('./find-code-blocks')
+const { getLineCount } = require('./utils')
+
+function parseMarkdown(text, opts = {}) {
+  const { 
+    filePath,
+    validator,
+    astParser,
+    includeAst = true,
+    includeLinks = true,
+    includeImages = true,
+    includeCodeBlocks = true,
+    includePositions = false,
+    includeRawFrontmatter = false,
+  } = opts
+  let errors = []
+  let result = {}
+  let alreadySetError = false
+  try {
+    result = parseFrontmatter(text)
+  } catch (err) {
+    console.log(`Broken frontmatter in ${filePath}...`)
+    errors.push(err.message)
+    alreadySetError = true
+  }
+  const { data, content = '', frontMatterRaw = '' } = result
+  if (!data || !Object.keys(data).length) {
+    if (!alreadySetError) {
+      errors.push(`Missing or broken frontmatter in ${filePath}. Double check file for --- frontmatter tags`)
+    }
+  }
+
+  let links
+  let images
+  if (includeLinks || includeImages) {
+    const linkData = findLinks(text, {
+      frontmatter: data
+    })
+    links = linkData.links
+    images = linkData.images
+  }
+
+  let ast = []
+  if (includeAst) {
+    /* If custom parser supplied */
+    if (astParser) {
+      ast = astParser(content, opts)
+    } else {
+      /* Default parser */
+      ast = parse(content, {
+        includePositions,
+        // offset: {
+        //   lineOffset: getLineCount(frontMatterRaw),
+        //   charOffset: frontMatterRaw.length 
+        // }
+      })
+    }
+  }
+
+  // console.log('html', html)
+  // console.log(`htmlTags ${filePath}`, htmlTags)
+  let codeBlocks
+  if (includeCodeBlocks) {
+    codeBlocks = findCodeBlocks(text, { filePath, includePositions })
+  }
+
+  // console.log(`codeBlocks ${filePath}`, codeBlocks)
+  const tagsErrors = findUnmatchedHtmlTags(text, filePath)
+
+  // const htmlValidationTags = validateHtmlTags(htmlTags, filePath)
+  // if (htmlValidationTags && htmlValidationTags.length) {
+  //   errors = errors.concat(htmlValidationTags)
+  // }
+
+  let htmlValidation = []
+  if (typeof validator === 'function') {
+    // const contentsNoCodeBlocks = content.replace(REMOVE_CODE_BLOCK_REGEX, '')
+    htmlValidation = validator(content, filePath)
+  }
+
+  if (htmlValidation && htmlValidation.length) {
+    // console.log('htmlValidation', htmlValidation)
+    errors = errors.concat(htmlValidation)
+  }
+
+  if (tagsErrors && tagsErrors.length) {
+    errors = errors.concat(tagsErrors)
+  }
+
+  if (codeBlocks.errors && codeBlocks.errors.length) {
+    errors = errors.concat(codeBlocks.errors)
+  }
+
+  const frontmatter = data || {}
+  const date = findDate({
+    frontmatter,
+    filePath
+  })
+
+  const parseResult = {}
+
+  if (filePath) {
+    parseResult.filePath = filePath
+  }
+
+  if (date) {
+    parseResult.date = date
+  }
+
+  if (includeAst) {
+    parseResult.ast = ast
+  }
+
+  /* Include frontmatter as data object */
+  parseResult.data = frontmatter
+
+  if (includeRawFrontmatter) {
+    parseResult.frontMatterRaw = frontMatterRaw
+  }
+
+  if (includeLinks) {
+    parseResult.links = links
+  }
+
+  if (includeImages) {
+    parseResult.images = images
+  }
+
+  if (includeCodeBlocks) {
+    parseResult.codeBlocks = codeBlocks.blocks
+  }
+
+  parseResult.content = content
+  parseResult.errors = errors
+
+  return parseResult
+}
+
+module.exports = {
+  parseMarkdown
+}

package/lib/utils/md/utils.js

@@ -0,0 +1,19 @@
+
+
+function getLineNumberFromMatch(text = '', matches) {
+  return getLineCount(text.substr(0, matches.index))
+}
+
+function getLines(str = '') {
+  return str.split(/\r\n|\r|\n/)
+}
+
+function getLineCount(str = '') {
+  return getLines(str).length
+}
+
+module.exports = {
+  getLines,
+  getLineCount,
+  getLineNumberFromMatch
+}

package/lib/utils/regex-timeout.js

@@ -0,0 +1,84 @@
+// https://stackoverflow.com/questions/38859506/cancel-regex-match-if-timeout
+const util = require('util')
+const vm = require('vm')
+const { getBlockRegex } = require('../block-parser')
+const { getSyntaxInfo } = require('./syntax')
+
+const goodString = `
+# Test Fixture
+
+This is normal text in markdown. <!-- doc-start (wordCount) -->x<!-- doc-end -->
+ Keep it.
+
+<!-- doc-start (wordCount) -->
+THIS CONTENT GETS AUTO GENERATED. Don't directly edit it
+<!-- doc-end -->
+
+This is normal text in markdown. Keep it.
+`
+
+const badString = `
+# Test Fixture
+
+This is normal text in markdown. <!-- doc-start (wordCount) -->x<!-- oc-end -->
+ Keep it.
+
+<!-- doc-start (wordCount) -->
+THIS CONTENT GETS AUTO GENERATED. Don't directly edit it
+<!-- xoc-end -->
+
+This is normal text in markdown. Keep it.
+`
+
+// var pattern = /([ \t]*)(?:<!-{2,}(?:.*|\r?|\n?|\s*)docs-start\s*([(\[\{]*[A-Za-z0-9_$-]*[)\]\}]*)\s*)((?:.*?|.*?\r?\n?)*?)<!-{2,}(?:.*|\r?|\n?|\s*)docs-end(?:.|\r?\n)*?-{2,}>/gim
+
+function safeRegex(str) {
+  const syntax = 'md'
+  const syntaxInfo = getSyntaxInfo(syntax)
+  if (!syntaxInfo.pattern) {
+    throw new Error(`Unknown syntax "${syntax}"`)
+  }
+  const [ openComment, closeComment ] = syntaxInfo.pattern
+  const pattern = getBlockRegex({
+    openComment,
+    closeComment,
+    openText: 'doc-start',
+    closeText: 'doc-end'
+  })
+  console.log('Pattern', pattern)
+  const sandbox = {
+    // regex: /([ \t]*)(?:<!-{2,}(?:.*|\r?|\n?|\s*)docs-start\s*([(\[\{]*[A-Za-z0-9_$-]*[)\]\}]*)\s*)((?:.*?|.*?\r?\n?)*?)<!-{2,}(?:.*|\r?|\n?|\s*)docs-end(?:.|\r?\n)*?-{2,}>/gim,
+    regexToUse: pattern,
+    string: str,
+    //string: badStringTwo,
+    //string: string,
+  }
+
+  const context = vm.createContext(sandbox)
+  console.log('Sandbox initialized: ' + vm.isContext(sandbox))
+  // var script = new vm.Script('result = regex.exec(string)');
+  const script = new vm.Script(`
+    blocks = []
+    rawMatches = string.match(regexToUse)
+    while ((list = regexToUse.exec(string)) !== null) {
+      const [ block, spaces, __type, params ] = list
+      blocks.push({
+        __type,
+        block
+      })
+      if (list.index === regexToUse.lastIndex) regexToUse.lastIndex++
+    }
+  `);
+  try {
+    // One could argue if a RegExp hasn't processed in a given time.
+    // then, its likely it will take exponential time.
+    script.runInContext(context, { timeout: 1000 }); // milliseconds
+  } catch (e) {
+    console.log('ReDos occurred', e); // Take some remedial action here...
+  }
+  console.log('result:')
+  console.log(util.inspect(sandbox)); // Check the results
+}
+
+// safeRegex(goodString)
+safeRegex(badString)

package/lib/utils/regex.js

@@ -1,19 +1,35 @@
 
-module.exports.matchCommentBlock = function(word) {
+// REGEX to look for regex
+// https://github.com/kgryte/regex-regex/blob/master/lib/index.js
+const REGEX_REGEX = /^\/((?:\\\/|[^\/])+)\/([imgy]*)$/
+const LINEBREAK_MATCHER = /\r\n|[\r\n\u2028\u2029]/;
+
+function escapeRegexString(string) {
+	if (typeof string !== 'string') {
+		throw new TypeError('Expected a string')
+	}
+	// Escape characters with special meaning either inside or outside character sets.
+	// Use a simple backslash escape when it’s always valid, and a `\xnn` escape when the simpler form would be disallowed by Unicode patterns’ stricter grammar.
+	return string
+		.replace(/[|\\{}()[\]^$+*?.]/g, '\\$&')
+		.replace(/-/g, '\\x2d');
+}
+
+function matchCommentBlock(word) {
   //return new RegExp(`(?:\\<\\!--(?:.|\\r?\\n)*?${matchWord}:START(?:.|\\r?\\n)*?\\()(.*)\\)(?:.|\\r?\\n)*?<!--(?:.|\\r?\\n)*?${matchWord}:END(?:.|\\r?\\n)*?--\\>`, 'g')
   return new RegExp(`(.*)(?:\\<\\!--(?:.*|\r?|\n?|\s*)${word}:START(?:.|\\r?\\n)*?\\()(.*)\\)(?:.|\\r?\\n)*?<!--(?:.*|\r?|\n?|\s*)${word}:END(?:.|\\r?\\n)*?--\\>`, 'g')
 }
 
-module.exports.matchOpeningCommentTag = function (word) {
+function matchOpeningCommentTag(word) {
   // return new RegExp(`(\\<\\!--(?:.|\\r?\\n)*?${matchWord}:START)((?:.|\\r?\\n)*?--\\>)`, 'g')
   return new RegExp(`(\\<\\!--(?:.*|\r?|\n?|\s*)${word}:START)((?:.|\\r?\\n)*?--\\>)`, 'g')
 }
 
-module.exports.matchClosingCommentTag = function (word) {
+function matchClosingCommentTag(word) {
   return new RegExp(`--\\>(?:.|\\r?\\n)*?((?:\\<\\!--(?:.*|\\r?\\n)(?:.*|\\r?\\n))*?${word}:END)((?:.|\\r?\\n)*?--\\>)`, 'g')
 }
 
-module.exports.removeLeadingAndTrailingLineBreaks = /^(?:[\t ]*(?:\r?\n|\r))+|\s+$/g
+const removeLeadingAndTrailingLineBreaks = /^(?:[\t ]*(?:\r?\n|\r))+|\s+$/g
 
 const jsRegex = /\/\* Step([\s\S]*?)\*\//g
 const ymlRegex = / *?# Step([\s\S]*?) #\n*?/g
@@ -39,7 +55,7 @@ function cleanStepMatches(matches) {
 /**
  * Match comment steps in files
  */
-function getSteps() {
+function getSteps(matches) {
   const steps = cleanStepMatches(matches)
 
   const sortedSteps = steps.reduce((accumulator, currentValue, currentIndex, array) => {
@@ -56,6 +72,15 @@ function getSteps() {
   })
 }
 
+/*
+Alt attribute regex https://regex101.com/r/Ughcb7/1
+const attrNameRegex = "[a-z0-9_]+";
+const attrValueRegex = '(\\\\"|[^"])*';
+const attrRegex = `(${attrNameRegex})\\s*=\\s*"(${attrValueRegex})"`;
+const keyValue = new RegExp(attrRegex, "gi");
+*/
+
+
 // Regex to remove all comment blocks
 const REMOVE_COMMENTS_REGEX = / *?\<\!-- ([\s\S]*?) ?--\>\n\n*?/g
 // content.replace(removeComments, '')
@@ -73,4 +98,13 @@ const TABEL_ROW_REGEX = /^\s*\|.*?\|\s*$/
  * @param {string} text  The text to validate.
  * @returns {boolean}
  */
-const isTableRow = (text) => text.match(TABEL_ROW_REGEX);
+const isTableRow = (text) => Boolean(text.match(TABEL_ROW_REGEX))
+
+module.exports = {
+  REGEX_REGEX,
+  escapeRegexString,
+  matchCommentBlock,
+  matchOpeningCommentTag,
+  matchClosingCommentTag,
+  removeLeadingAndTrailingLineBreaks,
+}

package/lib/utils/remoteRequest.js

@@ -3,6 +3,7 @@ const request = require('sync-request')
 module.exports = function remoteRequest(url) {
   let body
   try {
+    // @ts-expect-error
     const res = request('GET', url)
     body = res.getBody('utf8')
   } catch (e) {
@@ -11,3 +12,57 @@ module.exports = function remoteRequest(url) {
   }
   return body
 }
+
+/*
+TODO add file caching?
+*/
+// const path = require('path')
+// const cacheManager = require('cache-manager')
+// const fsStoreHash = require('cache-manager-fs-hash')
+// const CACHE_KEY = 'foo'
+// const STORAGE_PATH = (process.env.IS_OFFLINE) ? path.join(__dirname, '../tmp') : '/tmp'
+// const SECONDS = 60
+// const MINUTES = 60
+// const ONE_HOUR = SECONDS * MINUTES
+// const mbOfStorage = 512
+// /* initialize caching on disk */
+// const diskCache = cacheManager.caching({
+//   store: fsStoreHash,
+//   options: {
+//     /* TTL in seconds */
+//     ttl: ONE_HOUR,
+//     /* max size in bytes on disk */
+//     // maxsize: mbOfStorage * 1000 * 1000,
+//     path: STORAGE_PATH,
+//   }
+// })
+
+// async function usage() {
+//   const hasCache = await diskCache.get(CACHE_KEY)
+//   if (hasCache && hasCache.length) {
+//     /* If cache NOT empty return it */
+//     // console.log('Using cached value', hasCache)
+//     return hasCache
+//   }
+//   // else do fetch
+//   const data = await getStuff()
+//   // Then save cache
+//   console.log('Saving value')
+//   await diskCache.set(CACHE_KEY, data)
+// }
+
+// function getCacheSize(filePath) {
+//   return new Promise((resolve, reject) => {
+//     fs.stat(filePath, (err, stats) => {
+//       if (err) {
+//         return resolve({ sizeInBytes: 0, sizeInMB: 0 })
+//       }
+//       const byteSize = stats.size
+//       const megaByteSize = byteSize / (1024 * 1024)
+//       return resolve({
+//         sizeInBytes: byteSize,
+//         sizeInMB: megaByteSize
+//       })
+//     })
+//   })
+// }