Dollar sign in file contents renders RegExp matches

[msimmer]

Dollar signs in the the file contents seem to require escaping, but seems like unintended behaviour since matches are dropped into the rendered string:

const renderLayouts = require('layouts')

const file = {
  contents: Buffer.from('<div>A $100 layout!!!</div>'),
  layout: 'one',
}

const layoutCollection = {
  one: { contents: Buffer.from('{% body %}') },
}

const res = renderLayouts(file, layoutCollection)
console.log(res.contents.toString())

yields

<div>A body00 layout!!!</div>

Escaping the dollar sign works:

const renderLayouts = require('layouts')

const file = {
  contents: Buffer.from('<div>A $$100 layout!!!</div>'),
  layout: 'one',
}

const layoutCollection = {
  one: { contents: Buffer.from('{% body %}') },
}

const res = renderLayouts(file, layoutCollection)
console.log(res.contents.toString())

Although the issue is compounded when nesting layouts, and requires multiple escape characters:

const renderLayouts = require('layouts')

const file = {
  contents: Buffer.from('<div>Wrap me with $$$$100 a layout!!!</div>'),
  layout: 'one',
}

const layoutCollection = {
  one: { contents: Buffer.from('one before\n{% body %}\none after'), layout: 'two' },
  two: { contents: Buffer.from('two before\n{% body %}\ntwo after') },
}

const res = renderLayouts(file, layoutCollection)
console.log(res.contents.toString())

will yield:

two before
one before
<div>Wrap me with $100 a layout!!!</div>
one after
two after

Is there a recommended way of dealing with this? If it's a bug I might be able to put together a PR

---

NodeJS v10.15.3
layouts@3.0.1

[doowb]

Hi @msimmer, thanks for finding this issue!

If it's a bug I might be able to put together a PR

That would be awesome! I think you can just change the following:

layouts/index.js

Line 99 in e15b448

str = Buffer.from(layoutString.replace(regex, fileString));

to

str = Buffer.from(layoutString.replace(regex, () => fileString)); 

Will you also add some unit tests? I like your examples above so tests like those would be helpful.

[msimmer]

Hey @doowb, sounds good! I'll have something done up in the next day or so.

Will you also add some unit tests? I like your examples above so tests like those would be helpful.

Yep, no problem :)