Merge pull request microsoft#174 from TysonAndre/normalize-space

Normalize spaces in union types in comments ("A | B" -> "A|B")

Author: roblourens

src/DiagnosticsProvider.php

@@ -9,14 +9,14 @@
 use Microsoft\PhpParser\Node;
 
 class DiagnosticsProvider {
-    /**
-     * Traverses AST to generate diagnostics.
-     * @param \Microsoft\PhpParser\Node $node
-     * @return \Generator | Diagnostic[]
-     */
 
     private static $tokenKindToText;
 
+    /**
+     * Returns the diagnostic for $node, or null.
+     * @param \Microsoft\PhpParser\Node $node
+     * @return Diagnostic|null
+     */
     public static function checkDiagnostics($node) {
         if (!isset(self::$tokenKindToText)) {
             self::$tokenKindToText = \array_flip(\array_merge(
@@ -88,6 +88,11 @@ public static function checkDiagnostics($node) {
         return null;
     }
 
+    /**
+     * Traverses AST to generate diagnostics.
+     * @param \Microsoft\PhpParser\Node $n
+     * @return Diagnostic[]
+     */
     public static function getDiagnostics(Node $n) : array {
         $diagnostics = [];
 

src/Node.php

@@ -16,7 +16,7 @@ abstract class Node implements \JsonSerializable {
     /** @var array[] Map from node class to array of child keys */
     private static $childNames = [];
 
-    /** @var Node | null */
+    /** @var Node|null */
     public $parent;
 
     public function getNodeKindName() : string {
@@ -187,7 +187,7 @@ public function getDescendantNodes(callable $shouldDescendIntoChildrenFn = null)
     /**
      * Gets generator containing all descendant Tokens.
      * @param callable|null $shouldDescendIntoChildrenFn
-     * @return \Generator | Token[]
+     * @return \Generator|Token[]
      */
     public function getDescendantTokens(callable $shouldDescendIntoChildrenFn = null) {
         foreach ($this->getChildNodesAndTokens() as $child) {
@@ -205,7 +205,7 @@ public function getDescendantTokens(callable $shouldDescendIntoChildrenFn = null
      * Gets generator containing all child Nodes and Tokens (direct descendants).
      * Does not return null elements.
      *
-     * @return \Generator | Token[] | Node[]
+     * @return \Generator|Token[]|Node[]
      */
     public function getChildNodesAndTokens() : \Generator {
         foreach ($this::CHILD_NAMES as $name) {
@@ -227,7 +227,7 @@ public function getChildNodesAndTokens() : \Generator {
 
     /**
      * Gets generator containing all child Nodes (direct descendants)
-     * @return \Generator | Node[]
+     * @return \Generator|Node[]
      */
     public function getChildNodes() : \Generator {
         foreach ($this::CHILD_NAMES as $name) {
@@ -425,7 +425,7 @@ private function containsPosition(int $pos): bool {
      * Returns last doc comment in leading comment / whitespace trivia,
      * and returns null if there is no preceding doc comment.
      *
-     * @return string | null
+     * @return string|null
      */
     public function getDocCommentText() {
         $leadingTriviaText = $this->getLeadingCommentAndWhitespaceText();
@@ -446,7 +446,7 @@ public function __toString() {
     }
 
     /**
-     * @return array | ResolvedName[][]
+     * @return array|ResolvedName[][]
      * @throws \Exception
      */
     public function getImportTablesForCurrentScope() {
@@ -547,7 +547,7 @@ public function getImportTablesForCurrentScope() {
     /**
      * Gets corresponding NamespaceDefinition for Node. Returns null if in global namespace.
      *
-     * @return NamespaceDefinition | null
+     * @return NamespaceDefinition|null
      */
     public function getNamespaceDefinition() {
         $namespaceDefinition = $this instanceof NamespaceDefinition

src/Node/ArrayElement.php

@@ -11,13 +11,13 @@
 
 class ArrayElement extends Node {
 
-    /** @var Expression | null */
+    /** @var Expression|null */
     public $elementKey;
 
-    /** @var Token | null */
+    /** @var Token|null */
     public $arrowToken;
 
-    /** @var Token | null */
+    /** @var Token|null */
     public $byRef;
 
     /** @var Expression */

src/Node/ClassInterfaceClause.php

@@ -13,7 +13,7 @@ class ClassInterfaceClause extends Node {
     /** @var Token */
     public $implementsKeyword;
 
-    /** @var DelimitedList\QualifiedNameList | null */
+    /** @var DelimitedList\QualifiedNameList|null */
     public $interfaceNameList;
 
     const CHILD_NAMES = [

src/Node/ElseClauseNode.php

@@ -14,7 +14,7 @@ class ElseClauseNode extends Node {
     public $elseKeyword;
     /** @var Token */
     public $colon;
-    /** @var StatementNode | StatementNode[] */
+    /** @var StatementNode|StatementNode[] */
     public $statements;
 
     const CHILD_NAMES = [

src/Node/ElseIfClauseNode.php

@@ -18,9 +18,9 @@ class ElseIfClauseNode extends Node {
     public $expression;
     /** @var Token */
     public $closeParen;
-    /** @var Token | null */
+    /** @var Token|null */
     public $colon;
-    /** @var StatementNode | StatementNode[] */
+    /** @var StatementNode|StatementNode[] */
     public $statements;
 
     const CHILD_NAMES = [

src/Node/Expression/AnonymousFunctionCreationExpression.php

@@ -15,7 +15,7 @@
 use Microsoft\PhpParser\Token;
 
 class AnonymousFunctionCreationExpression extends Expression implements FunctionLike {
-    /** @var Token | null */
+    /** @var Token|null */
     public $staticModifier;
 
     use FunctionHeader, FunctionUseClause, FunctionReturnType, FunctionBody;

src/Node/Expression/ArgumentExpression.php

@@ -10,10 +10,10 @@
 use Microsoft\PhpParser\Token;
 
 class ArgumentExpression extends Expression {
-    /** @var Token | null */
+    /** @var Token|null */
     public $byRefToken; // TODO removed in newer versions of PHP. Also only accept variable, not expression if byRef
 
-    /** @var Token | null */
+    /** @var Token|null */
     public $dotDotDotToken;
 
     /** @var Expression */

src/Node/Expression/ArrayCreationExpression.php

@@ -12,7 +12,7 @@
 
 class ArrayCreationExpression extends Expression {
 
-    /** @var Token | null */
+    /** @var Token|null */
     public $arrayKeyword;
 
     /** @var Token */

src/Node/Expression/CallExpression.php

@@ -17,7 +17,7 @@ class CallExpression extends Expression {
     /** @var Token */
     public $openParen;
 
-    /** @var DelimitedList\ArgumentExpressionList | null */
+    /** @var DelimitedList\ArgumentExpressionList|null */
     public $argumentExpressionList;
 
     /** @var Token */