Singleton comments

src/slang-nodes/ArrayExpression.ts

@@ -16,8 +16,6 @@ export class ArrayExpression extends SlangNode {
     super(ast);
 
     this.items = new ArrayValues(ast.items, options);
-
-    this.updateMetadata(this.items);
   }
 
   print(path: AstPath<ArrayExpression>, print: PrintFunction): Doc {

src/slang-nodes/ArrayValues.ts

@@ -17,8 +17,6 @@ export class ArrayValues extends SlangNode {
     super(ast, true);
 
     this.items = ast.items.map((item) => new Expression(item, options));
-
-    this.updateMetadata(this.items);
   }
 
   print(path: AstPath<ArrayValues>, print: PrintFunction): Doc {

src/slang-nodes/AssemblyFlags.ts

@@ -17,8 +17,6 @@ export class AssemblyFlags extends SlangNode {
     super(ast, true);
 
     this.items = ast.items.map((item) => new StringLiteral(item, options));
-
-    this.updateMetadata(this.items);
   }
 
   print(path: AstPath<AssemblyFlags>, print: PrintFunction): Doc {

src/slang-nodes/CallOptions.ts

@@ -20,8 +20,6 @@ export class CallOptions extends SlangNode {
     super(ast, true);
 
     this.items = ast.items.map((item) => new NamedArgument(item, options));
-
-    this.updateMetadata(this.items);
   }
 
   print(

src/slang-nodes/CatchClauses.ts

@@ -19,8 +19,6 @@ export class CatchClauses extends SlangNode {
     super(ast, true);
 
     this.items = ast.items.map((item) => new CatchClause(item, options));
-
-    this.updateMetadata(this.items);
   }
 
   print(path: AstPath<CatchClauses>, print: PrintFunction): Doc {

src/slang-nodes/ConstructorAttributes.ts

@@ -23,8 +23,6 @@ export class ConstructorAttributes extends SlangNode {
       (item) => new ConstructorAttribute(item, options)
     );
 
-    this.updateMetadata(this.items);
-
     this.items = this.items.sort(sortFunctionAttributes);
   }
 

src/slang-nodes/ContractMembers.ts

@@ -21,16 +21,14 @@ export class ContractMembers extends SlangNode {
     super(ast, true);
 
     this.items = ast.items.map((item) => new ContractMember(item, options));
-
-    this.updateMetadata(this.items);
   }
 
   print(
     path: AstPath<ContractMembers>,
     print: PrintFunction,
     options: ParserOptions<AstNode>
   ): Doc {
-    return this.items.length > 0 || this.comments.length > 0
+    return this.items.length > 0 || (this.comments?.length || 0) > 0
       ? printSeparatedItem(printPreservingEmptyLines(path, print, options), {
           firstSeparator: hardline
         })

src/slang-nodes/ContractSpecifiers.ts

@@ -22,8 +22,6 @@ export class ContractSpecifiers extends SlangNode {
 
     this.items = ast.items.map((item) => new ContractSpecifier(item, options));
 
-    this.updateMetadata(this.items);
-
     this.items = this.items.sort(sortContractSpecifiers);
   }
 

src/slang-nodes/ErrorParameters.ts

@@ -17,8 +17,6 @@ export class ErrorParameters extends SlangNode {
     super(ast, true);
 
     this.items = ast.items.map((item) => new ErrorParameter(item, options));
-
-    this.updateMetadata(this.items);
   }
 
   print(path: AstPath<ErrorParameters>, print: PrintFunction): Doc {

src/slang-nodes/EventParameters.ts

@@ -17,8 +17,6 @@ export class EventParameters extends SlangNode {
     super(ast, true);
 
     this.items = ast.items.map((item) => new EventParameter(item, options));
-
-    this.updateMetadata(this.items);
   }
 
   print(path: AstPath<EventParameters>, print: PrintFunction): Doc {

src/slang-nodes/FallbackFunctionAttributes.ts

@@ -26,8 +26,6 @@ export class FallbackFunctionAttributes extends SlangNode {
       (item) => new FallbackFunctionAttribute(item, options)
     );
 
-    this.updateMetadata(this.items);
-
     this.items = this.items.sort(sortFunctionAttributes);
   }
 

src/slang-nodes/FunctionAttributes.ts

@@ -21,8 +21,6 @@ export class FunctionAttributes extends SlangNode {
 
     this.items = ast.items.map((item) => new FunctionAttribute(item, options));
 
-    this.updateMetadata(this.items);
-
     this.items = this.items.sort(sortFunctionAttributes);
   }
 

src/slang-nodes/FunctionTypeAttributes.ts

@@ -20,8 +20,6 @@ export class FunctionTypeAttributes extends SlangNode {
 
     this.items = ast.items.map((item) => new FunctionTypeAttribute(item));
 
-    this.updateMetadata(this.items);
-
     this.items = this.items.sort(sortFunctionAttributes);
   }
 

src/slang-nodes/HexStringLiterals.ts

@@ -19,8 +19,6 @@ export class HexStringLiterals extends SlangNode {
     super(ast, true);
 
     this.items = ast.items.map((item) => new HexStringLiteral(item, options));
-
-    this.updateMetadata(this.items);
   }
 
   print(path: AstPath<HexStringLiterals>, print: PrintFunction): Doc {

src/slang-nodes/IfStatement.ts

@@ -51,7 +51,7 @@ export class IfStatement extends SlangNode {
       this.elseBranch
         ? [
             bodyKind !== NonterminalKind.Block || // else on a new line if body is not a block
-            bodyComments.some(
+            bodyComments?.some(
               (comment) =>
                 !isBlockComment(comment) || comment.placement === 'ownLine'
             ) // or if body has trailing single line comments or a block comment on a new line

src/slang-nodes/ImportDeconstructionSymbols.ts

@@ -21,8 +21,6 @@ export class ImportDeconstructionSymbols extends SlangNode {
     super(ast, true);
 
     this.items = ast.items.map((item) => new ImportDeconstructionSymbol(item));
-
-    this.updateMetadata(this.items);
   }
 
   print(

src/slang-nodes/InheritanceTypes.ts

@@ -20,8 +20,6 @@ export class InheritanceTypes extends SlangNode {
     super(ast, true);
 
     this.items = ast.items.map((item) => new InheritanceType(item, options));
-
-    this.updateMetadata(this.items);
   }
 
   print(path: AstPath<InheritanceTypes>, print: PrintFunction): Doc {

src/slang-nodes/InterfaceMembers.ts

@@ -21,16 +21,14 @@ export class InterfaceMembers extends SlangNode {
     super(ast, true);
 
     this.items = ast.items.map((item) => new ContractMember(item, options));
-
-    this.updateMetadata(this.items);
   }
 
   print(
     path: AstPath<InterfaceMembers>,
     print: PrintFunction,
     options: ParserOptions<AstNode>
   ): Doc {
-    return this.items.length > 0 || this.comments.length > 0
+    return this.items.length > 0 || (this.comments?.length || 0) > 0
       ? printSeparatedItem(printPreservingEmptyLines(path, print, options), {
           firstSeparator: hardline
         })

src/slang-nodes/LibraryMembers.ts

@@ -21,16 +21,14 @@ export class LibraryMembers extends SlangNode {
     super(ast, true);
 
     this.items = ast.items.map((item) => new ContractMember(item, options));
-
-    this.updateMetadata(this.items);
   }
 
   print(
     path: AstPath<LibraryMembers>,
     print: PrintFunction,
     options: ParserOptions<AstNode>
   ): Doc {
-    return this.items.length > 0 || this.comments.length > 0
+    return this.items.length > 0 || (this.comments?.length || 0) > 0
       ? printSeparatedItem(printPreservingEmptyLines(path, print, options), {
           firstSeparator: hardline
         })

src/slang-nodes/ModifierAttributes.ts

@@ -20,8 +20,6 @@ export class ModifierAttributes extends SlangNode {
 
     this.items = ast.items.map((item) => new ModifierAttribute(item));
 
-    this.updateMetadata(this.items);
-
     this.items = this.items.sort(sortFunctionAttributes);
   }
 

src/slang-nodes/NamedArguments.ts

@@ -20,8 +20,6 @@ export class NamedArguments extends SlangNode {
     super(ast, true);
 
     this.items = ast.items.map((item) => new NamedArgument(item, options));
-
-    this.updateMetadata(this.items);
   }
 
   print(

src/slang-nodes/OverridePaths.ts

@@ -16,8 +16,6 @@ export class OverridePaths extends SlangNode {
     super(ast, true);
 
     this.items = ast.items.map((item) => new IdentifierPath(item));
-
-    this.updateMetadata(this.items);
   }
 
   print(path: AstPath<OverridePaths>, print: PrintFunction): Doc {

src/slang-nodes/Parameters.ts

@@ -19,8 +19,6 @@ export class Parameters extends SlangNode {
     super(ast, true);
 
     this.items = ast.items.map((item) => new Parameter(item, options));
-
-    this.updateMetadata(this.items);
   }
 
   print(

src/slang-nodes/PositionalArguments.ts

@@ -19,8 +19,6 @@ export class PositionalArguments extends SlangNode {
     super(ast, true);
 
     this.items = ast.items.map((item) => new Expression(item, options));
-
-    this.updateMetadata(this.items);
   }
 
   print(

src/slang-nodes/PositionalArgumentsDeclaration.ts

@@ -27,9 +27,11 @@ export class PositionalArgumentsDeclaration extends SlangNode {
 
     // We need to check the comments at this point because they will be removed
     // from this node into the root node.
+    // Since we are collecting comments in a different array, we have to query
+    // the ast directly for possible block comments.
     this.isEmpty =
       this.arguments.items.length === 0 && // no arguments
-      !this.comments.some((comment) => isBlockComment(comment)); // no block comments
+      !ast.cst.children().some(({ node }) => isBlockComment(node)); // no block comments
   }
 
   print(

src/slang-nodes/ReceiveFunctionAttributes.ts

@@ -26,8 +26,6 @@ export class ReceiveFunctionAttributes extends SlangNode {
       (item) => new ReceiveFunctionAttribute(item, options)
     );
 
-    this.updateMetadata(this.items);
-
     this.items = this.items.sort(sortFunctionAttributes);
   }
 

src/slang-nodes/SlangNode.ts

@@ -12,10 +12,16 @@ import type { Comment, StrictAstNode } from '../slang-nodes/types.d.ts';
 import type { AstLocation, SlangAstNode } from '../types.d.ts';
 
 const offsets = new Map<number, number>();
+const comments: Comment[] = [];
+
 export function clearOffsets(): void {
   offsets.clear();
 }
 
+export function clearComments(): Comment[] {
+  return comments.splice(0);
+}
+
 function reversedIterator<T>(children: T[]): Iterable<T> {
   return {
     [Symbol.iterator](): Iterator<T> {
@@ -30,23 +36,8 @@ function reversedIterator<T>(children: T[]): Iterable<T> {
   };
 }
 
-function collectComments(
-  comments: Comment[],
-  node: StrictAstNode | StrictAstNode[] | undefined
-): Comment[] {
-  if (node) {
-    if (Array.isArray(node)) {
-      return node.reduce(collectComments, comments);
-    }
-    if (node.comments.length > 0) {
-      comments.push(...node.comments.splice(0));
-    }
-  }
-  return comments;
-}
-
 export class SlangNode {
-  comments: Comment[] = [];
+  comments?: Comment[];
 
   loc: AstLocation;
 
@@ -98,16 +89,16 @@ export class SlangNode {
           // offset, it's hard to separate these responsibilities into different
           // functions without doing the iteration twice.
           case TerminalKind.MultiLineComment:
-            this.comments.push(new MultiLineComment(node, offset));
+            comments.push(new MultiLineComment(node, offset));
             break;
           case TerminalKind.MultiLineNatSpecComment:
-            this.comments.push(new MultiLineNatSpecComment(node, offset));
+            comments.push(new MultiLineNatSpecComment(node, offset));
             break;
           case TerminalKind.SingleLineComment:
-            this.comments.push(new SingleLineComment(node, offset));
+            comments.push(new SingleLineComment(node, offset));
             break;
           case TerminalKind.SingleLineNatSpecComment:
-            this.comments.push(new SingleLineNatSpecComment(node, offset));
+            comments.push(new SingleLineNatSpecComment(node, offset));
             break;
         }
         // We accumulate the trivia length
@@ -130,18 +121,12 @@ export class SlangNode {
     };
   }
 
-  updateMetadata(
-    ...childNodes: (StrictAstNode | StrictAstNode[] | undefined)[]
-  ): void {
-    const { comments, loc } = this;
-    // Collect comments
-    this.comments = childNodes.reduce(collectComments, comments);
-
+  updateMetadata(...childNodes: (StrictAstNode | undefined)[]): void {
+    const { loc } = this;
     // calculate correct loc object
     if (loc.leadingOffset === 0) {
       for (const childNode of childNodes) {
-        if (typeof childNode === 'undefined' || Array.isArray(childNode))
-          continue;
+        if (typeof childNode === 'undefined') continue;
         const { leadingOffset, start } = childNode.loc;
 
         if (start - leadingOffset === loc.start) {
@@ -154,8 +139,7 @@ export class SlangNode {
 
     if (loc.trailingOffset === 0) {
       for (const childNode of reversedIterator(childNodes)) {
-        if (typeof childNode === 'undefined' || Array.isArray(childNode))
-          continue;
+        if (typeof childNode === 'undefined') continue;
         const { trailingOffset, end } = childNode.loc;
 
         if (end + trailingOffset === loc.end) {

src/slang-nodes/SourceUnit.ts

@@ -21,10 +21,6 @@ export class SourceUnit extends SlangNode {
     this.members = new SourceUnitMembers(ast.members, options);
 
     this.updateMetadata(this.members);
-
-    // Because of comments being extracted like a russian doll, the order needs
-    // to be fixed at the end.
-    this.comments = this.comments.sort((a, b) => a.loc.start - b.loc.start);
   }
 
   print(

src/slang-nodes/SourceUnitMembers.ts

@@ -17,8 +17,6 @@ export class SourceUnitMembers extends SlangNode {
     super(ast, true);
 
     this.items = ast.items.map((item) => new SourceUnitMember(item, options));
-
-    this.updateMetadata(this.items);
   }
 
   print(

src/slang-nodes/StateVariableAttributes.ts

@@ -20,8 +20,6 @@ export class StateVariableAttributes extends SlangNode {
 
     this.items = ast.items.map((item) => new StateVariableAttribute(item));
 
-    this.updateMetadata(this.items);
-
     this.items = this.items.sort(sortFunctionAttributes);
   }