Merge pull request microsoft#1818 from microsoft/octogonz/clarify-ban-types-message

octogonz · web-flow · commit 3514982ce06b · 2020-04-07T20:59:27.000-07:00
[eslint-config] Improve error message for "ban-types" rule
diff --git a/common/changes/@rushstack/eslint-config/octogonz-clarify-ban-types-message_2020-04-06-23-51.json b/common/changes/@rushstack/eslint-config/octogonz-clarify-ban-types-message_2020-04-06-23-51.json
@@ -0,0 +1,11 @@
+{
+  "changes": [
+    {
+      "packageName": "@rushstack/eslint-config",
+      "comment": "Improve the error message text for the \"ban-types\" rule",
+      "type": "patch"
+    }
+  ],
+  "packageName": "@rushstack/eslint-config",
+  "email": "4673363+octogonz@users.noreply.github.com"
+}
diff --git a/stack/eslint-config/index.js b/stack/eslint-config/index.js
@@ -56,7 +56,32 @@ module.exports = {
         // STANDARDIZED BY:   @typescript-eslint\eslint-plugin\dist\configs\recommended.json
         //
         // CONFIGURATION:     By default, these are banned: String, Boolean, Number, Object, Symbol
-        "@typescript-eslint/ban-types": "error",
+        "@typescript-eslint/ban-types": [
+          "error",
+          {          
+            types: {
+              String: {
+                message: "Use 'string' instead",
+                fixWith: "string"
+              },
+              Boolean: {
+                message: "Use 'boolean' instead",
+                fixWith: "boolean"
+              },
+              Number: {
+                message: "Use 'number' instead",
+                fixWith: "number"
+              },
+              Object: {
+                message: "Use 'object' instead, or else define a proper TypeScript type:"
+              },
+              Symbol: {
+                message: "Use 'symbol' instead",
+                fixWith: "symbol"
+              }     
+            }                  
+          }
+        ],
 
         // STANDARDIZED BY:   @typescript-eslint\eslint-plugin\dist\configs\recommended.json
         "@typescript-eslint/camelcase": [
