mainly addressed the repetition of the comment handler and a small review of the handlers in general (#1469)

Author: Janther

src/slang-comments/handler.ts

@@ -1,69 +1,28 @@
 import handlers from './handlers/index.js';
 
-import type { ParserOptions } from 'prettier';
-import type { AstNode, Comment } from '../slang-nodes/types.d.ts';
+import type { Comment } from '../slang-nodes/types.d.ts';
 
-function ownLine(
+function handler(
   comment: Comment,
-  text: string,
-  options: ParserOptions<AstNode>,
-  ast: AstNode,
-  isLastComment: boolean
+  text: string
+  // options: ParserOptions<AstNode>,
+  // ast: AstNode,
+  // isLastComment: boolean
 ): boolean {
   const { precedingNode, enclosingNode, followingNode } = comment;
   const handlerArguments = {
     text,
     precedingNode,
     enclosingNode,
     followingNode,
-    comment,
-    ast,
-    isLastComment
+    comment
   };
 
   return handlers.some((handler) => handler(handlerArguments));
 }
 
-function endOfLine(
-  comment: Comment,
-  text: string,
-  options: ParserOptions<AstNode>,
-  ast: AstNode,
-  isLastComment: boolean
-): boolean {
-  const { precedingNode, enclosingNode, followingNode } = comment;
-  const handlerArguments = {
-    text,
-    precedingNode,
-    enclosingNode,
-    followingNode,
-    comment,
-    ast,
-    isLastComment
-  };
-
-  return handlers.some((handler) => handler(handlerArguments));
-}
-
-function remaining(
-  comment: Comment,
-  text: string,
-  options: ParserOptions<AstNode>,
-  ast: AstNode,
-  isLastComment: boolean
-): boolean {
-  const { precedingNode, enclosingNode, followingNode } = comment;
-  const handlerArguments = {
-    text,
-    precedingNode,
-    enclosingNode,
-    followingNode,
-    comment,
-    ast,
-    isLastComment
-  };
-
-  return handlers.some((handler) => handler(handlerArguments));
-}
-
-export const handleComments = { ownLine, endOfLine, remaining };
+export const handleComments = {
+  ownLine: handler,
+  endOfLine: handler,
+  remaining: handler
+};

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

@@ -11,7 +11,7 @@ export default function handleElseBranchComments({
   followingNode,
   comment
 }: HandlerParams): boolean {
-  if (enclosingNode?.kind !== NonterminalKind.ElseBranch || !followingNode) {
+  if (enclosingNode?.kind !== NonterminalKind.ElseBranch) {
     return false;
   }
 

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

@@ -14,7 +14,7 @@ export default function handleIfStatementComments({
   followingNode,
   comment
 }: HandlerParams): boolean {
-  if (enclosingNode?.kind !== NonterminalKind.IfStatement || !followingNode) {
+  if (enclosingNode?.kind !== NonterminalKind.IfStatement) {
     return false;
   }
 
@@ -43,7 +43,7 @@ export default function handleIfStatementComments({
     return true;
   }
 
-  if (followingNode.kind === NonterminalKind.IfStatement) {
+  if (followingNode?.kind === NonterminalKind.IfStatement) {
     if (followingNode.body.kind === NonterminalKind.Block) {
       addCollectionFirstComment(followingNode.body.statements, comment);
     } else {

…ments/handlers/handle-struct-comments.ts …ers/handle-struct-definition-comments.tssrc/slang-comments/handlers/handle-struct-comments.ts renamed to src/slang-comments/handlers/handle-struct-definition-comments.ts src/slang-comments/handlers/handle-struct-comments.ts renamed to src/slang-comments/handlers/handle-struct-definition-comments.ts

@@ -6,7 +6,7 @@ import addCollectionLastComment from './add-collection-last-comment.js';
 
 import type { HandlerParams } from './types.d.ts';
 
-export default function handleStructComments({
+export default function handleStructDefinitionComments({
   text,
   precedingNode,
   enclosingNode,

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

@@ -14,10 +14,7 @@ export default function handleWhileStatementComments({
   followingNode,
   comment
 }: HandlerParams): boolean {
-  if (
-    enclosingNode?.kind !== NonterminalKind.WhileStatement ||
-    !followingNode
-  ) {
+  if (enclosingNode?.kind !== NonterminalKind.WhileStatement) {
     return false;
   }
 

src/slang-comments/handlers/index.ts

@@ -10,7 +10,7 @@ import handleParametersDeclarationComments from './handle-parameters-declaration
 import handlePositionalArgumentsDeclarationComments from './handle-positional-arguments-declaration-comments.js';
 import handleSourceUnitMembersComments from './handle-source-unit-members-comments.js';
 import handleStorageLayoutSpecifierComments from './handle-storage-layout-specifier-comments.js';
-import handleStructComments from './handle-struct-comments.js';
+import handleStructDefinitionComments from './handle-struct-definition-comments.js';
 import handleWhileStatementComments from './handle-while-statement-comments.js';
 import handleYulBlockComments from './handle-yul-block-comments.js';
 
@@ -27,7 +27,7 @@ export default [
   handlePositionalArgumentsDeclarationComments,
   handleSourceUnitMembersComments,
   handleStorageLayoutSpecifierComments,
-  handleStructComments,
+  handleStructDefinitionComments,
   handleWhileStatementComments,
   handleYulBlockComments
 ];

src/slang-nodes/SlangNode.ts

@@ -44,7 +44,7 @@ export abstract class SlangNode {
     enclosePeripheralComments = false
   ) {
     if (ast instanceof SlangTerminalNode) {
-      const start = collected.offsets.get(ast.id) || 0;
+      const start = collected.offsets.get(ast.id) ?? 0;
       const end = start + ast.textLength.utf16;
       this.loc = {
         outerStart: start,
@@ -56,7 +56,7 @@ export abstract class SlangNode {
     }
     const cst = ast.cst;
 
-    const initialOffset = collected.offsets.get(cst.id) || 0;
+    const initialOffset = collected.offsets.get(cst.id) ?? 0;
     let offset = initialOffset;
     let triviaLength = 0;
     let leadingOffset;