Typescript now reads type information without error. glayzzle#968 (glayzzle#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(

src/ast/do.js

@@ -14,7 +14,7 @@ const KIND = "do";
  * @memberOf module:php-parser
  * @extends {Statement}
  * @property {Expression} test
- * @property {Statement} body
+ * @property {Block | null} body
  */
 module.exports = Statement.extends(
   KIND,

src/ast/echo.js

@@ -13,6 +13,7 @@ const KIND = "echo";
  * @constructor Echo
  * @memberOf module:php-parser
  * @property {boolean} shortForm
+ * @property {Expression[]} expressions
  * @extends {Statement}
  */
 module.exports = Statement.extends(

src/ast/encapsed.js

@@ -15,6 +15,7 @@ const KIND = "encapsed";
  * @extends {Literal}
  * @property {String} type - Defines the type of encapsed string (shell, heredoc, string)
  * @property {String|Null} label - The heredoc label, defined only when the type is heredoc
+ * @property {EncapsedPart[]} value
  */
 const Encapsed = Literal.extends(
   KIND,

src/ast/entry.js

@@ -10,8 +10,8 @@ const KIND = "entry";
 
 /**
  * An array entry - see [Array](#array)
- * @constructor Entry
  * @memberOf module:php-parser
+ * @constructor Entry
  * @extends {Expression}
  * @property {Node|null} key The entry key/offset
  * @property {Node} value The entry value

src/ast/for.js

@@ -16,7 +16,7 @@ const KIND = "for";
  * @property {Expression[]} init
  * @property {Expression[]} test
  * @property {Expression[]} increment
- * @property {Statement} body
+ * @property {Block | null} body
  * @property {boolean} shortForm
  * @see http://php.net/manual/en/control-structures.for.php
  */

src/ast/foreach.js

@@ -16,7 +16,7 @@ const KIND = "foreach";
  * @property {Expression} source
  * @property {Expression|null} key
  * @property {Expression} value
- * @property {Statement} body
+ * @property {Block | null} body
  * @property {boolean} shortForm
  * @see http://php.net/manual/en/control-structures.foreach.php
  */

src/ast/function.js

@@ -18,7 +18,7 @@ const KIND = "function";
  * @property {boolean} byref
  * @property {boolean} nullable
  * @property {Block|null} body
- * @property {AttrGroups[]} attrGroups
+ * @property {AttrGroup[]} attrGroups
  */
 module.exports = Declaration.extends(
   KIND,

src/ast/inline.js

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

src/ast/intersectiontype.js

@@ -10,6 +10,7 @@ const KIND = "intersectiontype";
 
 /**
  * A union of types
+ * @memberOf module:php-parser
  * @constructor IntersectionType
  * @extends {Declaration}
  * @property {TypeReference[]} types

src/ast/list.js

@@ -14,6 +14,7 @@ const KIND = "list";
  * @memberOf module:php-parser
  * @extends {Expression}
  * @property {boolean} shortForm
+ * @property {Entry[]} items
  */
 module.exports = Expression.extends(
   KIND,

src/ast/literal.js

@@ -14,7 +14,7 @@ const KIND = "literal";
  * @memberOf module:php-parser
  * @extends {Expression}
  * @property {string} raw
- * @property {Node|string|number|boolean|null} value
+ * @property {EncapsedPart[]|Node|string|number|boolean|null} value
  */
 module.exports = Expression.extends(
   KIND,

src/ast/match.js

@@ -10,6 +10,7 @@ const KIND = "match";
 
 /**
  * Defines a match expression
+ * @memberOf module:php-parser
  * @constructor Match
  * @extends {Expression}
  * @property {Expression} cond Condition expression to match against

src/ast/matcharm.js

@@ -10,7 +10,8 @@ const KIND = "matcharm";
 
 /**
  * An array entry - see [Array](#array)
- * @constructor Entry
+ * @memberOf module:php-parser
+ * @constructor MatchArm
  * @extends {Expression}
  * @property {Expression[]|null} conds The match condition expression list - null indicates default arm
  * @property {Expression} body The return value expression

src/ast/namedargument.js

@@ -10,6 +10,7 @@ const KIND = "namedargument";
 
 /**
  * Named arguments.
+ * @memberOf module:php-parser
  * @constructor namedargument
  * @extends {Expression}
  * @property {String} name

src/ast/nowdoc.js

@@ -15,6 +15,7 @@ const KIND = "nowdoc";
  * @extends {Literal}
  * @property {string} label
  * @property {string} raw
+ * @property {string} value
  */
 module.exports = Literal.extends(
   KIND,

src/ast/nullsafepropertylookup.js

@@ -10,12 +10,13 @@ const KIND = "nullsafepropertylookup";
 
 /**
  * Lookup to an object property
- * @constructor PropertyLookup
+ * @memberOf module:php-parser
+ * @constructor NullSafePropertyLookup
  * @extends {Lookup}
  */
 module.exports = Lookup.extends(
   KIND,
-  function PropertyLookup(what, offset, docs, location) {
+  function NullSafePropertyLookup(what, offset, docs, location) {
     Lookup.apply(this, [KIND, what, offset, docs, location]);
   }
 );

src/ast/number.js

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

src/ast/parameter.js

@@ -8,13 +8,18 @@
 const Declaration = require("./declaration");
 const KIND = "parameter";
 
-// eslint-disable-next-line no-unused-vars
-const MODIFIER_PUBLIC = 1;
-// eslint-disable-next-line no-unused-vars
-const MODIFIER_PROTECTED = 2;
-// eslint-disable-next-line no-unused-vars
-const MODIFIER_PRIVATE = 4;
-
+/**
+ * @memberOf module:php-parser
+ * @typedef {1} MODIFIER_PUBLIC
+ **/
+/**
+ * @memberOf module:php-parser
+ * @typedef {2} MODIFIER_PROTECTED
+ **/
+/**
+ * @memberOf module:php-parser
+ * @typedef {4} MODIFIER_PRIVATE
+ **/
 /**
  * Defines a function parameter
  * @constructor Parameter
@@ -26,7 +31,7 @@ const MODIFIER_PRIVATE = 4;
  * @property {boolean} variadic
  * @property {boolean} readonly
  * @property {boolean} nullable
- * @property {AttrGroups[]} attrGroups
+ * @property {AttrGroup[]} attrGroups
  * @property {MODIFIER_PUBLIC|MODIFIER_PROTECTED|MODIFIER_PRIVATE} flags
  */
 module.exports = Declaration.extends(

src/ast/propertylookup.js

@@ -10,8 +10,8 @@ const KIND = "propertylookup";
 
 /**
  * Lookup to an object property
- * @constructor PropertyLookup
  * @memberOf module:php-parser
+ * @constructor PropertyLookup
  * @extends {Lookup}
  */
 module.exports = Lookup.extends(

src/ast/propertystatement.js

@@ -19,6 +19,8 @@ const IS_PRIVATE = "private";
  * @memberOf module:php-parser
  * @extends {Statement}
  * @property {Property[]} properties
+ * @property {string|null} visibility
+ * @property {boolean} isStatic
  */
 const PropertyStatement = Statement.extends(
   KIND,

src/ast/string.js

@@ -16,6 +16,7 @@ const KIND = "string";
  * @property {boolean} unicode
  * @property {boolean} isDoubleQuote
  * @see {Encapsed}
+ * @property {string} value
  */
 module.exports = Literal.extends(
   KIND,

src/ast/uniontype.js

@@ -10,6 +10,7 @@ const KIND = "uniontype";
 
 /**
  * A union of types
+ * @memberOf module:php-parser
  * @constructor UnionType
  * @extends {Declaration}
  * @property {TypeReference[]} types

src/ast/while.js

@@ -14,7 +14,7 @@ const KIND = "while";
  * @memberOf module:php-parser
  * @extends {Statement}
  * @property {Expression} test
- * @property {Statement} body
+ * @property {Block | null} body
  * @property {boolean} shortForm
  */
 module.exports = Statement.extends(

src/parser.js

@@ -400,6 +400,8 @@ Parser.prototype.error = function (expect) {
 /**
  * Create a position node from the lexers position
  *
+ * @function Parser#position
+ * @memberOf module:php-parser
  * @return {Position}
  */
 Parser.prototype.position = function () {
@@ -633,7 +635,9 @@ Parser.prototype.next = function () {
 
 /**
  * Peek at the next token.
- * @returns string|number Next Token
+ * @function Parser#peek
+ * @memberOf module:php-parser
+ * @returns {string|number} Next Token
  */
 Parser.prototype.peek = function () {
   const lexerState = this.lexer.getState();