@partiellkorrekt/parcel-transformer-handlebars
v1.0.5
Published
Handlebars Tranformer Plugin for Parcel
Downloads
155
Readme
Handlebars plugin for Parcel 2
This plugin allows Parcel 2 to load and compile Handlebars templates. It was heavily inspired by native-finance/parcel-plugin-handlebars, which only works for Parcel 1 and aims to be a drop-in-replacement if you want to switch to Parcel 2.
Installation
Install with yarn:
yarn add @partiellkorrekt/parcel-transformer-handlebarsInstall with npm:
npm install --save @partiellkorrekt/parcel-transformer-handlebarsThen activete the plugin for .hbs and .handlebars files by adding transformers to your .parcelrc:
{
"extends": "@parcel/config-default",
"transformers": {
"*.{hbs,handlebars}": ["@partiellkorrekt/parcel-transformer-handlebars"]
}
}(For reference see: https://parceljs.org/features/plugins/#transformers)
Configuration
The plugin has the following config defaults. These are required for handlebars to map all dependencies for compiling handlebars templates.
{
"data": "src/markup/data",
"decorators": "src/markup/decorators",
"helpers": "src/markup/helpers",
"layouts": "src/markup/layouts",
"partials": "src/markup/partials"
}Custom Configuration
If you would like to enforce your own folder structure simply create handlebars.config.json or hbs.config.json in your project root. Each property of the configuration file is optional and can also take an array of paths instead of just one path. If a property is not set, it will be taken from the defaulf configuration.
{
"data": "views/json",
"decorators": "views/decorators",
"helpers": "views/tools",
"layouts": "views/templates",
"partials": "views/partials"
}If you want, you can also use js instead of json.
module.exports = {
data: 'views/json',
decorators: 'views/decorators',
helpers: 'views/tools',
layouts: 'views/templates',
partials: 'views/partials'
}Features
frontmatter
The plugin has built in support for frontmatter yaml. Processed yaml data will be passed into the templates before compilation. frontmatter yaml data will preferably be at the top of the template file such as the following example:
Source - example.hbs
---
title: This is a heading
desc: this is a paragraph
names:
- bob
- jane
- mark
---
{{!< mainlayout}}
<h1>{{title}}</h1>
<p>{{desc}}</p>
<ul>
{{#each names}}
<li>{{this}}</li>
{{/each}}
</ul>Output - example.html
<html>
<body>
<h1>This is a heading</h1>
<p>this is a paragraph</p>
<ul>
<li>bob</li>
<li>jane</li>
<li>mark</li>
</ul>
</body>
</html>Handlebars Layouts
The plugin has built in support for handlebars-layouts.
Handlebars Helpers
The plugin is also including all helpers found in the npm package handlebars-helpers. Please refer to their documentation for example usages.
Environment Variables
During compililation the plugin will also pass the following variable(s) to the template:
- NODE_ENV
This can be useful when you want specific code to show up on production builds.
{{#eq NODE_ENV "production"}}
<!-- Google Tag Manager -->
<script>(function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start':
new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0],
j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src=
'https://www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f);
})(window,document,'script','dataLayer','GTM-XXXX');</script>
<!-- End Google Tag Manager -->
{{/eq}}Or perhaps the opposite
{{#isnt NODE_ENV "production"}}
<span class="dev-banner sticky full">
You're in DEVELOPMENT mode
</span>
{{/isnt}}