First commit

README.mdown

@@ -0,0 +1,68 @@
+## Styout
+
+A simple wrapper around [sty](https://github.com/TrevorBurnham/sty) for pretty console logging. You can set the desired verbosity level and customize the output format within a namespace.
+
+## Installation
+
+Get node and [npm](http://npmjs.org). `npm install styout`. Done.
+
+## Usage
+
+Let's say your project is named `MyProject`. Then at the top of each of your modules, add
+
+    out = (require 'styout').instance 'MyProject'
+
+Then `out` will be your project's unique `styout` instance. There are five ways of doing output:
+
+    out       'This will always show up'
+    out.debug 'This will only show up if verbosity is set to DEBUG_VERBOSITY'
+    out.info  'This will show up if verbosity is set to DEBUG_VERBOSITY or INFO_VERBOSITY'
+    out.warn  'This will show up if verbosity is anything but ERROR_VERBOSITY'
+    out.error 'This will always show up, with an attention-grabbing [ERROR] prefix'
+
+All of these use `sty.parse` internally, so you can use pseudo-HTML, e.g.
+
+<code>    out 'Our prices are &lt;b&gt;insane!&lt;/b&gt;'</code>
+
+gives you
+
+<code>    Our prices are **insane**!</code>
+
+Setting the verbosity is simple:
+
+    out.verbosity = out.DEBUG_VERBOSITY   # default is INFO_VERBOSITY
+
+By default, `debug`, `info` and `error` output is prefixed with `[DEBUG]`, `[INFO]` and `[ERROR]`. You can customize these prefixes with
+
+    out.defaultPrefix = '`out`:'
+    out.debugPrefix =   '`out.debug`:'    # defaults to '[<blue>DEBUG</blue>]'
+    out.infoPrefix =    '`out.info`:'     # defaults to '[<yellow>INFO</yellow>]'
+    out.warnPrefix =    '`out.warn`:'     # defaults to '[<red>WARNING</red>]'
+    out.errorPrefix =   '`out.error`:'    # defaults to '[<red>ERROR</red>]'
+    out.allPrefix =     'This will come before all of the above'
+
+Prefixes can also be a callback; that lets you, for instance, write your own timestamp function. Here's a simple example:
+
+    out.allPrefix = -> "#{new Date()}\t"
+
+## Copyright and license
+
+Copyright (c) 2011 Trevor Burnham and made available under the [MIT License](http://www.opensource.org/licenses/mit-license.php):
+
+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.

demo.coffee

@@ -0,0 +1,8 @@
+out = (require 'styout').instance 'styout demo'
+
+out.verbosity = out.DEBUG_VERBOSITY
+out 'This calls for <u>default</u> output!'
+out.debug 'You will only see this if you have <b>debug</b> verbosity set.'
+out.info 'But you will see this unless you are weird.'
+out.warn 'Uh-ohhhhhhhh! Relax.'
+out.error 'Everything is perfectly <green>fine</green>!'

package.json

@@ -0,0 +1,27 @@
+{
+  'name': 'styout',
+  'description': 'Simple logging with sty',
+  'keywords': ['sty', 'style', 'logging', 'console'],
+  'author': 'Trevor Burnham',
+  'email': 'trevorburnham@gmail.com',
+  'homepage': 'http://github.com/TrevorBurnham/styout',
+  'repository':
+  {
+    'type':'git',
+    'url':'http://github.com/TrevorBurnham/styout.git'
+  },
+  'licenses': [{'type': 'MIT'}],
+  'version': '0.5.1',
+  'engines': {
+    'node': '>= 0.2.0',
+    'coffee-script': '>= 0.9.6'
+  },
+  'dependencies': {
+    'sty': '>= 0.5.1',
+    'underscore': '>= 1.1.3'
+  },
+  'directories': {
+    'lib': './lib'
+  },
+  'main': './lib/styout'
+}

src/styout.coffee

@@ -0,0 +1,48 @@
+sty = require 'sty'
+_ = require 'underscore'
+
+class Styout
+
+  constructor: (@id) ->
+    @ERROR_VERBOSITY = 0
+    @WARN_VERBOSITY = 1
+    @INFO_VERBOSITY = 2
+    @DEBUG_VERBOSITY = 3
+    @verbosity = @INFO_VERBOSITY
+    @defaultPrefix = ''
+    @debugPrefix = '[<blue>DEBUG</blue>]'
+    @infoPrefix = '[<yellow>INFO</yellow>]'
+    @warnPrefix = '[<red>WARNING</red>]'
+    @errorPrefix = '[<red>ERROR</red>]'
+    @allPrefix = ''
+
+  debug: (args...) ->
+    if @verbosity >= @DEBUG_VERBOSITY
+      args.unshift @allPrefix
+      args.unshift @debugPrefix
+      out args...
+  info: (args...) ->
+    if @verbosity >= @INFO_VERBOSITY
+      args.unshift @allPrefix
+      args.unshift @infoPrefix
+      out args...
+  warn: (args...) ->
+    if @verbosity >= @WARN_VERBOSITY
+      args.unshift @allPrefix
+      args.unshift @warnPrefix
+      out args...
+  error: (args...) ->
+    if @verbosity >= @ERROR_VERBOSITY
+      args.unshift @allPrefix
+      args.unshift @errorPrefix
+      out args...
+
+out = (args...) ->
+  for o, index in args
+    args[index] = sty.parse(o) if typeof o is 'string'
+  console.log args...
+
+instances = {}
+exports.instance = (id) ->
+  return instances[id] if instances[id]
+  instances[id] = _.extend (-> out.apply this, arguments), new Styout(id)