Renaming HubNode as CollectionNode

Janther · Janther · commit 945b4d580b5a · 2024-08-20T20:13:00.000+12:00
diff --git a/src/slang-comments/handlers/add-collection-node-first-comment.ts b/src/slang-comments/handlers/add-collection-node-first-comment.ts
@@ -1,11 +1,11 @@
 import { util } from 'prettier';
 
-import type { Comment, HubNode } from '../../slang-nodes';
+import type { Comment, CollectionNode } from '../../slang-nodes';
 
 const { addDanglingComment, addLeadingComment } = util;
 
-export default function addHubNodeFirstComment(
-  node: HubNode,
+export default function addCollectionNodeFirstComment(
+  node: CollectionNode,
   comment: Comment
 ): void {
   if (node.items.length === 0) {
diff --git a/src/slang-comments/handlers/add-collection-node-last-comment.ts b/src/slang-comments/handlers/add-collection-node-last-comment.ts
@@ -1,11 +1,11 @@
 import { util } from 'prettier';
 
-import type { Comment, HubNode } from '../../slang-nodes';
+import type { Comment, CollectionNode } from '../../slang-nodes';
 
 const { addDanglingComment, addTrailingComment } = util;
 
-export default function addHubNodeLastComment(
-  node: HubNode,
+export default function addCollectionNodeLastComment(
+  node: CollectionNode,
   comment: Comment
 ): void {
   if (node.items.length === 0) {
diff --git a/src/slang-comments/handlers/handle-block-comments.ts b/src/slang-comments/handlers/handle-block-comments.ts
@@ -1,6 +1,6 @@
 import { NonterminalKind } from '@nomicfoundation/slang/kinds/index.js';
-import addHubNodeFirstComment from './add-hub-node-first-comment.js';
-import addHubNodeLastComment from './add-hub-node-last-comment.js';
+import addCollectionNodeFirstComment from './add-collection-node-first-comment.js';
+import addCollectionNodeLastComment from './add-collection-node-last-comment.js';
 
 import type { HandlerParams } from './types';
 
@@ -15,12 +15,12 @@ export default function handleBlockComments({
   }
 
   if (precedingNode?.kind === NonterminalKind.Statements) {
-    addHubNodeLastComment(precedingNode, comment);
+    addCollectionNodeLastComment(precedingNode, comment);
     return true;
   }
 
   if (followingNode?.kind === NonterminalKind.Statements) {
-    addHubNodeFirstComment(followingNode, comment);
+    addCollectionNodeFirstComment(followingNode, comment);
     return true;
   }
 
diff --git a/src/slang-comments/handlers/handle-contract-definition-comments.ts b/src/slang-comments/handlers/handle-contract-definition-comments.ts
@@ -1,8 +1,8 @@
 import { NonterminalKind } from '@nomicfoundation/slang/kinds/index.js';
 import { util } from 'prettier';
 import { getNextNonSpaceNonCommentCharacter } from '../../slang-utils/backward-compatibility.js';
-import addHubNodeFirstComment from './add-hub-node-first-comment.js';
-import addHubNodeLastComment from './add-hub-node-last-comment.js';
+import addCollectionNodeFirstComment from './add-collection-node-first-comment.js';
+import addCollectionNodeLastComment from './add-collection-node-last-comment.js';
 
 import type { HandlerParams } from './types';
 
@@ -34,7 +34,7 @@ export default function handleContractDefinitionComments({
 
   // The comment is at the end of the body of the ContractDefinition.
   if (precedingNode?.kind === NonterminalKind.ContractMembers) {
-    addHubNodeLastComment(precedingNode, comment);
+    addCollectionNodeLastComment(precedingNode, comment);
     return true;
   }
 
@@ -56,7 +56,7 @@ export default function handleContractDefinitionComments({
     // If there's no InheritanceSpecifier, the comment before the body is
     // assumed to be intended at the beginning of the body.
     if (followingNode?.kind === NonterminalKind.ContractMembers) {
-      addHubNodeFirstComment(followingNode, comment);
+      addCollectionNodeFirstComment(followingNode, comment);
       return true;
     }
   }
diff --git a/src/slang-comments/handlers/handle-else-branch-comments.ts b/src/slang-comments/handlers/handle-else-branch-comments.ts
@@ -1,6 +1,6 @@
 import { NonterminalKind } from '@nomicfoundation/slang/kinds/index.js';
 import { util } from 'prettier';
-import addHubNodeFirstComment from './add-hub-node-first-comment.js';
+import addCollectionNodeFirstComment from './add-collection-node-first-comment.js';
 
 import type { HandlerParams } from './types';
 
@@ -20,7 +20,7 @@ export default function handleElseBranchComments({
     followingNode.variant.kind === NonterminalKind.IfStatement
   ) {
     if (followingNode.variant.body.variant.kind === NonterminalKind.Block) {
-      addHubNodeFirstComment(
+      addCollectionNodeFirstComment(
         followingNode.variant.body.variant.statements,
         comment
       );
diff --git a/src/slang-comments/handlers/handle-if-statement-comments.ts b/src/slang-comments/handlers/handle-if-statement-comments.ts
@@ -1,7 +1,7 @@
 import { NonterminalKind } from '@nomicfoundation/slang/kinds/index.js';
 import { util } from 'prettier';
 import { getNextNonSpaceNonCommentCharacter } from '../../slang-utils/backward-compatibility.js';
-import addHubNodeFirstComment from './add-hub-node-first-comment.js';
+import addCollectionNodeFirstComment from './add-collection-node-first-comment.js';
 
 import type { HandlerParams } from './types';
 
@@ -42,7 +42,10 @@ export default function handleIfStatementComments({
 
   if (followingNode.kind === NonterminalKind.IfStatement) {
     if (followingNode.body.variant.kind === NonterminalKind.Block) {
-      addHubNodeFirstComment(followingNode.body.variant.statements, comment);
+      addCollectionNodeFirstComment(
+        followingNode.body.variant.statements,
+        comment
+      );
     } else {
       addLeadingComment(followingNode.body.variant, comment);
     }
@@ -54,7 +57,7 @@ export default function handleIfStatementComments({
   // if (a) /* comment */ true
   if (enclosingNode.body === followingNode) {
     if (followingNode.variant.kind === NonterminalKind.Block) {
-      addHubNodeFirstComment(followingNode.variant.statements, comment);
+      addCollectionNodeFirstComment(followingNode.variant.statements, comment);
     } else {
       addLeadingComment(followingNode, comment);
     }
diff --git a/src/slang-comments/handlers/handle-interface-definition-comments.ts b/src/slang-comments/handlers/handle-interface-definition-comments.ts
@@ -1,7 +1,7 @@
 import { NonterminalKind } from '@nomicfoundation/slang/kinds/index.js';
 import { getNextNonSpaceNonCommentCharacter } from '../../slang-utils/backward-compatibility.js';
-import addHubNodeFirstComment from './add-hub-node-first-comment.js';
-import addHubNodeLastComment from './add-hub-node-last-comment.js';
+import addCollectionNodeFirstComment from './add-collection-node-first-comment.js';
+import addCollectionNodeLastComment from './add-collection-node-last-comment.js';
 
 import type { HandlerParams } from './types';
 
@@ -20,7 +20,7 @@ export default function handleInterfaceDefinitionComments({
 
   // The comment is at the end of the body of the InterfaceDefinition.
   if (precedingNode?.kind === NonterminalKind.InterfaceMembers) {
-    addHubNodeLastComment(precedingNode, comment);
+    addCollectionNodeLastComment(precedingNode, comment);
     return true;
   }
 
@@ -29,7 +29,7 @@ export default function handleInterfaceDefinitionComments({
     nextCharacter === '{' &&
     followingNode?.kind === NonterminalKind.InterfaceMembers
   ) {
-    addHubNodeFirstComment(followingNode, comment);
+    addCollectionNodeFirstComment(followingNode, comment);
     return true;
   }
 
diff --git a/src/slang-comments/handlers/handle-library-definition-comments.ts b/src/slang-comments/handlers/handle-library-definition-comments.ts
@@ -1,7 +1,7 @@
 import { NonterminalKind } from '@nomicfoundation/slang/kinds/index.js';
 import { getNextNonSpaceNonCommentCharacter } from '../../slang-utils/backward-compatibility.js';
-import addHubNodeFirstComment from './add-hub-node-first-comment.js';
-import addHubNodeLastComment from './add-hub-node-last-comment.js';
+import addCollectionNodeFirstComment from './add-collection-node-first-comment.js';
+import addCollectionNodeLastComment from './add-collection-node-last-comment.js';
 
 import type { HandlerParams } from './types';
 
@@ -20,7 +20,7 @@ export default function handleLibraryDefinitionComments({
 
   // The comment is at the end of the body of the ContractDefinition.
   if (precedingNode?.kind === NonterminalKind.LibraryMembers) {
-    addHubNodeLastComment(precedingNode, comment);
+    addCollectionNodeLastComment(precedingNode, comment);
     return true;
   }
 
@@ -29,7 +29,7 @@ export default function handleLibraryDefinitionComments({
     nextCharacter === '{' &&
     followingNode?.kind === NonterminalKind.LibraryMembers
   ) {
-    addHubNodeFirstComment(followingNode, comment);
+    addCollectionNodeFirstComment(followingNode, comment);
     return true;
   }
 
diff --git a/src/slang-comments/handlers/handle-parameters-declaration-comments.ts b/src/slang-comments/handlers/handle-parameters-declaration-comments.ts
@@ -1,6 +1,6 @@
 import { NonterminalKind } from '@nomicfoundation/slang/kinds/index.js';
-import addHubNodeFirstComment from './add-hub-node-first-comment.js';
-import addHubNodeLastComment from './add-hub-node-last-comment.js';
+import addCollectionNodeFirstComment from './add-collection-node-first-comment.js';
+import addCollectionNodeLastComment from './add-collection-node-last-comment.js';
 
 import type { HandlerParams } from './types';
 
@@ -15,12 +15,12 @@ export default function handleBlockComments({
   }
 
   if (precedingNode?.kind === NonterminalKind.Parameters) {
-    addHubNodeLastComment(precedingNode, comment);
+    addCollectionNodeLastComment(precedingNode, comment);
     return true;
   }
 
   if (followingNode?.kind === NonterminalKind.Parameters) {
-    addHubNodeFirstComment(followingNode, comment);
+    addCollectionNodeFirstComment(followingNode, comment);
     return true;
   }
 
diff --git a/src/slang-comments/handlers/handle-positional-arguments-declaration-comments.ts b/src/slang-comments/handlers/handle-positional-arguments-declaration-comments.ts
@@ -1,6 +1,6 @@
 import { NonterminalKind } from '@nomicfoundation/slang/kinds/index.js';
-import addHubNodeFirstComment from './add-hub-node-first-comment.js';
-import addHubNodeLastComment from './add-hub-node-last-comment.js';
+import addCollectionNodeFirstComment from './add-collection-node-first-comment.js';
+import addCollectionNodeLastComment from './add-collection-node-last-comment.js';
 
 import type { HandlerParams } from './types';
 
@@ -15,12 +15,12 @@ export default function handlePositionalArgumentsDeclarationComments({
   }
 
   if (precedingNode?.kind === NonterminalKind.PositionalArguments) {
-    addHubNodeLastComment(precedingNode, comment);
+    addCollectionNodeLastComment(precedingNode, comment);
     return true;
   }
 
   if (followingNode?.kind === NonterminalKind.PositionalArguments) {
-    addHubNodeFirstComment(followingNode, comment);
+    addCollectionNodeFirstComment(followingNode, comment);
     return true;
   }
 
diff --git a/src/slang-comments/handlers/handle-while-statement-comments.ts b/src/slang-comments/handlers/handle-while-statement-comments.ts
@@ -1,7 +1,7 @@
 import { NonterminalKind } from '@nomicfoundation/slang/kinds/index.js';
 import { util } from 'prettier';
 import { getNextNonSpaceNonCommentCharacter } from '../../slang-utils/backward-compatibility.js';
-import addHubNodeFirstComment from './add-hub-node-first-comment.js';
+import addCollectionNodeFirstComment from './add-collection-node-first-comment.js';
 
 import type { HandlerParams } from './types';
 
@@ -34,7 +34,7 @@ export default function handleWhileStatementComments({
 
   if (enclosingNode.body === followingNode) {
     if (followingNode.variant.kind === NonterminalKind.Block) {
-      addHubNodeFirstComment(followingNode.variant.statements, comment);
+      addCollectionNodeFirstComment(followingNode.variant.statements, comment);
     } else {
       addLeadingComment(followingNode, comment);
     }
diff --git a/src/slang-nodes/index.d.ts b/src/slang-nodes/index.d.ts
@@ -244,7 +244,7 @@ export type FunctionLike =
   | ReceiveFunctionDefinition
   | UnnamedFunctionDefinition;
 
-export type HubNode =
+export type CollectionNode =
   | ArrayValues
   | AssemblyFlags
   | CallOptions
diff --git a/src/slang-printers/print-preserving-empty-lines.ts b/src/slang-printers/print-preserving-empty-lines.ts
@@ -7,13 +7,13 @@ import {
 import { locEnd } from '../slang-utils/loc.js';
 
 import type { AstPath, Doc, ParserOptions } from 'prettier';
-import type { AstNode, HubNode, StrictAstNode } from '../slang-nodes';
+import type { AstNode, CollectionNode, StrictAstNode } from '../slang-nodes';
 import type { PrintFunction } from '../types';
 
 const { hardline } = doc.builders;
 
 export function printPreservingEmptyLines(
-  path: AstPath<HubNode>,
+  path: AstPath<CollectionNode>,
   print: PrintFunction,
   options: ParserOptions<AstNode>
 ): Doc {
diff --git a/src/slang-utils/backward-compatibility.ts b/src/slang-utils/backward-compatibility.ts
@@ -4,7 +4,7 @@ import { locEnd } from './loc.js';
 
 import type { AstPath } from 'prettier';
 import type { utilV2 } from './types';
-import type { AstNode, HubNode } from '../slang-nodes';
+import type { AstNode, CollectionNode } from '../slang-nodes';
 
 export const isPrettier2 = prettierVersionSatisfies('^2.3.0');
 
@@ -35,6 +35,6 @@ export function getNextNonSpaceNonCommentCharacter(
 
 export function isLast(path: AstPath<AstNode>, index: number): boolean {
   return isPrettier2
-    ? index === (path.getParentNode() as HubNode).items.length - 1
+    ? index === (path.getParentNode() as CollectionNode).items.length - 1
     : path.isLast;
 }

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`import { NonterminalKind } from '@nomicfoundation/slang/kinds/index.js';`
`2`		`-import addHubNodeFirstComment from './add-hub-node-first-comment.js';`
`3`		`-import addHubNodeLastComment from './add-hub-node-last-comment.js';`
	`2`	`+import addCollectionNodeFirstComment from './add-collection-node-first-comment.js';`
	`3`	`+import addCollectionNodeLastComment from './add-collection-node-last-comment.js';`
`4`	`4`
`5`	`5`	`import type { HandlerParams } from './types';`
`6`	`6`
`@@ -15,12 +15,12 @@ export default function handleBlockComments({`
`15`	`15`	`}`
`16`	`16`
`17`	`17`	`if (precedingNode?.kind === NonterminalKind.Statements) {`
`18`		`- addHubNodeLastComment(precedingNode, comment);`
	`18`	`+ addCollectionNodeLastComment(precedingNode, comment);`
`19`	`19`	`return true;`
`20`	`20`	`}`
`21`	`21`
`22`	`22`	`if (followingNode?.kind === NonterminalKind.Statements) {`
`23`		`- addHubNodeFirstComment(followingNode, comment);`
	`23`	`+ addCollectionNodeFirstComment(followingNode, comment);`
`24`	`24`	`return true;`
`25`	`25`	`}`
`26`	`26`