feat(initial): first version

Author: Gareth Jones

lib/index.js

@@ -0,0 +1,35 @@
+
+class Logger {
+
+  log() {}
+
+  isLevelEnabled() {
+    return false;
+  }
+
+  addContext() {}
+  removeContext() {}
+  clearContext() {}
+}
+
+[ 'Trace', 'Debug', 'Info', 'Warn', 'Error', 'Fatal', 'Mark' ].forEach((level) => {
+
+  Logger.prototype[level.toLowerCase()] = () => {};
+  Logger.prototype[`is${level}Enabled`] = () => false;
+
+});
+
+const checkForLog4js = () => {
+  try {
+    return require('log4js');
+  } catch (e) {
+    return null;
+  }
+};
+
+const log4js = checkForLog4js();
+const loggerFn =  log4js ? log4js.getLogger : () => new Logger();
+
+module.exports = {
+  getLogger: loggerFn
+};

package.json

@@ -48,7 +48,7 @@
       "maxSubjectLength": 72,
       "subjectPattern": ".+",
       "subjectPatternErrorMsg": "subject does not match subject pattern!",
-      "helpMessage": "\n# allowed type: feat, fix, docs, style, refactor, example, perf, test, chore, revert\n# subject no more than 50 chars\n# a body line no more than 72 chars"
+      "helpMessage": "\n# allowed type: feat, fix, docs, style, refactor, example, perf, test, chore, revert\n# subject no more than 72 chars\n# a body line no more than 72 chars"
     }
   },
   "nyc": {

test/index.js

@@ -0,0 +1,59 @@
+const test = require('tap').test;
+const sandbox = require('sandboxed-module');
+
+test('../lib/index.js', (batch) => {
+
+  batch.test('should provide a getLogger function', (t) => {
+    const log4js = require('../lib');
+
+    t.isA(log4js.getLogger, 'function');
+    t.end();
+  });
+
+  batch.test('when log4js is not available', (t) => {
+    const log4js = require('../lib');
+    const logger = log4js.getLogger();
+
+    t.test('logger should provide dummy functions for context', (assert) => {
+      assert.isA(logger.addContext, 'function');
+      assert.isA(logger.removeContext, 'function');
+      assert.isA(logger.clearContext, 'function');
+      assert.end();
+    });
+
+    t.test('logger should always say that log levels are not enabled', (assert) => {
+      ['Trace','Debug','Info','Warn','Error','Fatal'].forEach((level) => {
+        assert.false(logger.isLevelEnabled(level));
+        assert.false(logger[`is${level}Enabled`]());
+      });
+      assert.end();
+    });
+
+    t.test('logger should provide logging functions', (assert) => {
+      assert.isA(logger.log, 'function');
+      ['trace','debug','info','warn','error', 'fatal'].forEach((level) => {
+        assert.isA(logger[level], 'function');
+      });
+      assert.end();
+    });
+
+    t.end();
+  });
+
+  batch.test('when log4js is available', (t) => {
+    const log4js = sandbox.require('../lib', {
+      requires: {
+        log4js: {
+          getLogger: () => 'cheese'
+        }
+      },
+      singleOnly: true
+    });
+    const logger = log4js.getLogger();
+
+    t.equal(logger, 'cheese');
+    t.end();
+  });
+
+  batch.end();
+});