Lib: Logging PR Fixups

Author: mdtusz

devtools/test_dashboard/devtools.js

@@ -13,9 +13,11 @@ var Tabs = {
 
     // Set plot config options
     setPlotConfig: function() {
-
-        // use local topojson files
-        Plotly.setPlotConfig({ topojsonURL: '../../dist/topojson/' });
+        Plotly.setPlotConfig({
+            // use local topojson files
+            topojsonURL: '../../dist/topojson/',
+            logging: 2
+        });
     },
 
     // Return the specified plot container (or default one)
@@ -129,7 +131,7 @@ var Tabs = {
         var interval = setInterval(function() {
             if(window.Plotly) {
                 clearInterval(interval);
-                Tabs.setPlotConfig({ logging: 2 });
+                Tabs.setPlotConfig();
                 Tabs.onReload();
             }
         }, 100);

src/.eslintrc

@@ -10,6 +10,6 @@
   },
   "rules": {
     "strict": [2, "global"],
-    "no-console": [1]
+    "no-console": [2]
   }
 }

src/lib/index.js

@@ -12,7 +12,6 @@
 var d3 = require('d3');
 
 var lib = module.exports = {};
-var config = require('../plot_api/plot_config');
 
 lib.nestedProperty = require('./nested_property');
 lib.isPlainObject = require('./is_plain_object');
@@ -59,6 +58,11 @@ lib.extendFlat = extendModule.extendFlat;
 lib.extendDeep = extendModule.extendDeep;
 lib.extendDeepAll = extendModule.extendDeepAll;
 
+var loggersModule = require('./loggers');
+lib.log = loggersModule.log;
+lib.warn = loggersModule.warn;
+lib.error = loggersModule.error;
+
 lib.notifier = require('./notifier');
 
 /**
@@ -93,52 +97,6 @@ lib.pauseEvent = function(e) {
     return false;
 };
 
-/**
- * ------------------------------------------
- * debugging tools
- * ------------------------------------------
- */
-
-/* eslint-disable no-console */
-lib.log = function() {
-    if(config.logging > 1) {
-        var messages = ['LOG:'];
-
-        for(var i = 0; i < arguments.length; i++) {
-            messages.push(arguments[i]);
-        }
-
-        if(console.trace) {
-            console.trace.apply(console, messages);
-        } else {
-            console.log.apply(console, messages);
-        }
-    }
-};
-
-lib.warn = function() {
-    if(config.logging > 0) {
-        var messages = ['WARN:'];
-
-        for(var i = 0; i < arguments.length; i++) {
-            messages.push(arguments[i]);
-        }
-
-        if(console.trace) {
-            console.trace.apply(console, messages);
-        } else {
-            console.log.apply(console, messages);
-        }
-    }
-};
-
-lib.error = function() {
-    if(config.logging > 0) {
-        console.error.apply(console, arguments);
-    }
-};
-/* eslint-enable no-console */
-
 // constrain - restrict a number v to be between v0 and v1
 lib.constrain = function(v, v0, v1) {
     if(v0 > v1) return Math.max(v1, Math.min(v0, v));

src/lib/loggers.js

@@ -0,0 +1,59 @@
+/**
+* Copyright 2012-2016, Plotly, Inc.
+* All rights reserved.
+*
+* This source code is licensed under the MIT license found in the
+* LICENSE file in the root directory of this source tree.
+*/
+
+'use strict';
+
+var config = require('../plot_api/plot_config');
+
+var loggers = module.exports = {};
+
+/**
+ * ------------------------------------------
+ * debugging tools
+ * ------------------------------------------
+ */
+
+/* eslint-disable no-console */
+loggers.log = function() {
+    if(config.logging > 1) {
+        var messages = ['LOG:'];
+
+        for(var i = 0; i < arguments.length; i++) {
+            messages.push(arguments[i]);
+        }
+
+        if(console.trace) {
+            console.trace.apply(console, messages);
+        } else {
+            console.log.apply(console, messages);
+        }
+    }
+};
+
+loggers.warn = function() {
+    if(config.logging > 0) {
+        var messages = ['WARN:'];
+
+        for(var i = 0; i < arguments.length; i++) {
+            messages.push(arguments[i]);
+        }
+
+        if(console.trace) {
+            console.trace.apply(console, messages);
+        } else {
+            console.log.apply(console, messages);
+        }
+    }
+};
+
+loggers.error = function() {
+    if(config.logging > 0) {
+        console.error.apply(console, arguments);
+    }
+};
+/* eslint-enable no-console */

src/plot_api/plot_config.js

@@ -87,6 +87,7 @@ module.exports = {
     topojsonURL: 'https://cdn.plot.ly/',
 
     // Turn all console logging on or off (errors will be thrown)
+    // This should ONLY be set via Plotly.setPlotConfig
     logging: false
 };