npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

handlebars-converter

v1.0.2

Published

Converts handlebars code with partials or(and) layout to html.

Downloads

2

Readme

handlebars-converter

Converts handlebars code with partials or(and) layout to html.

Hypothesis

I built this package specfically because I want an easier way to generate or compile a handlebars file into html code that I could pass to my nodemailer html property without having to set up a server e.g(expressjs) basically just because I need to use handlebars as html templating engine with nodemailer.

Apart from that most handlebars packages relies on a web server to work, some implementation details are not clear enough lol.

So I need to build a simple package that helps me achieve my goal and offers the same capability as express-handlebars, but standalone, does not rely on a web server to work. IT JUST WORKS.

Installation

npm install handlebars-converter
or
yarn add handlebars-converter

Usage

Configuration

The package can be initialized with several options:

const { HandlebarsConverter } = require("handlebars-converter");

const templateConverter = new HandlebarsConverter({
  templateDirPath: "path/to/views",
});

| Options | Required | Description | | --------------- | -------- | ----------------------------- | | templateDirPath | yes | Directory path to where the template files are located. | | defaultLayoutFilePath | no | The file path of the default layout file including the file extention e.g ('./layouts/main.hbs'). | | partialDirPath | no | Directory path to where the partial files are located.| | extName | no | The handlebars file extention being use in your code. Defaults to "hbs" if not provided. |

You can initialize the package accordingly based on what options you have i.e are there partial files? Add the partialDirPath option to the constructor and provide the directory path as it value, do you have a default layout? Add the defaultLayoutFilePath option and provide the file path as a value to it. The optional fields work independent of each other. You provide what you have and you get an output of what you provide 😀.

The following example initialize the package with the all options providing the partials directory, the layout file, and an extName for of the handlebars files.

const templateConverter = new HandlebarsConverter({
  templateDirPath: "path/to/views",
  defaultLayoutFilePath: "path/to/layouts/main.hbs",
  partialDirPath: "path/to/partials",
  extName: "hbs",
});

Generating the html code

Use the compile() method available on the templateConverter class instance created earlier to generate an html output, it returns a promise so we need to use await keyword.

const generatedHtml = await templateConverter.compile({
  templateName: "filename",

  // any data you want to pass into the template(s)
  context: {},
});

| Options | Required | Description | | --------------- | -------- | ----------------------------- | | templateName | yes | Name of the handlebars template file e.g(index.hbs), index is the templateName | | context | no | An object containing data you want to inject into the template(s) |

Example

The template file

./views/index.hbs

  <p>This is a test paragraph.</p>

Note Please make sure your layout file includes the {{{body}}} within your body tag to inject the template else your template won't show.

The layout file

./views/layouts/main.hbs

<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="UTF-8">
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
  <title>{{title}}</title>
  <style>
    p {
      color: tomato;
    }
  </style>
</head>
<body>
  {{> header}}
    {{{body}}}
  {{> footer}}
</body>
</html>

Header partial file

./views/partials/header.hbs

<h1>This a test header.</h1>

Footer partial file

./views/partials/footer.hbs

<h1>Copyright &copy; sdk package Inc {{year}}</h1>
const path = require("path");
const { HandlebarsConverter } = require("handlebars-converter");

const templateConverter = new HandlebarsConverter({
  templateDirPath: path.join(__dirname, "views"), //required
  defaultLayoutFilePath: path.join(__dirname, "views", "layouts", "main.hbs"),
  partialDirPath: path.join(__dirname, "views", "partials"),
  extName: "hbs"
});

async function generateHtml(filename) {
  const generatedHtml = await templateConverter.compile({
    templateName: filename,

    //any data you want to pass into the template(s)
    context: {
      year: new Date().getFullYear(),
      title: "Testing package"
    }
  });

  return generatedHtml; 
}

// would return a compiled html code with all the template data injected
generateHtml("index"); 

I tested the code using http server, i generated the html code and passed the output to be rendered to the client. Screenshot below:

Screen shot of the above implementation result

Check out the example code implementation here.

How can I thank you?

Star the Github repo. I'd love the attention! Why not share the link for this repository on Twitter, Thread or HackerNews? Spread the word📢!

Don't forget to follow me on Twitter and on Thread. Let's chat.

Issues

Please use the issues tab on Github to create issues you encountered or feature you would love to see included in this awesome package.

Thank You!

Please freely reach out to me on the above channels. Thanks for using my package.