Basic template helpers for printing messages out to the console. Useful for debugging context in templates. Should work with any template engine.
npm install logging-helpers> Basic template helpers for printing messages out to the console. Useful for debugging context in templates. Should work with any template engine.
Install with npm:
``sh`
$ npm install --save logging-helpers
The main export is the log helper function with other helpers decorated as properties on this function. Some apps, like assemble, verb and generate support this format. However, a non-enumberalbe toObject method is exposed for registering directly with engines like handlebars
Example:
`js
var loggingHelpers = require('logging-helpers');
var hbs = require('handlebars');
hbs.registerHelper('log', helpers);
// register all of the other helpers
hbs.registerHelper(helpers.toObject);
`
Handlebars:
`handlebars`
{{log "%s" "this is a message"}}
{{info "%s" "this is a message"}}
{{warning "%s" "this is a message"}}
{{warn "%s" "this is a message"}}
{{success "%s" "this is a message"}}
{{error "%s" "this is a message"}}
{{danger "%s" "this is a message"}}
{{ok "%s" "this is a message"}}
{{bold "%s" "this is a message"}}
{{_debug this}}
{{_inspect foo.bar}}
Lo-Dash or Underscore:
`html`
<%= log("%s", "this is a message") %>
<%= info("%s", "this is a message") %>
<%= warn("%s", "this is a message") %>
<%= warning("%s", "this is a message") %>
<%= error("%s", "this is a message") %>
<%= bold("%s", "this is a message") %>
<%= _debug(data) %>
<%= _inspect(foo.bar) %>
Verb (uses lodash-style templates, but with special delimiters to avoid delimiter collision in documentation):
`js`
{%= log("%s", "this is a message") %}
{%= info("%s", "this is a message") %}
{%= bold("%s", "this is a message") %}
{%= warn("%s", "this is a message") %}
{%= error("%s", "this is a message") %}
{%= debug(data) %}
{%= inspect(foo.bar) %}
This should work with assemble, verb, generate, update or any application based on templates.
`js`
var helpers = require('logging-helpers');
var assemble = require('assemble');
var app = assemble();
app.helpers(helpers);
You can now use the helpers like this:
`handlebars`
{{log "%s" "this is a message"}}
{{info "%s" "this is a message"}}
{{warning "%s" "this is a message"}}
{{warn "%s" "this is a message"}}
{{success "%s" "this is a message"}}
{{error "%s" "this is a message"}}
{{danger "%s" "this is a message"}}
{{ok "%s" "this is a message"}}
{{bold "%s" "this is a message"}}
{{_debug this}}
{{_inspect foo.bar}}
Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.
_(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:
`sh`
$ npm install -g verbose/verb#dev verb-generate-readme && verb
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:
`sh``
$ npm install && npm test
Jon Schlinkert
* github/jonschlinkert
* twitter/jonschlinkert
Copyright © 2017, Jon Schlinkert.
Released under the MIT License.
*
_This file was generated by verb-generate-readme, v0.6.0, on June 21, 2017._