initial logger

Author: nucleardreamer

README.md

@@ -1,2 +1,2 @@
-# oak-utils
+# oak-tools
 Helpful utilities for developing oak applications

index.js

@@ -0,0 +1,7 @@
+const { join } = require('path')
+
+module.exports.logger = function (opts, cb = function () {}) {
+  let logger = new (require(join(__dirname, 'lib', 'logger')))(opts)
+  cb(logger)
+  return logger
+}

lib/logger.js

@@ -0,0 +1,23 @@
+const pino = require('pino')
+
+/**
+ * Creates a logger object
+ * @param {string} [level='info'] - set the log level, default is info
+ * @param {Object} [stream=process.stdout] - outbound stream, defaults to process.stdout
+ * @param {boolean} [pretty=false] - pretty printing, defaults to false
+ * @returns {Object} - Log level methods
+ */
+function logger ({ level = 'info', stream = process.stdout, pretty = false } = {}) {
+  if (pretty) {
+    let _pretty = pino.pretty()
+    _pretty.pipe(stream)
+    stream = _pretty
+  }
+
+  let _logger = pino(stream)
+  _logger.level = level
+
+  return _logger
+}
+
+module.exports = logger

package.json

@@ -0,0 +1,38 @@
+{
+  "name": "oak-tools",
+  "version": "0.1.0",
+  "description": "Helpful utilities for developing oak applications",
+  "main": "index.js",
+  "scripts": {
+    "test": "node_modules/.bin/standard && find test/*.js | xargs -n 1 node | node_modules/.bin/tap-difflet",
+    "coverage": "node node_modules/.bin/istanbul cover node_modules/.bin/tape test/*.js || true",
+    "coveralls": "npm run-script coverage && node node_modules/.bin/coveralls < coverage/lcov.info && rm -rf coverage/ || true"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/OakLabsInc/oak-tools.git"
+  },
+  "contributors": [
+    "Flynn Joffray <nucleardreamer@gmail.com>",
+    "Nir Ziv <nir@oaklabs.is>"
+  ],
+  "keywords": [
+    "utilities",
+    "oak"
+  ],
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/OakLabsInc/oak-tools/issues"
+  },
+  "homepage": "https://github.com/OakLabsInc/oak-tools#readme",
+  "dependencies": {
+    "pino": "3.0.5"
+  },
+  "devDependencies": {
+    "coveralls": "2.11.14",
+    "istanbul": "0.4.2",
+    "standard": "8.5.0",
+    "tap-difflet": "0.4.0",
+    "tape": "4.6.0"
+  }
+}

test/logger.test.js

@@ -0,0 +1,53 @@
+process.env.NODE_ENV = 'test'
+
+const { join } = require('path')
+const Stream = require('stream')
+const async = require('async')
+const test = require('tape')
+const { logger } = require(join(__dirname, '..'))
+
+const levels = [
+  'fatal',
+  'error',
+  'warn',
+  'info',
+  'debug',
+  'trace'
+]
+
+test('*** logger', function (t) {
+  t.plan(10 + levels.length)
+  t.comment('constructor')
+  t.equal(typeof logger, 'function', 'did return construct correctly')
+
+  t.comment('parameters')
+  t.equal(typeof logger(), 'object', 'did return correctly')
+  t.equal(typeof logger({}), 'object', 'blank object parameter')
+
+  t.comment('level property')
+  let levelProp = logger({
+    level: 'info'
+  })
+  t.equal(typeof levelProp, 'object', 'did return correctly')
+  t.equal(levelProp.info.name, 'LOG', 'has level info method')
+  t.equal(levelProp.debug.name, 'noop', 'has no debug method')
+
+  t.comment('stream property')
+  let streamProp = logger({
+    stream: new Stream()
+  })
+
+  t.equal(typeof streamProp, 'object', 'did return correctly')
+  t.equal(streamProp.stream._isStdio, true, 'defaults to stdout')
+  t.equal(streamProp.stream.writable, true, 'stream is readable')
+
+  t.comment('pretty property')
+  let prettyProp = logger({ pretty: true })
+  t.equal(typeof prettyProp, 'object', 'did return correctly')
+
+  async.forEach(levels, function (level, cb) {
+    let type = logger().hasOwnProperty(level)
+    t.equal(type, true, `Should return ${level} method`)
+    cb()
+  }, t.end)
+})