Add an alias log for debug, for easier migration from console.log.

Connects-To: #64
pimterry · Sep 11, 2017 · 25ef8ed · 25ef8ed
1 parent d029710
commit 25ef8ed
Show file tree

Hide file tree

Showing 4 changed files with 37 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -105,6 +105,8 @@ The loglevel API is extremely minimal. All methods are available on the root log
   * `log.warn(msg)`
   * `log.error(msg)`
 
+  `log.log(msg)` is also available, as an alias for `log.debug(msg)`, to improve compatibility with `console`, and make migration easier.
+
   Exact output formatting of these will depend on the console available in the current context of your application. For example, many environments will include a full stack trace with all trace() calls, and icons or similar to highlight other calls.
 
   These methods should never fail in any environment, even if no console object is currently available, and should always fall back to an available log method even if the specific method called (e.g. warn) isn't available.

diff --git a/lib/loglevel.js b/lib/loglevel.js
@@ -73,6 +73,9 @@
                 noop :
                 this.methodFactory(methodName, level, loggerName);
         }
+
+        // Define log.log as an alias for log.debug
+        this.log = this.debug;
     }
 
     // In old IE versions, the console isn't present until you first open it.

diff --git a/test/integration-smoke-test.js b/test/integration-smoke-test.js
@@ -10,6 +10,7 @@ define(['../lib/loglevel', 'test/test-helpers'], function(log, testHelpers) {
                 log.setLevel(log.levels.SILENT);
                 log.trace("trace");
                 log.debug("debug");
+                log.log("log");
                 log.info("info");
                 log.warn("warn");
                 log.error("error");
@@ -24,6 +25,7 @@ define(['../lib/loglevel', 'test/test-helpers'], function(log, testHelpers) {
 
                 log.trace("trace");
                 log.debug("debug");
+                log.log("log");
                 log.info("info");
                 log.warn("warn");
                 log.error("error");

diff --git a/test/level-setting-test.js b/test/level-setting-test.js
@@ -163,6 +163,36 @@ define(['../lib/loglevel'], function(log) {
                 });
             });
 
+            describe("log.log", function() {
+                it("is enabled at trace level", function() {
+                    log.setLevel(log.levels.TRACE);
+
+                    log.log("a log message");
+                    expect(console.log).toHaveBeenCalled();
+                });
+
+                it("is enabled at debug level", function() {
+                    log.setLevel(log.levels.DEBUG);
+
+                    log.log("a log message");
+                    expect(console.log).toHaveBeenCalled();
+                });
+
+                it("is disabled at info level", function() {
+                    log.setLevel(log.levels.INFO);
+
+                    log.log("a log message");
+                    expect(console.log).not.toHaveBeenCalled();
+                });
+
+                it("is disabled at silent level", function() {
+                    log.setLevel(log.levels.SILENT);
+
+                    log.log("a log message");
+                    expect(console.log).not.toHaveBeenCalled();
+                });
+            });
+
             describe("log.info", function() {
                 it("is enabled at debug level", function() {
                     log.setLevel(log.levels.DEBUG);