doowb / layouts

Wraps templates with layouts. Layouts can use other layouts and be nested to any depth. This can be used 100% standalone to wrap any kind of file with banners, headers or footer content. Use for markdown, HTML, handlebars views, lo-dash templates, etc. Layouts can also be vinyl files.

layouts

Wraps templates with layouts. Layouts can use other layouts and be nested to any depth. This can be used 100% standalone to wrap any kind of file with banners, headers or footer content. Use for markdown, HTML, handlebars views, lo-dash templates, etc. Layouts can also be vinyl files.

Please consider following this project's author, Brian Woodward, and consider starring the project to show your ❤️ and support.

Install

Install with npm:

$ npm install --save layouts

Usage

const renderLayouts = require('layouts');

renderLayouts(file, layoutCollection, options);

• file - a file object (or vinyl file) with a file.contents property that must be a buffer
• layoutCollection - an object of file objects to use as layouts
• options - see available options

Heads up!

This library does not clone the file object. If you want to prevent file.contents from being mutated (after rendering layouts), clone the file first before passing it to this library.

Example

const renderLayouts = require('layouts');

const file = {
  contents: Buffer.from('<div>Wrap me with 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());
// two before
// one before
// <div>Wrap me with a layout!!!</div>
// one after
// two after

Options

options.disableHistory

Type: boolean

Default: undefined

By default, layouts are prevented from being applied multiple times to the same string. Disable this by setting disableHistory to true.

Example

layouts(file, layoutCollection, { disableHistory: true });

options.layoutDelims

Custom delimiters to use for injecting contents into layouts.

Type: regex

Default: /{% (body) %}/g

options.preserveWhitespace

Preserve leading whitespace when injecting a string into a layout.

Type: boolean

Default: undefined

History

1.0.0

Breaking changes

• renames layoutHistory to layoutStack
• layouts in layoutStack are now the actual layout object, instead of the layout name

Added

• Adds support for a function as the last argument. If passed, the function is called on the file and each layout with this signature: fn(file, layout).

0.13.0

Breaking changes

• The main layouts() function now expects a file object as the first argument. This can be an object with path, layout and contents properties, or a valid vinyl file. See the API docs for more details.

0.12.0

Breaking changes

• change options.tag to options.contentTag

Housekeeping

• update tests to use assert instead of should

0.11.0

• All view objects must now have a path property, following vinyl conventions.

About

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

Running Tests

Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:

$ npm install && npm test

Building docs

(This project's readme.md is generated by verb, please don't edit the readme directly. Any changes to the readme must be made in the .verb.md readme template.)

To generate the readme, run the following command:

$ npm install -g verbose/verb#dev verb-generate-readme && verb

Related projects

You might also be interested in these projects:

• assemble: Get the rocks out of your socks! Assemble makes you fast at creating web projects… more | homepage
• templates: System for creating and managing template collections, and rendering templates with any node.js template engine… more | homepage
• verb: Documentation generator for GitHub projects. Verb is extremely powerful, easy to use, and is used… more | homepage

Contributors

Commits	Contributor
151	jonschlinkert
26	doowb

Author

Brian Woodward

• GitHub Profile
• Twitter Profile
• LinkedIn Profile

License

Copyright © 2019, Brian Woodward. Released under the MIT License.

---

This file was generated by verb-generate-readme, v0.8.0, on April 11, 2019.

layouts's Issues

Dollar sign in file contents renders RegExp matches

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
[email protected]

renderLayouts return {Object} no {String}

return

{
  options: {},
  history: {},
  result:''
}

sub-layouts not rendering with custom delims

assemble/assemble#626

topics

repository metadata is a bit outdated

Multiple blocks?

Any interest in supporting multiple blocks? Layouts with multiple named insertion points that can be extended by other layouts/templates that define content overrides for the parents' named sections.

Or does that warrant a separate module?

description

Please change description to:

Wraps templates with layouts. Layouts can use other layouts and be nested to any depth. This can be used 100% standalone to wrap any kind of file with banners, headers or footer content. Use for markdown, HTML, handlebars views, lo-dash templates, etc. Layouts can also be vinyl files.

Tests fail because of missing nyc package

It looks like npm test fails because nyc is being referenced from a global install:

$ npm test

> [email protected] test /path/to/layouts
> nyc --reporter=text --reporter=html mocha

sh: nyc: command not found
npm ERR! Test failed.  See above for more details.