Skip to content

Latest commit

 

History

History
220 lines (151 loc) · 6.41 KB

readme.md

File metadata and controls

220 lines (151 loc) · 6.41 KB
Raw

Logdown

Travis CI David DM Downloads per month Slack Status

Logdown is a debug utility for the browser and the server with Markdown support. It does not have any dependencies and is only 2K gzipped.

You can see it in action in the example page or in the preview below.

Preview

Browser

Server

Using

The simplest use of the library in both platforms could be done as follows:

If on the server, install it through npm:

npm install --save logdown

In the browser you can install it through bower.

bower install logdown

You can also use the lib in the browser in the same way as in the server if you use Browserify. Or you can just download it here and put the dist/index.js file in your public folder.

// In the browser
var logger = new Logdown({prefix: 'foo'})

And then use it.

// In the server-side or client-side with Browserify
var Logdown = require('logdown')
var logger = new Logdown({prefix: 'foo'})

It is highly recommended to use a prefix for your instance, this way you get a nice prefixed message on console and it is possible to silence instances based on the prefix name, as we will see after.

After creating your object, you can use the regular log, warn, info and error methods as we have on console, but now with Markdown support.

logger.log('lorem *ipsum*')
logger.info('dolor _sit_ amet')
logger.warn('consectetur `adipiscing` elit')

You can pass multiple arguments

logger.log('lorem', '*ipsum*')
logger.info('dolor _sit_', 'amet')
logger.warn('consectetur', '`adipiscing` elit')

New objects

The constructor accepts one object for configuration on instantiation time.

opts.prefix

Type: 'String'

Default: ''

var logger = new Logdown({prefix: 'foo'})
logger.log('Lorem ipsum') // Will use console.log with a prefix

You should use the name of your module. You can, also, use : to separate modules inside one big module.

var fooBarLogger = new Logdown({prefix: 'foo:bar'})
fooBarLogger.log('Lorem ipsum')

var fooQuzLogger = new Logdown({prefix: 'foo:quz'})
fooQuzLogger.log('Lorem Ipsum')

opts.markdown

Type: 'Boolean'

Default: true

If setted to false, markdown will not be parsed.

var logger = new Logdown({markdown: false})
logger.log('Lorem *ipsum*') // Will not parse the markdown

For Markdown, the following mark-up is supported:

// Bold with "*"" between words
logger.log('lorem *ipsum*')

// Italic with "_" between words
logger.log('lorem _ipsum_')

// Code with ` (backtick) between words
logger.log('lorem `ipsum`')

Enabling/disabling instances

It is possible to enable/disable the output of instances using the Logdown.disable or Logdown.enable methods.

Logdown.disable('foo') // will disable the instance with *foo* prefix
Logdown.enable('bar') // will enable the instance with *bar* prefix

You can also use wildcards.

Logdown.enable('*') // enables all instances
Logdown.disable('*') // disables all instances
Logdown.enable('foo*') // enables all instances with a prefix starting with *foo*

Use - to do a negation.

// enables all instances but the one with *foo* prefix
Logdown.enable('*', '-foo')
// disables all intances with foo in the prefix, but don't disable *foobar*
Logdown.disable('*foo*', '-foobar')

Support

Browser

Chrome Firefox IE Opera Safari
Latest ✔ Latest ✔ 9+ ✔ Latest ✔ 8.0+ ✔

Server
0.10+ ✔

Credits

Contributors

143  Caio Gondim
  4  David Godfrey
  2  Sven Anders Robbestad
  1  Dan Lukinykh
  1  Bent Cardan
  1  Gleb Bahmutov
  1  netmml

Donating

If you found this library useful and are willing to donate, transfer some bitcoins to 1BqqKiZA8Tq43CdukdBEwCdDD42jxuX9UY or through the URL https://www.coinbase.com/caiogondim

Or via PayPal.me https://www.paypal.me/caiogondim.

License

The MIT License (MIT)

Copyright (c) 2015 Caio Gondim

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.