Typescript now reads type information without error. #968 (#980)

* docs: Modified jsdoc to be as per current types.d.ts.

* A little processing has been added so that TokenNames are defined as constants.
* NullSafePropertyLookup has renamed its constructor.

* docs: npm run build-types

* docs: fix typo, and define type.

* chore: add type check in github actions.

* chore: npm run test -- --updateSnapshot

* chore: add diff check for types.d.ts.

* docs: fix style.

Author: ytetsuro

.github/workflows/test.yml

@@ -24,6 +24,13 @@ jobs:
         yarn
         yarn test
 
+    - name: type check
+      run: |
+        npm i -g typescript
+        yarn build-types
+        [ $(git diff types.d.ts | wc -l) -gt 0 ] && echo 'Diff exists in types.d.ts. Please change jsdoc.' && exit 1
+        tsc --noEmit types.d.ts
+
     - name: install valgrind
       run: sudo apt-get install -y valgrind
 

src/ast/array.js

@@ -31,7 +31,7 @@ const KIND = "array";
  *  ]
  * }
  * @extends {Expression}
- * @property {Entry|Expression|Variable} items List of array items
+ * @property {Array<Entry|Expression|Variable>} items List of array items
  * @property {boolean} shortForm Indicate if the short array syntax is used, ex `[]` instead `array()`
  */
 module.exports = Expr.extends(

src/ast/attrgroup.js

@@ -10,6 +10,7 @@ const KIND = "attrgroup";
 
 /**
  * Attribute group
+ * @memberOf module:php-parser
  * @constructor AttrGroup
  * @extends {Node}
  * @property {Attribute[]} attrs

src/ast/attribute.js

@@ -10,6 +10,7 @@ const KIND = "attribute";
 
 /**
  * Attribute Value
+ * @memberOf module:php-parser
  * @constructor Attribute
  * @extends {Node}
  * @property {String} name

src/ast/boolean.js

@@ -13,6 +13,7 @@ const KIND = "boolean";
  * @constructor Boolean
  * @memberOf module:php-parser
  * @extends {Literal}
+ * @property {boolean} value
  */
 module.exports = Literal.extends(
   KIND,

src/ast/call.js

@@ -14,7 +14,7 @@ const KIND = "call";
  * @memberOf module:php-parser
  * @extends {Expression}
  * @property {Identifier|Variable} what
- * @property {Variable[]} arguments
+ * @property {Expression[]} arguments
  */
 module.exports = Expression.extends(
   KIND,

src/ast/catch.js

@@ -13,9 +13,9 @@ const KIND = "catch";
  * @constructor Catch
  * @memberOf module:php-parser
  * @extends {Statement}
- * @property {Identifier[]} what
- * @property {Variable|null} variable
- * @property {Statement} body
+ * @property {Name[]} what
+ * @property {Variable} variable
+ * @property {Block} body
  * @see http://php.net/manual/en/language.exceptions.php
  */
 module.exports = Statement.extends(

src/ast/class.js

@@ -14,12 +14,12 @@ const KIND = "class";
  * @memberOf module:php-parser
  * @extends {Declaration}
  * @property {Identifier|null} extends
- * @property {Identifier[]} implements
+ * @property {Identifier[]|null} implements
  * @property {Declaration[]} body
- * @property {AttrGroup[]} attrGroups
  * @property {boolean} isAnonymous
  * @property {boolean} isAbstract
  * @property {boolean} isFinal
+ * @property {AttrGroup[]} attrGroups
  */
 module.exports = Declaration.extends(
   KIND,

src/ast/declare.js

@@ -13,8 +13,8 @@ const KIND = "declare";
  * @constructor Declare
  * @memberOf module:php-parser
  * @extends {Block}
- * @property {Array[]} directives
- * @property {String} mode
+ * @property {DeclareDirective[]} directives
+ * @property {string} mode
  * @see http://php.net/manual/en/control-structures.declare.php
  */
 const Declare = Block.extends(

src/ast/declaredirective.js

@@ -13,7 +13,7 @@ const KIND = "declaredirective";
  * @constructor DeclareDirective
  * @memberOf module:php-parser
  * @extends {Node}
- * @property {Identifier} name
+ * @property {Identifier} key
  * @property {Node|string|number|boolean|null} value
  */
 module.exports = Node.extends(