atom-logger

Atom-Logger

Reusable logging library for Atom packages.

Getting Started

Install the module with: npm install atom-logger --save

Where my-package is your package name (settings namespace):

Logger = require "atom-logger"
# Inside your Atom package's class
logger = new Logger atom.config, "my-package"

API

Atom Logger acts as a layer on top of Winston. See the Winston documentation for more information.

Examples

Logger = require "atom-logger"
class MyPackage
  activate: () ->
    # Setup your Logger
    @logger = new Logger atom.config, "my-package"
    # Try logging with Winston!
    @logger.log 'info', "This is the message!", {"so":"meta"}

Documentation

Use Biscotto.

# Install CLI Globally
npm install -g biscotto
# Build documentation
biscotto
# Generated Documentation is in doc/ directory

Contributing

• Use CoffeeScript with CoffeeLint for CoffeeScript source code linting.
• Use NodeUnit for Unit Testing library.
• Use Biscotto's documentation notation for documentation.
• Use Grunt-Conventional-Changelog for commit message conventions.

Release History

See CHANGELOG.md.

License

Copyright (c) 2014 Glavin Wiechert.
Licensed under the MIT license.