From aa834d7f17933c913015a772b7e0bab1af18dde8 Mon Sep 17 00:00:00 2001
From: Nathan Shively-Sanders <nathansa@microsoft.com>
Date: Wed, 17 Aug 2016 15:49:57 -0700
Subject: [PATCH] JSDoc supports null, undefined and never types

---
 src/compiler/checker.ts                       |  6 ++++++
 src/compiler/parser.ts                        |  5 ++++-
 src/compiler/types.ts                         |  5 ++++-
 .../reference/jsdocNeverUndefinedNull.js      | 20 +++++++++++++++++++
 .../reference/jsdocNeverUndefinedNull.symbols | 14 +++++++++++++
 .../reference/jsdocNeverUndefinedNull.types   | 14 +++++++++++++
 .../jsdoc/jsdocNeverUndefinedNull.ts          | 11 ++++++++++
 7 files changed, 73 insertions(+), 2 deletions(-)
 create mode 100644 tests/baselines/reference/jsdocNeverUndefinedNull.js
 create mode 100644 tests/baselines/reference/jsdocNeverUndefinedNull.symbols
 create mode 100644 tests/baselines/reference/jsdocNeverUndefinedNull.types
 create mode 100644 tests/cases/conformance/jsdoc/jsdocNeverUndefinedNull.ts

diff --git a/src/compiler/checker.ts b/src/compiler/checker.ts
index 01f75dc12da..62a252b6d8d 100644
--- a/src/compiler/checker.ts
+++ b/src/compiler/checker.ts
@@ -5547,6 +5547,12 @@ namespace ts {
                     return nullType;
                 case SyntaxKind.NeverKeyword:
                     return neverType;
+                case SyntaxKind.JSDocNullKeyword:
+                    return nullType;
+                case SyntaxKind.JSDocUndefinedKeyword:
+                    return undefinedType;
+                case SyntaxKind.JSDocNeverKeyword:
+                    return neverType;
                 case SyntaxKind.ThisType:
                 case SyntaxKind.ThisKeyword:
                     return getTypeFromThisTypeNode(node);
diff --git a/src/compiler/parser.ts b/src/compiler/parser.ts
index b05451340d1..f78346fd5cd 100644
--- a/src/compiler/parser.ts
+++ b/src/compiler/parser.ts
@@ -1241,7 +1241,7 @@ namespace ts {
                     // not in error recovery.  If we're in error recovery, we don't want an errant
                     // semicolon to be treated as a class member (since they're almost always used
                     // for statements.
-                    return lookAhead(isClassMemberStart) || (token() === SyntaxKind.SemicolonToken && !inErrorRecovery);
+                    return lookAhead(isClassMemberStart) || (token() === SyntaxKind.SemicolonToken && !inErrorRecovery);

                 case ParsingContext.EnumMembers:
                     // Include open bracket computed properties. This technically also lets in indexers,
                     // which would be a candidate for improved error reporting.
@@ -5890,6 +5890,9 @@ namespace ts {
                     case SyntaxKind.BooleanKeyword:
                     case SyntaxKind.SymbolKeyword:
                     case SyntaxKind.VoidKeyword:
+                    case SyntaxKind.NullKeyword:
+                    case SyntaxKind.UndefinedKeyword:
+                    case SyntaxKind.NeverKeyword:
                         return parseTokenNode<JSDocType>();
                     case SyntaxKind.StringLiteral:
                     case SyntaxKind.NumericLiteral:
diff --git a/src/compiler/types.ts b/src/compiler/types.ts
index 0bbbd99bdd5..1ada1e547f2 100644
--- a/src/compiler/types.ts
+++ b/src/compiler/types.ts
@@ -351,6 +351,9 @@ namespace ts {
         JSDocPropertyTag,
         JSDocTypeLiteral,
         JSDocLiteralType,
+        JSDocNullKeyword,
+        JSDocUndefinedKeyword,
+        JSDocNeverKeyword,
 
         // Synthesized list
         SyntaxList,
@@ -383,7 +386,7 @@ namespace ts {
         FirstJSDocNode = JSDocTypeExpression,
         LastJSDocNode = JSDocLiteralType,
         FirstJSDocTagNode = JSDocComment,
-        LastJSDocTagNode = JSDocLiteralType
+        LastJSDocTagNode = JSDocNeverKeyword
     }
 
     export const enum NodeFlags {
diff --git a/tests/baselines/reference/jsdocNeverUndefinedNull.js b/tests/baselines/reference/jsdocNeverUndefinedNull.js
new file mode 100644
index 00000000000..e57b7091a3b
--- /dev/null
+++ b/tests/baselines/reference/jsdocNeverUndefinedNull.js
@@ -0,0 +1,20 @@
+//// [in.js]
+/**
+ * @param {never} p1
+ * @param {undefined} p2
+ * @param {null} p3
+ * @returns {void} nothing
+ */
+function f(p1, p2, p3) {
+}
+
+
+//// [out.js]
+/**
+ * @param {never} p1
+ * @param {undefined} p2
+ * @param {null} p3
+ * @returns {void} nothing
+ */
+function f(p1, p2, p3) {
+}
diff --git a/tests/baselines/reference/jsdocNeverUndefinedNull.symbols b/tests/baselines/reference/jsdocNeverUndefinedNull.symbols
new file mode 100644
index 00000000000..a57636ed344
--- /dev/null
+++ b/tests/baselines/reference/jsdocNeverUndefinedNull.symbols
@@ -0,0 +1,14 @@
+=== tests/cases/conformance/jsdoc/in.js ===
+/**
+ * @param {never} p1
+ * @param {undefined} p2
+ * @param {null} p3
+ * @returns {void} nothing
+ */
+function f(p1, p2, p3) {
+>f : Symbol(f, Decl(in.js, 0, 0))
+>p1 : Symbol(p1, Decl(in.js, 6, 11))
+>p2 : Symbol(p2, Decl(in.js, 6, 14))
+>p3 : Symbol(p3, Decl(in.js, 6, 18))
+}
+
diff --git a/tests/baselines/reference/jsdocNeverUndefinedNull.types b/tests/baselines/reference/jsdocNeverUndefinedNull.types
new file mode 100644
index 00000000000..fe57cc298e2
--- /dev/null
+++ b/tests/baselines/reference/jsdocNeverUndefinedNull.types
@@ -0,0 +1,14 @@
+=== tests/cases/conformance/jsdoc/in.js ===
+/**
+ * @param {never} p1
+ * @param {undefined} p2
+ * @param {null} p3
+ * @returns {void} nothing
+ */
+function f(p1, p2, p3) {
+>f : (p1: never, p2: undefined, p3: null) => void
+>p1 : never
+>p2 : undefined
+>p3 : null
+}
+
diff --git a/tests/cases/conformance/jsdoc/jsdocNeverUndefinedNull.ts b/tests/cases/conformance/jsdoc/jsdocNeverUndefinedNull.ts
new file mode 100644
index 00000000000..c095bc1c920
--- /dev/null
+++ b/tests/cases/conformance/jsdoc/jsdocNeverUndefinedNull.ts
@@ -0,0 +1,11 @@
+// @allowJs: true
+// @filename: in.js
+// @out: out.js
+/**
+ * @param {never} p1
+ * @param {undefined} p2
+ * @param {null} p3
+ * @returns {void} nothing
+ */
+function f(p1, p2, p3) {
+}