small rebase to organise readability

Author: Janther

src/slang-nodes/MultiLineComment.ts

@@ -1,32 +1,22 @@
 import { TerminalKind } from '@nomicfoundation/slang/cst';
-import { doc } from 'prettier';
-import { isIndentableBlockComment } from '../slang-utils/is-indentable-block-comment.js';
-import { printIndentableBlockComment } from '../slang-printers/print-indentable-block-comment.js';
+import { printBlockComment } from '../slang-printers/print-block-comment.js';
 import { CommentNode } from './CommentNode.js';
 
 import type { TerminalNode } from '@nomicfoundation/slang/cst';
 import type { Doc } from 'prettier';
 
-const { join, literalline } = doc.builders;
-
 export class MultiLineComment extends CommentNode {
   readonly kind = TerminalKind.MultiLineComment;
 
   value: string;
 
-  lines: string[];
-
   constructor(ast: TerminalNode, offset: number) {
     super(ast, offset);
 
     this.value = ast.unparse();
-    this.lines = this.value.slice(1).split('\n');
   }
 
   print(): Doc {
-    if (isIndentableBlockComment(this)) {
-      return printIndentableBlockComment(this);
-    }
-    return ['/', join(literalline, this.lines)];
+    return printBlockComment(this);
   }
 }

src/slang-nodes/MultiLineNatSpecComment.ts

@@ -1,32 +1,22 @@
 import { TerminalKind } from '@nomicfoundation/slang/cst';
-import { doc } from 'prettier';
-import { isIndentableBlockComment } from '../slang-utils/is-indentable-block-comment.js';
-import { printIndentableBlockComment } from '../slang-printers/print-indentable-block-comment.js';
+import { printBlockComment } from '../slang-printers/print-block-comment.js';
 import { CommentNode } from './CommentNode.js';
 
 import type { TerminalNode } from '@nomicfoundation/slang/cst';
 import type { Doc } from 'prettier';
 
-const { join, literalline } = doc.builders;
-
 export class MultiLineNatSpecComment extends CommentNode {
   readonly kind = TerminalKind.MultiLineNatSpecComment;
 
   value: string;
 
-  lines: string[];
-
   constructor(ast: TerminalNode, offset: number) {
     super(ast, offset);
 
     this.value = ast.unparse();
-    this.lines = this.value.slice(1).split('\n');
   }
 
   print(): Doc {
-    if (isIndentableBlockComment(this)) {
-      return printIndentableBlockComment(this);
-    }
-    return ['/', join(literalline, this.lines)];
+    return printBlockComment(this);
   }
 }

src/slang-printers/print-block-comment.ts

@@ -0,0 +1,35 @@
+import { doc } from 'prettier';
+
+import type { Doc } from 'prettier';
+import type { BlockComment } from '../slang-nodes/types.d.ts';
+
+const { hardline, join, literalline } = doc.builders;
+
+function isIndentableBlockComment(lines: string[]): boolean {
+  // If the comment has multiple lines and every line starts with a star
+  // we can fix the indentation of each line.
+  return lines.length > 1 && lines.every((line) => line.trimStart()[0] === '*');
+}
+
+function printIndentableBlockComment(lines: string[]): Doc {
+  return join(
+    hardline,
+    lines.map((line, index) =>
+      index === 0
+        ? line.trimEnd()
+        : ` ${index < lines.length - 1 ? line.trim() : line.trimStart()}`
+    )
+  );
+}
+
+export function printBlockComment(comment: BlockComment): Doc {
+  // We remove the initial `/` to check if every line starts with `*`
+  const lines = comment.value.slice(1).split('\n');
+
+  return [
+    '/',
+    isIndentableBlockComment(lines)
+      ? printIndentableBlockComment(lines)
+      : join(literalline, lines)
+  ];
+}