Using node instead of getNode() (#1167)

* use the node and grandparent getters instead of getNode() and getNode(2)

* small refactor

* using destructuring when possible

* `i` should start at 2 instead of 0 because it's always used as `i + 2`

* small optimisations when we only need the destructured `node`

* variable is only used within the for loop

* more accurate type to avoid type assertion and destructure

* access the variant directly in the for..of loops

* since using the constant `groupId` there is no need for the group to be stored in a variable and can go directly in the resulting document

* other destructuring and variable caching that where missing

* using existing helper

* reordering import

* cleaning up extra check for existence of variable

* missing types annotations

* fixing some file extensions

* `offset` by definition equals to `initialOffset + parent.textLength.utf16` after having collected the `textLength.utf16` of all the `children`

* only check once for the value of a boolean

* using an actual `for...in` loop instead of storing the keys in an array and then using a `for...of` loop

* null check is not needed

* undo the destructuring of single variable that did not improve the filesize

Author: Janther

src/index.ts

@@ -51,10 +51,8 @@ const parsers = {
   [antlrParserId]: antlrParser
 };
 
-const antlrCanAttachComment = (node: { type: string }): boolean =>
-  typeof node.type === 'string' &&
-  node.type !== 'BlockComment' &&
-  node.type !== 'LineComment';
+const antlrCanAttachComment = ({ type }: { type: string }): boolean =>
+  typeof type === 'string' && type !== 'BlockComment' && type !== 'LineComment';
 const canAttachComment = (node: AstNode): boolean =>
   typeof node !== 'string' &&
   typeof node !== 'undefined' &&

src/slang-comments/handlers/add-collection-node-first-comment.ts renamed to src/slang-comments/handlers/add-collection-first-comment.ts

@@ -1,11 +1,11 @@
 import { util } from 'prettier';
 
-import type { Comment, CollectionNode } from '../../slang-nodes/types.d.ts';
+import type { Comment, Collection } from '../../slang-nodes/types.d.ts';
 
 const { addDanglingComment, addLeadingComment } = util;
 
-export default function addCollectionNodeFirstComment(
-  node: CollectionNode,
+export default function addCollectionFirstComment(
+  node: Collection,
   comment: Comment
 ): void {
   if (node.items.length === 0) {

src/slang-comments/handlers/add-collection-node-last-comment.ts renamed to src/slang-comments/handlers/add-collection-last-comment.ts

@@ -1,11 +1,11 @@
 import { util } from 'prettier';
 
-import type { Comment, CollectionNode } from '../../slang-nodes/types.d.ts';
+import type { Comment, Collection } from '../../slang-nodes/types.d.ts';
 
 const { addDanglingComment, addTrailingComment } = util;
 
-export default function addCollectionNodeLastComment(
-  node: CollectionNode,
+export default function addCollectionLastComment(
+  node: Collection,
   comment: Comment
 ): void {
   if (node.items.length === 0) {

src/slang-comments/handlers/handle-block-comments.ts

@@ -1,6 +1,6 @@
 import { NonterminalKind } from '@nomicfoundation/slang/cst';
-import addCollectionNodeFirstComment from './add-collection-node-first-comment.js';
-import addCollectionNodeLastComment from './add-collection-node-last-comment.js';
+import addCollectionFirstComment from './add-collection-first-comment.js';
+import addCollectionLastComment from './add-collection-last-comment.js';
 
 import type { HandlerParams } from './types.d.ts';
 
@@ -15,12 +15,12 @@ export default function handleBlockComments({
   }
 
   if (precedingNode?.kind === NonterminalKind.Statements) {
-    addCollectionNodeLastComment(precedingNode, comment);
+    addCollectionLastComment(precedingNode, comment);
     return true;
   }
 
   if (followingNode?.kind === NonterminalKind.Statements) {
-    addCollectionNodeFirstComment(followingNode, comment);
+    addCollectionFirstComment(followingNode, comment);
     return true;
   }
 

src/slang-comments/handlers/handle-contract-definition-comments.ts

@@ -1,7 +1,7 @@
 import { NonterminalKind } from '@nomicfoundation/slang/cst';
 import { util } from 'prettier';
 import { locEnd } from '../../slang-utils/loc.js';
-import addCollectionNodeLastComment from './add-collection-node-last-comment.js';
+import addCollectionLastComment from './add-collection-last-comment.js';
 
 import type { HandlerParams } from './types.d.ts';
 
@@ -36,7 +36,7 @@ export default function handleContractDefinitionComments({
 
   // The comment is at the end of the body of the ContractDefinition.
   if (precedingNode?.kind === NonterminalKind.ContractMembers) {
-    addCollectionNodeLastComment(precedingNode, comment);
+    addCollectionLastComment(precedingNode, comment);
     return true;
   }
 
@@ -52,7 +52,7 @@ export default function handleContractDefinitionComments({
       // If the last ContractSpecifier's an InheritanceSpecifier, the comment
       // is appended to the last InheritanceType.
       if (lastContractSpecifier.kind === NonterminalKind.InheritanceSpecifier) {
-        addCollectionNodeLastComment(lastContractSpecifier.types, comment);
+        addCollectionLastComment(lastContractSpecifier.types, comment);
         return true;
       }
       if (

src/slang-comments/handlers/handle-contract-specifiers-comments.ts

@@ -1,6 +1,6 @@
 import { NonterminalKind } from '@nomicfoundation/slang/cst';
 import { util } from 'prettier';
-import addCollectionNodeLastComment from './add-collection-node-last-comment.js';
+import addCollectionLastComment from './add-collection-last-comment.js';
 
 import type { HandlerParams } from './types.d.ts';
 
@@ -20,7 +20,7 @@ export default function handleContractSpecifiersComments({
     precedingNode.kind === NonterminalKind.ContractSpecifier
   ) {
     if (precedingNode.variant.kind === NonterminalKind.InheritanceSpecifier) {
-      addCollectionNodeLastComment(precedingNode.variant.types, comment);
+      addCollectionLastComment(precedingNode.variant.types, comment);
       return true;
     }
     if (precedingNode.variant.kind === NonterminalKind.StorageLayoutSpecifier) {

src/slang-comments/handlers/handle-else-branch-comments.ts

@@ -1,6 +1,6 @@
 import { NonterminalKind } from '@nomicfoundation/slang/cst';
 import { util } from 'prettier';
-import addCollectionNodeFirstComment from './add-collection-node-first-comment.js';
+import addCollectionFirstComment from './add-collection-first-comment.js';
 
 import type { HandlerParams } from './types.d.ts';
 
@@ -20,7 +20,7 @@ export default function handleElseBranchComments({
     followingNode.variant.kind === NonterminalKind.IfStatement
   ) {
     if (followingNode.variant.body.variant.kind === NonterminalKind.Block) {
-      addCollectionNodeFirstComment(
+      addCollectionFirstComment(
         followingNode.variant.body.variant.statements,
         comment
       );

src/slang-comments/handlers/handle-if-statement-comments.ts

@@ -1,7 +1,7 @@
 import { NonterminalKind } from '@nomicfoundation/slang/cst';
 import { util } from 'prettier';
 import { locEnd } from '../../slang-utils/loc.js';
-import addCollectionNodeFirstComment from './add-collection-node-first-comment.js';
+import addCollectionFirstComment from './add-collection-first-comment.js';
 
 import type { HandlerParams } from './types.d.ts';
 
@@ -45,10 +45,7 @@ export default function handleIfStatementComments({
 
   if (followingNode.kind === NonterminalKind.IfStatement) {
     if (followingNode.body.variant.kind === NonterminalKind.Block) {
-      addCollectionNodeFirstComment(
-        followingNode.body.variant.statements,
-        comment
-      );
+      addCollectionFirstComment(followingNode.body.variant.statements, comment);
     } else {
       addLeadingComment(followingNode.body.variant, comment);
     }
@@ -60,7 +57,7 @@ export default function handleIfStatementComments({
   // if (a) /* comment */ true
   if (enclosingNode.body === followingNode) {
     if (followingNode.variant.kind === NonterminalKind.Block) {
-      addCollectionNodeFirstComment(followingNode.variant.statements, comment);
+      addCollectionFirstComment(followingNode.variant.statements, comment);
     } else {
       addLeadingComment(followingNode, comment);
     }

src/slang-comments/handlers/handle-interface-definition-comments.ts

@@ -1,8 +1,8 @@
 import { NonterminalKind } from '@nomicfoundation/slang/cst';
 import { util } from 'prettier';
 import { locEnd } from '../../slang-utils/loc.js';
-import addCollectionNodeFirstComment from './add-collection-node-first-comment.js';
-import addCollectionNodeLastComment from './add-collection-node-last-comment.js';
+import addCollectionFirstComment from './add-collection-first-comment.js';
+import addCollectionLastComment from './add-collection-last-comment.js';
 
 import type { HandlerParams } from './types.d.ts';
 
@@ -24,7 +24,7 @@ export default function handleInterfaceDefinitionComments({
 
   // The comment is at the end of the body of the InterfaceDefinition.
   if (precedingNode?.kind === NonterminalKind.InterfaceMembers) {
-    addCollectionNodeLastComment(precedingNode, comment);
+    addCollectionLastComment(precedingNode, comment);
     return true;
   }
 
@@ -33,7 +33,7 @@ export default function handleInterfaceDefinitionComments({
     nextCharacter === '{' &&
     followingNode?.kind === NonterminalKind.InterfaceMembers
   ) {
-    addCollectionNodeFirstComment(followingNode, comment);
+    addCollectionFirstComment(followingNode, comment);
     return true;
   }
 

src/slang-comments/handlers/handle-library-definition-comments.ts

@@ -1,8 +1,8 @@
 import { NonterminalKind } from '@nomicfoundation/slang/cst';
 import { util } from 'prettier';
 import { locEnd } from '../../slang-utils/loc.js';
-import addCollectionNodeFirstComment from './add-collection-node-first-comment.js';
-import addCollectionNodeLastComment from './add-collection-node-last-comment.js';
+import addCollectionFirstComment from './add-collection-first-comment.js';
+import addCollectionLastComment from './add-collection-last-comment.js';
 
 import type { HandlerParams } from './types.d.ts';
 
@@ -24,7 +24,7 @@ export default function handleLibraryDefinitionComments({
 
   // The comment is at the end of the body of the ContractDefinition.
   if (precedingNode?.kind === NonterminalKind.LibraryMembers) {
-    addCollectionNodeLastComment(precedingNode, comment);
+    addCollectionLastComment(precedingNode, comment);
     return true;
   }
 
@@ -33,7 +33,7 @@ export default function handleLibraryDefinitionComments({
     nextCharacter === '{' &&
     followingNode?.kind === NonterminalKind.LibraryMembers
   ) {
-    addCollectionNodeFirstComment(followingNode, comment);
+    addCollectionFirstComment(followingNode, comment);
     return true;
   }