Merge pull request #1402 from OpenGeoscience/lint-console

manthey · web-flow · commit 6759d7e97af8 · 2025-09-10T09:06:38.000-04:00
style: Adjust linting to prohibit console messages unless deliberate
diff --git a/eslint.config.js b/eslint.config.js
@@ -91,6 +91,7 @@ module.exports = [
       'jsdoc/require-param-description': 'off',
       'jsdoc/require-returns-description': 'off',
       'jsdoc/tag-lines': 'off',
+      'no-console': 'error',
     }
   }, {
     files: ['tutorials/**', 'examples/**', 'tests/**', 'scripts/**', 'plugins/**', 'karma*.*', 'jsdoc/**'],
diff --git a/src/annotation/annotation.js b/src/annotation/annotation.js
@@ -106,7 +106,7 @@ var annotation = function (type, args) {
   if (m_id === undefined || (m_options.layer && m_options.layer.annotationById(m_id))) {
     annotationId += 1;
     if (m_id !== undefined) {
-      console.warn('Annotation id ' + m_id + ' is in use; using ' + annotationId + ' instead.');
+      console.warn('Annotation id ' + m_id + ' is in use; using ' + annotationId + ' instead.');  // eslint-disable-line no-console
     }
     m_id = annotationId;
   } else {
diff --git a/src/annotationLayer.js b/src/annotationLayer.js
@@ -1151,8 +1151,7 @@ var annotationLayer = function (arg) {
                  * selected renderer.  Issue one warning only. */
                 var key = 'error_feature_' + type;
                 if (!m_this[key]) {
-                  console.warn('Cannot create a ' + type + ' feature for ' +
-                               'annotations.');
+                  console.warn('Cannot create a ' + type + ' feature for annotations.');  // eslint-disable-line no-console
                   m_this[key] = true;
                 }
                 return;
diff --git a/src/feature.js b/src/feature.js
@@ -1039,17 +1039,17 @@ feature.create = function (layer, spec) {
 
   // Check arguments
   if (!(layer instanceof require('./layer'))) {
-    console.warn('Invalid layer');
+    console.warn('Invalid layer');  // eslint-disable-line no-console
     return null;
   }
   if (typeof spec !== 'object') {
-    console.warn('Invalid spec');
+    console.warn('Invalid spec');  // eslint-disable-line no-console
     return null;
   }
   var type = spec.type;
   var feature = layer.createFeature(type, spec);
   if (!feature) {
-    console.warn('Could not create feature type "' + type + '"');
+    console.warn('Could not create feature type "' + type + '"');  // eslint-disable-line no-console
     return null;
   }
 
diff --git a/src/featureLayer.js b/src/featureLayer.js
@@ -46,7 +46,7 @@ var featureLayer = function (arg) {
     if (newFeature) {
       m_this.addFeature(newFeature);
     } else {
-      console.warn('Layer renderer (' + m_this.rendererName() + ') does not support feature type "' + featureName + '"');
+      console.warn('Layer renderer (' + m_this.rendererName() + ') does not support feature type "' + featureName + '"');  // eslint-disable-line no-console
     }
     return newFeature;
   };
diff --git a/src/layer.js b/src/layer.js
@@ -696,13 +696,13 @@ layer.create = function (map, spec) {
   spec.renderer = checkRenderer(spec.renderer);
 
   if (!spec.renderer) {
-    console.warn('Invalid renderer');
+    console.warn('Invalid renderer');  // eslint-disable-line no-console
     return null;
   }
 
   var layer = map.createLayer(spec.type, spec);
   if (!layer) {
-    console.warn('Unable to create a layer');
+    console.warn('Unable to create a layer');  // eslint-disable-line no-console
     return null;
   }
 
diff --git a/src/map.js b/src/map.js
@@ -89,7 +89,7 @@ var map = function (arg) {
   arg = arg || {};
 
   if (arg.node === undefined || arg.node === null) {
-    console.warn('map creation requires a node');
+    console.warn('map creation requires a node');  // eslint-disable-line no-console
     return this;
   }
 
@@ -1925,7 +1925,7 @@ var map = function (arg) {
         try {
           result = result.toDataURL(type, encoderOptions);
         } catch (err) {
-          console.warn('Failed to convert screenshot to output', err);
+          console.warn('Failed to convert screenshot to output', err);  // eslint-disable-line no-console
           var failure = $.Deferred();
           failure.reject();
           return failure;
@@ -2069,7 +2069,7 @@ var map = function (arg) {
       try {
         queue[i].apply(m_this, arguments);
       } catch (err) {
-        console.error(err);
+        console.error(err);  // eslint-disable-line no-console
       }
     }
   }
@@ -2511,7 +2511,7 @@ map.create = function (spec) {
   /* If the spec is bad, we still end up with an object, but it won't have a
    * zoom function */
   if (!_map || !_map.zoom) {
-    console.warn('Could not create map.');
+    console.warn('Could not create map.');  // eslint-disable-line no-console
     return null;
   }
 
diff --git a/src/mapInteractor.js b/src/mapInteractor.js
@@ -1344,7 +1344,7 @@ var mapInteractor = function (args) {
 
     if (!m_state.action) {
       // This shouldn't happen
-      console.log('WARNING: Invalid state in mapInteractor.');
+      console.log('WARNING: Invalid state in mapInteractor.');  // eslint-disable-line no-console
       return;
     }
 
diff --git a/src/object.js b/src/object.js
@@ -144,7 +144,7 @@ var object = function () {
       return m_this;
     }
     if (!util.isFunction(handler)) {
-      console.warn('Handler for ' + event + ' is not a function', handler, m_this);
+      console.warn('Handler for ' + event + ' is not a function', handler, m_this);  // eslint-disable-line no-console
       return m_this;
     }
     if (!m_eventHandlers.hasOwnProperty(event)) {
@@ -223,7 +223,7 @@ var object = function () {
         try {
           handler.call(m_this, args);
         } catch (err) {
-          console.warn('Event handler for ' + event + ' threw an error', err);
+          console.warn('Event handler for ' + event + ' threw an error', err);  // eslint-disable-line no-console
         }
       });
     }
diff --git a/src/registry.js b/src/registry.js
@@ -103,8 +103,7 @@ registry.checkRenderer = function (name, noFallback) {
     }
     var fallback = registry.checkRenderer(ren.fallback(), true);
     if (fallback !== false) {
-      console.warn(name + ' renderer is unavailable, using ' + fallback +
-                   ' renderer instead');
+      console.warn(name + ' renderer is unavailable, using ' + fallback + ' renderer instead');  // eslint-disable-line no-console
     }
     return fallback;
   }
@@ -166,8 +165,7 @@ registry.rendererForFeatures = function (featureList) {
       return renderer;
     }
   }
-  console.warn('There is no renderer available for the feature list "' +
-               (featureList || []).join(', ') + '".');
+  console.warn('There is no renderer available for the feature list "' + (featureList || []).join(', ') + '".');  // eslint-disable-line no-console
   return false;
 };
 
@@ -197,7 +195,7 @@ registry.registerFeature = function (category, name, func, capabilities) {
 
   var old = features[category][name];
   if (old) {
-    console.warn('The ' + category + '.' + name + ' feature is already registered');
+    console.warn('The ' + category + '.' + name + ' feature is already registered');  // eslint-disable-line no-console
   }
   features[category][name] = func;
   featureCapabilities[category][name] = capabilities;
@@ -255,7 +253,7 @@ registry.registerLayerAdjustment = function (category, name, func) {
 
   var old = rendererLayerAdjustments[category][name];
   if (old) {
-    console.warn('The ' + category + '.' + name + ' layer adjustment is already registered');
+    console.warn('The ' + category + '.' + name + ' layer adjustment is already registered');  // eslint-disable-line no-console
   }
   rendererLayerAdjustments[category][name] = func;
   return old;
@@ -349,7 +347,7 @@ registry.registerWidget = function (category, name, func) {
 
   var old = widgets[category][name];
   if (old) {
-    console.warn('The ' + category + '.' + name + ' widget is already registered');
+    console.warn('The ' + category + '.' + name + ' widget is already registered');  // eslint-disable-line no-console
   }
   widgets[category][name] = func;
   return old;
@@ -397,7 +395,7 @@ registry.createWidget = function (name, layer, arg) {
 registry.registerAnnotation = function (name, func, features) {
   var old = annotations[name];
   if (old) {
-    console.warn('The ' + name + ' annotation is already registered');
+    console.warn('The ' + name + ' annotation is already registered');  // eslint-disable-line no-console
   }
   annotations[name] = {func: func, features: features || {}};
   geo_action['annotation_' + name] = 'geo_annotation_' + name;
@@ -414,7 +412,7 @@ registry.registerAnnotation = function (name, func, features) {
  */
 registry.createAnnotation = function (name, options) {
   if (!annotations[name]) {
-    console.warn('The ' + name + ' annotation is not registered');
+    console.warn('The ' + name + ' annotation is not registered');  // eslint-disable-line no-console
     return undefined;
   }
   var annotation = annotations[name].func(options);
diff --git a/src/tileLayer.js b/src/tileLayer.js
@@ -794,7 +794,7 @@ var tileLayer = function (arg) {
       }
     }
     if (m_this.cache.size < tiles.length) {
-      console.log('Increasing cache size to ' + tiles.length);
+      console.log('Increasing cache size to ' + tiles.length);  // eslint-disable-line no-console
       m_this.cache.size = tiles.length;
     }
     /* Actually get the tiles. */
@@ -1002,7 +1002,7 @@ var tileLayer = function (arg) {
     // add an error handler
     tile.catch(function () {
       // May want to do something special here later
-      console.warn('Could not load tile at ' + tile.toString());
+      console.warn('Could not load tile at ' + tile.toString());  // eslint-disable-line no-console
       m_this._remove(tile);
     });
   };
@@ -1041,7 +1041,7 @@ var tileLayer = function (arg) {
          * being used; there is still some much rarer condition that can
          * cause it.  Log that it happened until we can figure out how to fix
          * the issue. */
-        console.log('No parent element to remove ' + tile.toString(), tile);
+        console.log('No parent element to remove ' + tile.toString(), tile);  // eslint-disable-line no-console
       }
       $(tile.image).remove();
     }
diff --git a/src/transform.js b/src/transform.js
@@ -126,7 +126,7 @@ var transform = function (options) {
       result.matrix = mat;
       result.inverse = inv;
     } else {
-      console.warn('Affine transform is not invertable and will not be used: ' + value);
+      console.warn('Affine transform is not invertable and will not be used: ' + value);  // eslint-disable-line no-console
     }
     return result;
   }
@@ -260,13 +260,13 @@ var transform = function (options) {
   try {
     this.source(options.source);
   } catch (err) {
-    console.error('Can\'t use transform source: ' + options.source);
+    console.error('Can\'t use transform source: ' + options.source);  // eslint-disable-line no-console
     this.source('EPSG:4326');
   }
   try {
     this.target(options.target);
   } catch (err) {
-    console.error('Can\'t use transform target: ' + options.target);
+    console.error('Can\'t use transform target: ' + options.target);  // eslint-disable-line no-console
     this.target('EPSG:3857');
   }
 
diff --git a/src/ui/scaleWidget.js b/src/ui/scaleWidget.js
@@ -225,7 +225,7 @@ var scaleWidget = function (arg) {
     pt2 = {x: pt1.x + (vert ? 0 : pixels), y: pt1.y + (vert ? pixels : 0)};
     dist = m_options.distance(map.displayToGcs(pt1, null), map.displayToGcs(pt2, null), map.gcs()) * m_options.scale;
     if (dist <= 0 || !isFinite(dist)) {
-      console.warn('The distance calculated for the scale is invalid: ' + dist);
+      console.warn('The distance calculated for the scale is invalid: ' + dist);  // eslint-disable-line no-console
       return;
     }
     value = m_this._scaleValue(dist, pixels);
diff --git a/src/util/common.js b/src/util/common.js
@@ -1183,7 +1183,7 @@ var util = {
           canvas.toDataURL();
           m_htmlToImageSupport = true;
         } catch (err) {
-          console.warn(
+          console.warn(  // eslint-disable-line no-console
             'This browser does not support converting HTML to an image via ' +
             'SVG foreignObject.  Some functionality will be limited.', err);
           m_htmlToImageSupport = false;
@@ -1282,7 +1282,7 @@ var util = {
         $.get(href).done(function (css) {
           util.dereferenceCssUrls(css, styleElem, styleDefer, undefined, href);
         }).fail(function (xhr, status, err) {
-          console.warn('Failed to dereference ' + href, status, err);
+          console.warn('Failed to dereference ' + href, status, err);  // eslint-disable-line no-console
           styleElem.remove();
           styleDefer.resolve();
         });
@@ -1310,7 +1310,7 @@ var util = {
           defer.resolve(img);
         };
         img.onerror = function () {
-          console.warn('Failed to render html to image');
+          console.warn('Failed to render html to image');  // eslint-disable-line no-console
           defer.reject();
         };
         // Firefox requires the HTML to be base64 encoded.  Chrome doesn't, but
diff --git a/src/util/polyops.js b/src/util/polyops.js
@@ -189,7 +189,7 @@ function polygonOperationSeglist(op, epsilon, seglist) {
           segments.combined = segments.combined.filter(s => Math.abs(s.start[0] - s.end[0]) > epsilon || Math.abs(s.start[1] - s.end[1]) > epsilon);
           segments = PolyBool[op](segments);
         } else {
-          console.warn('Failed in polygon functions.');
+          console.warn('Failed in polygon functions.');  // eslint-disable-line no-console
         }
         segments.segments = segments.segments.filter(s => Math.abs(s.start[0] - s.end[0]) > epsilon || Math.abs(s.start[1] - s.end[1]) > epsilon);
       }
diff --git a/src/vgl/geomData.js b/src/vgl/geomData.js
@@ -210,7 +210,7 @@ vgl.sourceData = function (arg) {
    */
   this.setData = function (data) {
     if (!(data instanceof Array) && !(data instanceof Float32Array)) {
-      console.log('[error] Requires array');
+      console.log('[error] Requires array');  // eslint-disable-line no-console
       return;
     }
     if (data instanceof Float32Array) {
diff --git a/src/vgl/renderWindow.js b/src/vgl/renderWindow.js
@@ -154,7 +154,7 @@ vgl.renderWindow = function (canvas) {
 
     // If we don't have a GL context, give up now
     if (!m_context) {
-      console('[ERROR] Unable to initialize WebGL. Your browser may not support it.');
+      console.warn('[ERROR] Unable to initialize WebGL. Your browser may not support it.');  // eslint-disable-line no-console
     }
 
     return false;
diff --git a/src/vgl/renderer.js b/src/vgl/renderer.js
@@ -147,7 +147,6 @@ vgl.renderer = function (arg) {
       for (i = 0; i < m_this.m_renderPasses.length; i += 1) {
         if (m_this.m_renderPasses[i].render(renSt)) {
           // Stop the rendering if render pass returns false
-          console.log('returning');
           m_this.m_renderPasses[i].remove(renSt);
           return;
         }
@@ -261,8 +260,7 @@ vgl.renderer = function (arg) {
 
     // TODO move this code to camera
     if (x < 0 || y < 0 || width <= 0 || height <= 0) {
-      console.log('[error] Invalid position and resize values',
-                  x, y, width, height);
+      console.log('[error] Invalid position and resize values', x, y, width, height);  // eslint-disable-line no-console
       return;
     }
 
diff --git a/src/vgl/shader.js b/src/vgl/shader.js
@@ -107,9 +107,9 @@ vgl.shader = function (type) {
     // See if it compiled successfully
     if (!renderState.m_context.getShaderParameter(entry.shaderHandle,
                                                   vgl.GL.COMPILE_STATUS)) {
-      console.log('[ERROR] An error occurred compiling the shaders: ' +
+      console.log('[ERROR] An error occurred compiling the shaders: ' +  // eslint-disable-line no-console
                   renderState.m_context.getShaderInfoLog(entry.shaderHandle));
-      console.log(m_shaderSource);
+      console.log(m_shaderSource);  // eslint-disable-line no-console
       renderState.m_context.deleteShader(entry.shaderHandle);
       return null;
     }
diff --git a/src/vgl/shaderProgram.js b/src/vgl/shaderProgram.js
@@ -171,7 +171,7 @@ vgl.shaderProgram = function () {
     // If creating the shader program failed, alert
     if (!renderState.m_context.getProgramParameter(m_programHandle,
                                                    vgl.GL.LINK_STATUS)) {
-      console.log('[ERROR] Unable to initialize the shader program.');
+      console.log('[ERROR] Unable to initialize the shader program.');  // eslint-disable-line no-console
       return false;
     }
 
@@ -261,7 +261,7 @@ vgl.shaderProgram = function () {
 
     // link program
     if (!m_this.link(renderState)) {
-      console.log('[ERROR] Failed to link Program');
+      console.log('[ERROR] Failed to link Program');  // eslint-disable-line no-console
       m_this._cleanup(renderState);
     }
 
diff --git a/src/vgl/texture.js b/src/vgl/texture.js
@@ -72,10 +72,6 @@ vgl.texture = function () {
       this.updateDimensions();
       this.computeInternalFormatUsingImage();
 
-      // console.log('m_internalFormat ' + this.m_internalFormat);
-      // console.log('m_pixelFormat ' + this.m_pixelFormat);
-      // console.log('m_pixelDataType ' + this.m_pixelDataType);
-
       // FOR now support only 2D textures
       renderState.m_context.texImage2D(vgl.GL.TEXTURE_2D, 0, this.m_internalFormat,
                                        this.m_pixelFormat, this.m_pixelDataType, this.m_image);
diff --git a/src/vgl/viewer.js b/src/vgl/viewer.js
@@ -53,7 +53,7 @@ vgl.viewer = function (canvas, options) {
     if (m_renderWindow !== null) {
       m_renderWindow._setup();
     } else {
-      console.log('[ERROR] No render window attached');
+      console.log('[ERROR] No render window attached');  // eslint-disable-line no-console
     }
   };
 
@@ -66,7 +66,7 @@ vgl.viewer = function (canvas, options) {
     if (m_renderWindow !== null) {
       m_renderWindow._cleanup(renderState);
     } else {
-      console.log('[ERROR] No render window attached');
+      console.log('[ERROR] No render window attached');  // eslint-disable-line no-console
     }
   };
 
diff --git a/src/webgl/quadFeature.js b/src/webgl/quadFeature.js
diff --git a/src/webgl/webglRenderer.js b/src/webgl/webglRenderer.js

Original file line number	Diff line number	Diff line change
`@@ -91,6 +91,7 @@ module.exports = [`
`91`	`91`	`'jsdoc/require-param-description': 'off',`
`92`	`92`	`'jsdoc/require-returns-description': 'off',`
`93`	`93`	`'jsdoc/tag-lines': 'off',`
	`94`	`+ 'no-console': 'error',`
`94`	`95`	`}`
`95`	`96`	`}, {`
`96`	`97`	`files: ['tutorials/', 'examples/', 'tests/', 'scripts/', 'plugins/*', 'karma.', 'jsdoc/*'],`
Original file line number	Diff line number	Diff line change
`@@ -106,7 +106,7 @@ var annotation = function (type, args) {`
`106`	`106`	`if (m_id === undefined \|\| (m_options.layer && m_options.layer.annotationById(m_id))) {`
`107`	`107`	`annotationId += 1;`
`108`	`108`	`if (m_id !== undefined) {`
`109`		`- console.warn('Annotation id ' + m_id + ' is in use; using ' + annotationId + ' instead.');`
	`109`	`+ console.warn('Annotation id ' + m_id + ' is in use; using ' + annotationId + ' instead.'); // eslint-disable-line no-console`
`110`	`110`	`}`
`111`	`111`	`m_id = annotationId;`
`112`	`112`	`} else {`
Original file line number	Diff line number	Diff line change
`@@ -1039,17 +1039,17 @@ feature.create = function (layer, spec) {`
`1039`	`1039`
`1040`	`1040`	`// Check arguments`
`1041`	`1041`	`if (!(layer instanceof require('./layer'))) {`
`1042`		`- console.warn('Invalid layer');`
	`1042`	`+ console.warn('Invalid layer'); // eslint-disable-line no-console`
`1043`	`1043`	`return null;`
`1044`	`1044`	`}`
`1045`	`1045`	`if (typeof spec !== 'object') {`
`1046`		`- console.warn('Invalid spec');`
	`1046`	`+ console.warn('Invalid spec'); // eslint-disable-line no-console`
`1047`	`1047`	`return null;`
`1048`	`1048`	`}`
`1049`	`1049`	`var type = spec.type;`
`1050`	`1050`	`var feature = layer.createFeature(type, spec);`
`1051`	`1051`	`if (!feature) {`
`1052`		`- console.warn('Could not create feature type "' + type + '"');`
	`1052`	`+ console.warn('Could not create feature type "' + type + '"'); // eslint-disable-line no-console`
`1053`	`1053`	`return null;`
`1054`	`1054`	`}`
`1055`	`1055`
Original file line number	Diff line number	Diff line change
`@@ -46,7 +46,7 @@ var featureLayer = function (arg) {`
`46`	`46`	`if (newFeature) {`
`47`	`47`	`m_this.addFeature(newFeature);`
`48`	`48`	`} else {`
`49`		`- console.warn('Layer renderer (' + m_this.rendererName() + ') does not support feature type "' + featureName + '"');`
	`49`	`+ console.warn('Layer renderer (' + m_this.rendererName() + ') does not support feature type "' + featureName + '"'); // eslint-disable-line no-console`
`50`	`50`	`}`
`51`	`51`	`return newFeature;`
`52`	`52`	`};`
Original file line number	Diff line number	Diff line change
`@@ -696,13 +696,13 @@ layer.create = function (map, spec) {`
`696`	`696`	`spec.renderer = checkRenderer(spec.renderer);`
`697`	`697`
`698`	`698`	`if (!spec.renderer) {`
`699`		`- console.warn('Invalid renderer');`
	`699`	`+ console.warn('Invalid renderer'); // eslint-disable-line no-console`
`700`	`700`	`return null;`
`701`	`701`	`}`
`702`	`702`
`703`	`703`	`var layer = map.createLayer(spec.type, spec);`
`704`	`704`	`if (!layer) {`
`705`		`- console.warn('Unable to create a layer');`
	`705`	`+ console.warn('Unable to create a layer'); // eslint-disable-line no-console`
`706`	`706`	`return null;`
`707`	`707`	`}`
`708`	`708`
Original file line number	Diff line number	Diff line change
`@@ -1344,7 +1344,7 @@ var mapInteractor = function (args) {`
`1344`	`1344`
`1345`	`1345`	`if (!m_state.action) {`
`1346`	`1346`	`// This shouldn't happen`
`1347`		`- console.log('WARNING: Invalid state in mapInteractor.');`
	`1347`	`+ console.log('WARNING: Invalid state in mapInteractor.'); // eslint-disable-line no-console`
`1348`	`1348`	`return;`
`1349`	`1349`	`}`
`1350`	`1350`
Original file line number	Diff line number	Diff line change
`@@ -144,7 +144,7 @@ var object = function () {`
`144`	`144`	`return m_this;`
`145`	`145`	`}`
`146`	`146`	`if (!util.isFunction(handler)) {`
`147`		`- console.warn('Handler for ' + event + ' is not a function', handler, m_this);`
	`147`	`+ console.warn('Handler for ' + event + ' is not a function', handler, m_this); // eslint-disable-line no-console`
`148`	`148`	`return m_this;`
`149`	`149`	`}`
`150`	`150`	`if (!m_eventHandlers.hasOwnProperty(event)) {`
`@@ -223,7 +223,7 @@ var object = function () {`
`223`	`223`	`try {`
`224`	`224`	`handler.call(m_this, args);`
`225`	`225`	`} catch (err) {`
`226`		`- console.warn('Event handler for ' + event + ' threw an error', err);`
	`226`	`+ console.warn('Event handler for ' + event + ' threw an error', err); // eslint-disable-line no-console`
`227`	`227`	`}`
`228`	`228`	`});`
`229`	`229`	`}`