Add error message

YuichiNukiyama · YuichiNukiyama · commit 806e142cbf24 · 2016-08-20T12:36:57.000+09:00
Add error message when trying to relate primitives to the boxed/apparent
backing types.
diff --git a/src/compiler/checker.ts b/src/compiler/checker.ts
@@ -6258,13 +6258,20 @@ namespace ts {
                     targetType = typeToString(target, /*enclosingDeclaration*/ undefined, TypeFormatFlags.UseFullyQualifiedType);
                 }
 
+                // check if trying to relate primitives to the boxed/apparent backing types.
+                if ((sourceType === "Number" && targetType === "number") ||
+                    (sourceType === "String" && targetType === "string") ||
+                    (sourceType === "Boolean" && targetType === "boolean")) {
+                        reportError(Diagnostics._0_is_a_primitive_type_while_1_is_a_boxed_object_Prefer_using_0_when_possible, targetType, sourceType);
+                }
+
                 if (!message) {
                     message = relation === comparableRelation ?
                         Diagnostics.Type_0_is_not_comparable_to_type_1 :
                         Diagnostics.Type_0_is_not_assignable_to_type_1;
                 }
 
-                reportError(message, sourceType, targetType);
+                reportError(message, sourceType, targetType);               
             }
 
             // Compare two types and return
diff --git a/src/compiler/diagnosticMessages.json b/src/compiler/diagnosticMessages.json
@@ -1955,6 +1955,10 @@
         "category": "Error",
         "code": 2691
     },
+    "'{0}' is a primitive type while '{1}' is a boxed object. Prefer using '{0}' when possible.": {
+        "category": "Error",
+        "code": 2692
+    },
     "Import declaration '{0}' is using private name '{1}'.": {
         "category": "Error",
         "code": 4000
diff --git a/tests/baselines/reference/apparentTypeSubtyping.errors.txt b/tests/baselines/reference/apparentTypeSubtyping.errors.txt
@@ -1,6 +1,7 @@
 tests/cases/conformance/types/typeRelationships/apparentType/apparentTypeSubtyping.ts(9,7): error TS2415: Class 'Derived<U>' incorrectly extends base class 'Base<string>'.
   Types of property 'x' are incompatible.
     Type 'String' is not assignable to type 'string'.
+      'string' is a primitive type while 'String' is a boxed object. Prefer using 'string' when possible.
 
 
 ==== tests/cases/conformance/types/typeRelationships/apparentType/apparentTypeSubtyping.ts (1 errors) ====
@@ -17,6 +18,7 @@ tests/cases/conformance/types/typeRelationships/apparentType/apparentTypeSubtypi
 !!! error TS2415: Class 'Derived<U>' incorrectly extends base class 'Base<string>'.
 !!! error TS2415:   Types of property 'x' are incompatible.
 !!! error TS2415:     Type 'String' is not assignable to type 'string'.
+!!! error TS2415:       'string' is a primitive type while 'String' is a boxed object. Prefer using 'string' when possible.
         x: String;
     }
     
diff --git a/tests/baselines/reference/apparentTypeSupertype.errors.txt b/tests/baselines/reference/apparentTypeSupertype.errors.txt
@@ -2,6 +2,7 @@ tests/cases/conformance/types/typeRelationships/apparentType/apparentTypeSuperty
   Types of property 'x' are incompatible.
     Type 'U' is not assignable to type 'string'.
       Type 'String' is not assignable to type 'string'.
+        'string' is a primitive type while 'String' is a boxed object. Prefer using 'string' when possible.
 
 
 ==== tests/cases/conformance/types/typeRelationships/apparentType/apparentTypeSupertype.ts (1 errors) ====
@@ -19,5 +20,6 @@ tests/cases/conformance/types/typeRelationships/apparentType/apparentTypeSuperty
 !!! error TS2415:   Types of property 'x' are incompatible.
 !!! error TS2415:     Type 'U' is not assignable to type 'string'.
 !!! error TS2415:       Type 'String' is not assignable to type 'string'.
+!!! error TS2415:         'string' is a primitive type while 'String' is a boxed object. Prefer using 'string' when possible.
         x: U;
     }
diff --git a/tests/baselines/reference/arrayLiterals3.errors.txt b/tests/baselines/reference/arrayLiterals3.errors.txt
@@ -18,6 +18,7 @@ tests/cases/conformance/expressions/arrayLiterals/arrayLiterals3.ts(34,5): error
       Types of parameters 'items' and 'items' are incompatible.
         Type 'Number' is not assignable to type 'string | number'.
           Type 'Number' is not assignable to type 'number'.
+            'number' is a primitive type while 'Number' is a boxed object. Prefer using 'number' when possible.
 
 
 ==== tests/cases/conformance/expressions/arrayLiterals/arrayLiterals3.ts (6 errors) ====
@@ -81,4 +82,5 @@ tests/cases/conformance/expressions/arrayLiterals/arrayLiterals3.ts(34,5): error
 !!! error TS2322:       Types of parameters 'items' and 'items' are incompatible.
 !!! error TS2322:         Type 'Number' is not assignable to type 'string | number'.
 !!! error TS2322:           Type 'Number' is not assignable to type 'number'.
+!!! error TS2322:             'number' is a primitive type while 'Number' is a boxed object. Prefer using 'number' when possible.
     
diff --git a/tests/baselines/reference/assignFromBooleanInterface.errors.txt b/tests/baselines/reference/assignFromBooleanInterface.errors.txt
@@ -1,4 +1,5 @@
 tests/cases/conformance/types/primitives/boolean/assignFromBooleanInterface.ts(3,1): error TS2322: Type 'Boolean' is not assignable to type 'boolean'.
+  'boolean' is a primitive type while 'Boolean' is a boxed object. Prefer using 'boolean' when possible.
 
 
 ==== tests/cases/conformance/types/primitives/boolean/assignFromBooleanInterface.ts (1 errors) ====
@@ -7,4 +8,5 @@ tests/cases/conformance/types/primitives/boolean/assignFromBooleanInterface.ts(3
     x = a;
     ~
 !!! error TS2322: Type 'Boolean' is not assignable to type 'boolean'.
+!!! error TS2322:   'boolean' is a primitive type while 'Boolean' is a boxed object. Prefer using 'boolean' when possible.
     a = x;
diff --git a/tests/baselines/reference/assignFromBooleanInterface2.errors.txt b/tests/baselines/reference/assignFromBooleanInterface2.errors.txt
@@ -3,6 +3,7 @@ tests/cases/conformance/types/primitives/boolean/assignFromBooleanInterface2.ts(
     Type '() => Object' is not assignable to type '() => boolean'.
       Type 'Object' is not assignable to type 'boolean'.
 tests/cases/conformance/types/primitives/boolean/assignFromBooleanInterface2.ts(19,1): error TS2322: Type 'Boolean' is not assignable to type 'boolean'.
+  'boolean' is a primitive type while 'Boolean' is a boxed object. Prefer using 'boolean' when possible.
 tests/cases/conformance/types/primitives/boolean/assignFromBooleanInterface2.ts(20,1): error TS2322: Type 'NotBoolean' is not assignable to type 'boolean'.
 
 
@@ -33,6 +34,7 @@ tests/cases/conformance/types/primitives/boolean/assignFromBooleanInterface2.ts(
     x = a; // expected error
     ~
 !!! error TS2322: Type 'Boolean' is not assignable to type 'boolean'.
+!!! error TS2322:   'boolean' is a primitive type while 'Boolean' is a boxed object. Prefer using 'boolean' when possible.
     x = b; // expected error
     ~
 !!! error TS2322: Type 'NotBoolean' is not assignable to type 'boolean'.
diff --git a/tests/baselines/reference/assignFromNumberInterface.errors.txt b/tests/baselines/reference/assignFromNumberInterface.errors.txt
@@ -1,4 +1,5 @@
 tests/cases/conformance/types/primitives/number/assignFromNumberInterface.ts(3,1): error TS2322: Type 'Number' is not assignable to type 'number'.
+  'number' is a primitive type while 'Number' is a boxed object. Prefer using 'number' when possible.
 
 
 ==== tests/cases/conformance/types/primitives/number/assignFromNumberInterface.ts (1 errors) ====
@@ -7,4 +8,5 @@ tests/cases/conformance/types/primitives/number/assignFromNumberInterface.ts(3,1
     x = a;
     ~
 !!! error TS2322: Type 'Number' is not assignable to type 'number'.
+!!! error TS2322:   'number' is a primitive type while 'Number' is a boxed object. Prefer using 'number' when possible.
     a = x;
diff --git a/tests/baselines/reference/assignFromNumberInterface2.errors.txt b/tests/baselines/reference/assignFromNumberInterface2.errors.txt
@@ -1,4 +1,5 @@
 tests/cases/conformance/types/primitives/number/assignFromNumberInterface2.ts(24,1): error TS2322: Type 'Number' is not assignable to type 'number'.
+  'number' is a primitive type while 'Number' is a boxed object. Prefer using 'number' when possible.
 tests/cases/conformance/types/primitives/number/assignFromNumberInterface2.ts(25,1): error TS2322: Type 'NotNumber' is not assignable to type 'number'.
 
 
@@ -29,6 +30,7 @@ tests/cases/conformance/types/primitives/number/assignFromNumberInterface2.ts(25
     x = a; // expected error
     ~
 !!! error TS2322: Type 'Number' is not assignable to type 'number'.
+!!! error TS2322:   'number' is a primitive type while 'Number' is a boxed object. Prefer using 'number' when possible.
     x = b; // expected error
     ~
 !!! error TS2322: Type 'NotNumber' is not assignable to type 'number'.
diff --git a/tests/baselines/reference/assignFromStringInterface.errors.txt b/tests/baselines/reference/assignFromStringInterface.errors.txt
@@ -1,4 +1,5 @@
 tests/cases/conformance/types/primitives/string/assignFromStringInterface.ts(3,1): error TS2322: Type 'String' is not assignable to type 'string'.
+  'string' is a primitive type while 'String' is a boxed object. Prefer using 'string' when possible.
 
 
 ==== tests/cases/conformance/types/primitives/string/assignFromStringInterface.ts (1 errors) ====
@@ -7,4 +8,5 @@ tests/cases/conformance/types/primitives/string/assignFromStringInterface.ts(3,1
     x = a;
     ~
 !!! error TS2322: Type 'String' is not assignable to type 'string'.
+!!! error TS2322:   'string' is a primitive type while 'String' is a boxed object. Prefer using 'string' when possible.
     a = x;
diff --git a/tests/baselines/reference/assignFromStringInterface2.errors.txt b/tests/baselines/reference/assignFromStringInterface2.errors.txt
@@ -1,4 +1,5 @@
 tests/cases/conformance/types/primitives/string/assignFromStringInterface2.ts(47,1): error TS2322: Type 'String' is not assignable to type 'string'.
+  'string' is a primitive type while 'String' is a boxed object. Prefer using 'string' when possible.
 tests/cases/conformance/types/primitives/string/assignFromStringInterface2.ts(48,1): error TS2322: Type 'NotString' is not assignable to type 'string'.
 
 
@@ -52,6 +53,7 @@ tests/cases/conformance/types/primitives/string/assignFromStringInterface2.ts(48
     x = a; // expected error
     ~
 !!! error TS2322: Type 'String' is not assignable to type 'string'.
+!!! error TS2322:   'string' is a primitive type while 'String' is a boxed object. Prefer using 'string' when possible.
     x = b; // expected error
     ~
 !!! error TS2322: Type 'NotString' is not assignable to type 'string'.
diff --git a/tests/baselines/reference/nativeToBoxedTypes.errors.txt b/tests/baselines/reference/nativeToBoxedTypes.errors.txt
@@ -0,0 +1,29 @@
+tests/cases/compiler/nativeToBoxedTypes.ts(3,1): error TS2322: Type 'Number' is not assignable to type 'number'.
+  'number' is a primitive type while 'Number' is a boxed object. Prefer using 'number' when possible.
+tests/cases/compiler/nativeToBoxedTypes.ts(7,1): error TS2322: Type 'String' is not assignable to type 'string'.
+  'string' is a primitive type while 'String' is a boxed object. Prefer using 'string' when possible.
+tests/cases/compiler/nativeToBoxedTypes.ts(11,1): error TS2322: Type 'Boolean' is not assignable to type 'boolean'.
+  'boolean' is a primitive type while 'Boolean' is a boxed object. Prefer using 'boolean' when possible.
+
+
+==== tests/cases/compiler/nativeToBoxedTypes.ts (3 errors) ====
+    var N = new Number();
+    var n = 100;
+    n = N;
+    ~
+!!! error TS2322: Type 'Number' is not assignable to type 'number'.
+!!! error TS2322:   'number' is a primitive type while 'Number' is a boxed object. Prefer using 'number' when possible.
+    
+    var S = new String();
+    var s = "foge";
+    s = S;
+    ~
+!!! error TS2322: Type 'String' is not assignable to type 'string'.
+!!! error TS2322:   'string' is a primitive type while 'String' is a boxed object. Prefer using 'string' when possible.
+    
+    var B = new Boolean();
+    var b = true;
+    b = B;
+    ~
+!!! error TS2322: Type 'Boolean' is not assignable to type 'boolean'.
+!!! error TS2322:   'boolean' is a primitive type while 'Boolean' is a boxed object. Prefer using 'boolean' when possible.
diff --git a/tests/baselines/reference/nativeToBoxedTypes.js b/tests/baselines/reference/nativeToBoxedTypes.js
@@ -0,0 +1,23 @@
+//// [nativeToBoxedTypes.ts]
+var N = new Number();
+var n = 100;
+n = N;
+
+var S = new String();
+var s = "foge";
+s = S;
+
+var B = new Boolean();
+var b = true;
+b = B;
+
+//// [nativeToBoxedTypes.js]
+var N = new Number();
+var n = 100;
+n = N;
+var S = new String();
+var s = "foge";
+s = S;
+var B = new Boolean();
+var b = true;
+b = B;
diff --git a/tests/baselines/reference/primitiveMembers.errors.txt b/tests/baselines/reference/primitiveMembers.errors.txt
@@ -1,5 +1,6 @@
 tests/cases/compiler/primitiveMembers.ts(5,3): error TS2339: Property 'toBAZ' does not exist on type 'number'.
 tests/cases/compiler/primitiveMembers.ts(11,1): error TS2322: Type 'Number' is not assignable to type 'number'.
+  'number' is a primitive type while 'Number' is a boxed object. Prefer using 'number' when possible.
 
 
 ==== tests/cases/compiler/primitiveMembers.ts (2 errors) ====
@@ -18,6 +19,7 @@ tests/cases/compiler/primitiveMembers.ts(11,1): error TS2322: Type 'Number' is n
     n = N;  // should not work, as 'number' has a different brand
     ~
 !!! error TS2322: Type 'Number' is not assignable to type 'number'.
+!!! error TS2322:   'number' is a primitive type while 'Number' is a boxed object. Prefer using 'number' when possible.
     N = n; // should work
     
     var o: Object = {}
diff --git a/tests/cases/compiler/nativeToBoxedTypes.ts b/tests/cases/compiler/nativeToBoxedTypes.ts
@@ -0,0 +1,11 @@
+var N = new Number();
+var n = 100;
+n = N;
+
+var S = new String();
+var s = "foge";
+s = S;
+
+var B = new Boolean();
+var b = true;
+b = B;

Original file line number	Diff line number	Diff line change
`@@ -6258,13 +6258,20 @@ namespace ts {`
`6258`	`6258`	`targetType = typeToString(target, /enclosingDeclaration/ undefined, TypeFormatFlags.UseFullyQualifiedType);`
`6259`	`6259`	`}`
`6260`	`6260`
	`6261`	`+ // check if trying to relate primitives to the boxed/apparent backing types.`
	`6262`	`+ if ((sourceType === "Number" && targetType === "number") \|\|`
	`6263`	`+ (sourceType === "String" && targetType === "string") \|\|`
	`6264`	`+ (sourceType === "Boolean" && targetType === "boolean")) {`
	`6265`	`+ reportError(Diagnostics._0_is_a_primitive_type_while_1_is_a_boxed_object_Prefer_using_0_when_possible, targetType, sourceType);`
	`6266`	`+ }`
	`6267`	`+`
`6261`	`6268`	`if (!message) {`
`6262`	`6269`	`message = relation === comparableRelation ?`
`6263`	`6270`	`Diagnostics.Type_0_is_not_comparable_to_type_1 :`
`6264`	`6271`	`Diagnostics.Type_0_is_not_assignable_to_type_1;`
`6265`	`6272`	`}`
`6266`	`6273`
`6267`		`- reportError(message, sourceType, targetType);`
	`6274`	`+ reportError(message, sourceType, targetType);`
`6268`	`6275`	`}`
`6269`	`6276`
`6270`	`6277`	`// Compare two types and return`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`tests/cases/conformance/types/primitives/boolean/assignFromBooleanInterface.ts(3,1): error TS2322: Type 'Boolean' is not assignable to type 'boolean'.`
	`2`	`+ 'boolean' is a primitive type while 'Boolean' is a boxed object. Prefer using 'boolean' when possible.`
`2`	`3`
`3`	`4`
`4`	`5`	`==== tests/cases/conformance/types/primitives/boolean/assignFromBooleanInterface.ts (1 errors) ====`
`@@ -7,4 +8,5 @@ tests/cases/conformance/types/primitives/boolean/assignFromBooleanInterface.ts(3`
`7`	`8`	`x = a;`
`8`	`9`	`~`
`9`	`10`	`!!! error TS2322: Type 'Boolean' is not assignable to type 'boolean'.`
	`11`	`+!!! error TS2322: 'boolean' is a primitive type while 'Boolean' is a boxed object. Prefer using 'boolean' when possible.`
`10`	`12`	`a = x;`
Original file line number	Diff line number	Diff line change
`@@ -3,6 +3,7 @@ tests/cases/conformance/types/primitives/boolean/assignFromBooleanInterface2.ts(`
`3`	`3`	`Type '() => Object' is not assignable to type '() => boolean'.`
`4`	`4`	`Type 'Object' is not assignable to type 'boolean'.`
`5`	`5`	`tests/cases/conformance/types/primitives/boolean/assignFromBooleanInterface2.ts(19,1): error TS2322: Type 'Boolean' is not assignable to type 'boolean'.`
	`6`	`+ 'boolean' is a primitive type while 'Boolean' is a boxed object. Prefer using 'boolean' when possible.`
`6`	`7`	`tests/cases/conformance/types/primitives/boolean/assignFromBooleanInterface2.ts(20,1): error TS2322: Type 'NotBoolean' is not assignable to type 'boolean'.`
`7`	`8`
`8`	`9`
`@@ -33,6 +34,7 @@ tests/cases/conformance/types/primitives/boolean/assignFromBooleanInterface2.ts(`
`33`	`34`	`x = a; // expected error`
`34`	`35`	`~`
`35`	`36`	`!!! error TS2322: Type 'Boolean' is not assignable to type 'boolean'.`
	`37`	`+!!! error TS2322: 'boolean' is a primitive type while 'Boolean' is a boxed object. Prefer using 'boolean' when possible.`
`36`	`38`	`x = b; // expected error`
`37`	`39`	`~`
`38`	`40`	`!!! error TS2322: Type 'NotBoolean' is not assignable to type 'boolean'.`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`tests/cases/conformance/types/primitives/number/assignFromNumberInterface.ts(3,1): error TS2322: Type 'Number' is not assignable to type 'number'.`
	`2`	`+ 'number' is a primitive type while 'Number' is a boxed object. Prefer using 'number' when possible.`
`2`	`3`
`3`	`4`
`4`	`5`	`==== tests/cases/conformance/types/primitives/number/assignFromNumberInterface.ts (1 errors) ====`
`@@ -7,4 +8,5 @@ tests/cases/conformance/types/primitives/number/assignFromNumberInterface.ts(3,1`
`7`	`8`	`x = a;`
`8`	`9`	`~`
`9`	`10`	`!!! error TS2322: Type 'Number' is not assignable to type 'number'.`
	`11`	`+!!! error TS2322: 'number' is a primitive type while 'Number' is a boxed object. Prefer using 'number' when possible.`
`10`	`12`	`a = x;`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`tests/cases/conformance/types/primitives/string/assignFromStringInterface.ts(3,1): error TS2322: Type 'String' is not assignable to type 'string'.`
	`2`	`+ 'string' is a primitive type while 'String' is a boxed object. Prefer using 'string' when possible.`
`2`	`3`
`3`	`4`
`4`	`5`	`==== tests/cases/conformance/types/primitives/string/assignFromStringInterface.ts (1 errors) ====`
`@@ -7,4 +8,5 @@ tests/cases/conformance/types/primitives/string/assignFromStringInterface.ts(3,1`
`7`	`8`	`x = a;`
`8`	`9`	`~`
`9`	`10`	`!!! error TS2322: Type 'String' is not assignable to type 'string'.`
	`11`	`+!!! error TS2322: 'string' is a primitive type while 'String' is a boxed object. Prefer using 'string' when possible.`
`10`	`12`	`a = x;`