Comments now are AstNodes, cleaning up types and logic

Author: Janther

src/index.ts

@@ -17,7 +17,6 @@ import type {
   SupportLanguage
 } from 'prettier';
 import type { AstNode } from './slang-nodes';
-import type { Comment } from './types';
 
 const parserName = 'slang';
 const astFormat = 'slang-ast';
@@ -54,10 +53,10 @@ const solidityCanAttachComment = (node: { type: string }): boolean =>
   typeof node.type === 'string' &&
   node.type !== 'BlockComment' &&
   node.type !== 'LineComment';
-const canAttachComment = (node: AstNode | Comment): boolean =>
+const canAttachComment = (node: AstNode): boolean =>
   typeof node !== 'string' &&
   typeof node !== 'undefined' &&
-  node.kind &&
+  node.kind && // Make sure it's not Location
   !isComment(node);
 
 // https://prettier.io/docs/en/plugins.html#printers

src/slang-comments/handler.ts

@@ -1,8 +1,7 @@
 import handlers from './handlers/index.js';
 
 import type { ParserOptions } from 'prettier';
-import type { AstNode } from '../slang-nodes';
-import type { Comment } from '../types';
+import type { AstNode, Comment } from '../slang-nodes';
 
 function ownLine(
   comment: Comment,

src/slang-comments/handlers/add-hub-node-first-comment.ts

@@ -1,7 +1,6 @@
 import { util } from 'prettier';
 
-import type { HubNode } from '../../slang-nodes';
-import type { Comment } from '../../types';
+import type { Comment, HubNode } from '../../slang-nodes';
 
 const { addDanglingComment, addLeadingComment } = util;
 

src/slang-comments/handlers/add-hub-node-last-comment.ts

@@ -1,7 +1,6 @@
 import { util } from 'prettier';
 
-import type { HubNode } from '../../slang-nodes';
-import type { Comment } from '../../types';
+import type { Comment, HubNode } from '../../slang-nodes';
 
 const { addDanglingComment, addTrailingComment } = util;
 

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

@@ -4,22 +4,9 @@ import { getNextNonSpaceNonCommentCharacter } from '../../slang-utils/backward-c
 import addHubNodeFirstComment from './add-hub-node-first-comment.js';
 
 import type { HandlerParams } from './types';
-import type { StatementVariant } from '../../slang-nodes/index.js';
-import type { Comment } from '../../types.js';
 
 const { addLeadingComment, addTrailingComment } = util;
 
-function addIfStatementBodyFirstComment(
-  node: StatementVariant,
-  comment: Comment
-): void {
-  if (node.kind === NonterminalKind.Block) {
-    addHubNodeFirstComment(node.statements, comment);
-  } else {
-    addLeadingComment(node, comment);
-  }
-}
-
 export default function handleIfStatementComments({
   text,
   precedingNode,
@@ -54,7 +41,11 @@ export default function handleIfStatementComments({
   }
 
   if (followingNode.kind === NonterminalKind.IfStatement) {
-    addIfStatementBodyFirstComment(followingNode.body.variant, comment);
+    if (followingNode.body.variant.kind === NonterminalKind.Block) {
+      addHubNodeFirstComment(followingNode.body.variant.statements, comment);
+    } else {
+      addLeadingComment(followingNode.body.variant, comment);
+    }
     return true;
   }
 

src/slang-comments/handlers/types.d.ts

@@ -1,5 +1,4 @@
-import type { StrictAstNode } from '../../slang-nodes';
-import type { Comment } from '../../types';
+import type { Comment, StrictAstNode } from '../../slang-nodes';
 
 interface HandlerParams {
   text: string;

src/slang-comments/printer.ts

@@ -1,13 +1,12 @@
 import { doc } from 'prettier';
-import { isBlockComment, isLineComment } from '../slang-utils/is-comment.js';
+import { isComment } from '../slang-utils/is-comment.js';
 
 import type { AstPath, Doc } from 'prettier';
-import type { AstNode } from '../slang-nodes';
-import type { Comment } from '../types';
+import type { AstNode, BlockComment } from '../slang-nodes';
 
-const { hardline, join, literalline } = doc.builders;
+const { hardline, join } = doc.builders;
 
-function isIndentableBlockComment(comment: Comment): boolean {
+export function isIndentableBlockComment(comment: BlockComment): boolean {
   // If the comment has multiple lines and every line starts with a star
   // we can fix the indentation of each line. The stars in the `/*` and
   // `*/` delimiters are not included in the comment value, so add them
@@ -16,7 +15,7 @@ function isIndentableBlockComment(comment: Comment): boolean {
   return lines.length > 1 && lines.every((line) => line.trimStart()[0] === '*');
 }
 
-function printIndentableBlockComment(comment: Comment): Doc {
+export function printIndentableBlockComment(comment: BlockComment): Doc {
   const lines = comment.value.split('\n');
 
   return join(
@@ -29,19 +28,11 @@ function printIndentableBlockComment(comment: Comment): Doc {
   );
 }
 
-export function printComment(commentPath: AstPath<AstNode | Comment>): Doc {
+export function printComment(commentPath: AstPath<AstNode>): Doc {
   const comment = commentPath.getNode()!;
 
-  if (isLineComment(comment)) {
-    return comment.value.trimEnd();
-  }
-
-  if (isBlockComment(comment)) {
-    if (isIndentableBlockComment(comment)) {
-      return printIndentableBlockComment(comment);
-    }
-
-    return join(literalline, comment.value.split('\n'));
+  if (isComment(comment)) {
+    return comment.print();
   }
 
   throw new Error(`Not a comment: ${JSON.stringify(comment)}`);

src/slang-nodes/Identifier.ts

@@ -2,14 +2,15 @@ import { TerminalNode } from '@nomicfoundation/slang/cst/index.js';
 import { TerminalKind } from '@nomicfoundation/slang/kinds/index.js';
 
 import type { Doc } from 'prettier';
-import type { AstLocation, Comment, SlangNode } from '../types';
+import type { Location, SlangNode } from '../types';
+import type { Comment } from '.';
 
 export class Identifier implements SlangNode {
   readonly kind = TerminalKind.Identifier;
 
   comments: Comment[];
 
-  loc: AstLocation;
+  loc: Location;
 
   value: string;
 
@@ -19,9 +20,7 @@ export class Identifier implements SlangNode {
     this.comments = [];
     this.loc = {
       start: offset,
-      end: offset + ast.textLength.utf16,
-      leadingOffset: 0,
-      trailingOffset: 0
+      end: offset + ast.textLength.utf16
     };
   }
 

src/slang-nodes/ModifierDefinition.ts

@@ -17,6 +17,7 @@ const objectConfig = {
   enumerable: true,
   configurable: true
 };
+
 export class ModifierDefinition implements SlangNode {
   readonly kind = NonterminalKind.ModifierDefinition;
 

src/slang-nodes/ModifierInvocation.ts

@@ -46,7 +46,7 @@ export class ModifierInvocation implements SlangNode {
         this.arguments.variant.kind ===
           NonterminalKind.PositionalArgumentsDeclaration &&
         this.arguments.variant.arguments.items.length === 0 && // no arguments
-        !ast.arguments!.variant.cst.children().some((child) => isComment(child)) // no comments
+        !ast.arguments!.variant.cst.children().some((child) => isComment(child)) // no comments, at this point we need to check the CST
       ) {
         this.arguments = undefined;
       }