https://github.com/helpers/logging-helpers

Basic template helpers for printing messages out to the console. Useful for debugging context in templates. Should work with any template engine.
https://github.com/helpers/logging-helpers

console error handlebars helper helpers lodash log logging success warn

Last synced: 3 months ago
JSON representation

Basic template helpers for printing messages out to the console. Useful for debugging context in templates. Should work with any template engine.

• Host: GitHub
• URL: https://github.com/helpers/logging-helpers
• Owner: helpers
• License: mit
• Created: 2014-11-11T22:44:58.000Z (about 10 years ago)
• Default Branch: master
• Last Pushed: 2018-10-24T02:30:21.000Z (about 6 years ago)
• Last Synced: 2024-04-29T17:07:20.293Z (9 months ago)
• Topics: console, error, handlebars, helper, helpers, lodash, log, logging, success, warn
• Language: JavaScript
• Size: 18.6 KB
• Stars: 12
• Watchers: 5
• Forks: 1
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# logging-helpers [![NPM version](https://img.shields.io/npm/v/logging-helpers.svg?style=flat)](https://www.npmjs.com/package/logging-helpers) [![NPM monthly downloads](https://img.shields.io/npm/dm/logging-helpers.svg?style=flat)](https://npmjs.org/package/logging-helpers) [![NPM total downloads](https://img.shields.io/npm/dt/logging-helpers.svg?style=flat)](https://npmjs.org/package/logging-helpers) [![Linux Build Status](https://img.shields.io/travis/helpers/logging-helpers.svg?style=flat&label=Travis)](https://travis-ci.org/helpers/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

Install with [npm](https://www.npmjs.com/):

```sh

$ npm install --save logging-helpers

```

## Usage

The main export is the `log` helper function with other helpers decorated as properties on this function. Some apps, like [assemble](https://github.com/assemble/assemble), [verb](https://github.com/verbose/verb) and [generate](https://github.com/generate/generate) support this format. However, a non-enumberalbe `toObject` method is exposed for registering directly with engines like [handlebars](http://www.handlebarsjs.com/)

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);

```

## Template examples

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](https://github.com/verbose/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) %}

```

## Usage with [assemble](https://github.com/assemble/assemble)

This should work with [assemble](https://github.com/assemble/assemble), [verb](https://github.com/verbose/verb), [generate](https://github.com/generate/generate), [update](https://github.com/update/update) or any application based on [templates](https://github.com/jonschlinkert/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}}

```

## About

### Contributing

Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).

### Building docs

_(This project's readme.md is generated by [verb](https://github.com/verbose/verb-generate-readme), please don't edit the readme directly. Any changes to the readme must be made in the [.verb.md](.verb.md) readme template.)_

To generate the readme, run the following command:

```sh

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

```

### 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:

```sh

$ npm install && npm test

```

### Author

**Jon Schlinkert**

* [github/jonschlinkert](https://github.com/jonschlinkert)

* [twitter/jonschlinkert](https://twitter.com/jonschlinkert)

### License

Copyright © 2017, [Jon Schlinkert](https://github.com/jonschlinkert).

Released under the [MIT License](LICENSE).

***

_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.6.0, on June 21, 2017._