Improve error handling - add more details to errors (#1347)

Author: ethanshar

eslint-rules/lib/rules/assets-deprecation.js

@@ -4,9 +4,12 @@ const {
   getLocalizedFix,
   addToImports,
   getComponentLocalName,
-  getComponentName
+  getComponentName,
+  handleError
 } = require('../utils');
 
+const RULE_ID = 'assets-deprecation';
+
 const MAP_SCHEMA = {
   type: 'object',
   additionalProperties: true
@@ -41,7 +44,7 @@ module.exports = {
           }
         });
       } catch (err) {
-        console.log('Found error in: ', context.getFilename());
+        handleError(RULE_ID, err, context.getFilename());
       }
     }
 

eslint-rules/lib/rules/component-deprecation.js

@@ -1,6 +1,7 @@
 const _ = require('lodash');
-const {addToImports, organizeDeprecations, getComponentLocalName, getPossibleDeprecations} = require('../utils');
+const {addToImports, organizeDeprecations, getComponentLocalName, getPossibleDeprecations, handleError} = require('../utils');
 
+const RULE_ID = 'component-deprecation';
 const MAP_SCHEMA = {
   type: 'object',
   additionalProperties: true
@@ -35,7 +36,7 @@ module.exports = {
           }
         });
       } catch (err) {
-        console.log('Found error in: ', context.getFilename());
+        handleError(RULE_ID, err, context.getFilename());
       }
     }
 

eslint-rules/lib/rules/component-prop-deprecation.js

@@ -6,9 +6,11 @@ const {
   getComponentLocalName,
   getComponentName,
   getPossibleDeprecations,
-  findValueNodeOfIdentifier
+  findValueNodeOfIdentifier,
+  handleError
 } = require('../utils');
 
+const RULE_ID = 'component-prop-deprecation';
 const MAP_SCHEMA = {
   type: 'object',
   properties: {
@@ -79,7 +81,7 @@ module.exports = {
           }
         });
       } catch (err) {
-        console.log('Found error in: ', context.getFilename());
+        handleError(RULE_ID, err, context.getFilename());
       }
     }
 
@@ -91,7 +93,7 @@ module.exports = {
           message
         });
       } catch (err) {
-        console.log('Found error in: ', context.getFilename());
+        handleError(RULE_ID, err, context.getFilename());
       }
     }
 

eslint-rules/lib/rules/function-deprecation.js

@@ -1,5 +1,7 @@
 const _ = require("lodash");
+const {handleError} = require('../utils');
 
+const RULE_ID = 'function-deprecation';
 const MAP_SCHEMA = {
   type: "object",
   additionalProperties: true,
@@ -89,7 +91,7 @@ module.exports = {
           },
         });
       } catch (err) {
-        console.log("Found error in: ", err, context.getFilename());
+        handleError(RULE_ID, err, context.getFilename());
       }
     }
 

eslint-rules/lib/rules/no-direct-import.js

@@ -1,3 +1,6 @@
+const {handleError} = require('../utils');
+
+const RULE_ID = 'no-direct-import';
 const MAP_SCHEMA = {
   type: 'object',
   properties: {
@@ -47,7 +50,7 @@ module.exports = {
           },
         });
       } catch (err) {
-        console.log('Found error in: ', context.getFilename());
+        handleError(RULE_ID, err, context.getFilename());
       }
     }
 

eslint-rules/lib/rules/no-hard-coded-color.js

@@ -1,6 +1,7 @@
 const _ = require('lodash');
-const {findAndReportHardCodedValues} = require('../utils');
+const {findAndReportHardCodedValues, handleError} = require('../utils');
 
+const RULE_ID = 'no-hard-coded-color';
 const MAP_SCHEMA = {
   type: 'object',
   additionalProperties: true
@@ -49,7 +50,7 @@ module.exports = {
           });
         }
       } catch (err) {
-        console.log('Found error in: ', context.getFilename());
+        handleError(RULE_ID, err, context.getFilename());
       }
     }
 

eslint-rules/lib/rules/prop-value-shape-deprecation.js

@@ -5,9 +5,11 @@ const {
   findValueNodeOfIdentifier,
   getComponentLocalName,
   addToImports,
-  getComponentName
+  getComponentName,
+  handleError
 } = require('../utils');
 
+const RULE_ID = 'prop-value-shape-deprecation';
 const MAP_SCHEMA = {
   type: 'object',
   properties: {
@@ -90,7 +92,7 @@ module.exports = {
           }
         });
       } catch (err) {
-        console.log('Found error in: ', context.getFilename());
+        handleError(RULE_ID, err, context.getFilename());
       }
     }
 

eslint-rules/lib/rules/typography-deprecation.js

@@ -4,9 +4,11 @@ const {
   getLocalizedFix,
   addToImports,
   getComponentLocalName,
-  getComponentName
+  getComponentName,
+  handleError
 } = require('../utils');
 
+const RULE_ID = 'typography-deprecation';
 const MAP_SCHEMA = {
   type: 'object',
   additionalProperties: true
@@ -44,7 +46,7 @@ module.exports = {
           }
         });
       } catch (err) {
-        console.log('Found error in: ', context.getFilename());
+        handleError(RULE_ID, err, context.getFilename());
       }
     }
 

eslint-rules/lib/utils/generalUtils.js

@@ -38,9 +38,14 @@ function findValueNodeOfIdentifier(identifierName, scope) {
   return valueNode || findValueNodeOfIdentifier(identifierName, scope.upper);
 }
 
+function handleError(ruleId, error, fileName) {
+  console.log(`Found error in rule: ${ruleId}\n`, `Error: ${error}\n`, `In file: ${fileName}`);
+}
+
 
 module.exports = {
   getPrefix,
   getSuffix,
-  findValueNodeOfIdentifier
+  findValueNodeOfIdentifier,
+  handleError
 };

eslint-rules/lib/utils/index.js

@@ -1,4 +1,4 @@
-const {getPrefix, getSuffix, findValueNodeOfIdentifier} = require('./generalUtils');
+const {getPrefix, getSuffix, findValueNodeOfIdentifier, handleError} = require('./generalUtils');
 const {organizeDeprecations, getLocalizedFix, getPossibleDeprecations} = require('./deprecationsUtils');
 const {addToImports} = require('./importUtils');
 const {getComponentLocalName, getComponentName} = require('./componentUtils');
@@ -10,6 +10,7 @@ module.exports = {
   getPrefix,
   getSuffix,
   findValueNodeOfIdentifier,
+  handleError,
   // Deprecations
   organizeDeprecations,
   getLocalizedFix,

eslint-rules/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-uilib",
-  "version": "2.0.6",
+  "version": "2.0.7",
   "description": "uilib set of eslint rules",
   "keywords": [
     "eslint",