move utility functions to their own files

Author: Janther

src/slang-comments/printer.ts

@@ -1,32 +1,7 @@
-import { doc } from 'prettier';
 import { isComment } from '../slang-utils/is-comment.js';
 
 import type { AstPath, Doc } from 'prettier';
-import type { AstNode, BlockComment } from '../slang-nodes';
-
-const { hardline, join } = doc.builders;
-
-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
-  // back first.
-  const lines = comment.value.slice(1, -1).split('\n');
-  return lines.length > 1 && lines.every((line) => line.trimStart()[0] === '*');
-}
-
-export function printIndentableBlockComment(comment: BlockComment): Doc {
-  const lines = comment.value.split('\n');
-
-  return join(
-    hardline,
-    lines.map((line, index) =>
-      index === 0
-        ? line.trimEnd()
-        : ` ${index < lines.length - 1 ? line.trim() : line.trimStart()}`
-    )
-  );
-}
+import type { AstNode } from '../slang-nodes';
 
 export function printComment(commentPath: AstPath<AstNode>): Doc {
   const comment = commentPath.getNode()!;

src/slang-nodes/MultiLineComment.ts

@@ -1,10 +1,8 @@
 import { TerminalNode } from '@nomicfoundation/slang/cst/index.js';
 import { TerminalKind } from '@nomicfoundation/slang/kinds/index.js';
 import { doc } from 'prettier';
-import {
-  isIndentableBlockComment,
-  printIndentableBlockComment
-} from '../slang-comments/printer.js';
+import { isIndentableBlockComment } from '../slang-utils/is-indentable-block-comment.js';
+import { printIndentableBlockComment } from '../slang-printers/print-indentable-block-comment.js';
 
 import type { Doc } from 'prettier';
 import type { BaseComment, Location, SlangNode } from '../types';

src/slang-nodes/MultiLineNatSpecComment.ts

@@ -1,10 +1,8 @@
 import { TerminalNode } from '@nomicfoundation/slang/cst/index.js';
 import { TerminalKind } from '@nomicfoundation/slang/kinds/index.js';
 import { doc } from 'prettier';
-import {
-  isIndentableBlockComment,
-  printIndentableBlockComment
-} from '../slang-comments/printer.js';
+import { isIndentableBlockComment } from '../slang-utils/is-indentable-block-comment.js';
+import { printIndentableBlockComment } from '../slang-printers/print-indentable-block-comment.js';
 
 import type { Doc } from 'prettier';
 import type { BaseComment, Location, SlangNode } from '../types';

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

@@ -0,0 +1,19 @@
+import { doc } from 'prettier';
+
+import type { Doc } from 'prettier';
+import type { BlockComment } from '../slang-nodes';
+
+const { hardline, join } = doc.builders;
+
+export function printIndentableBlockComment(comment: BlockComment): Doc {
+  const lines = comment.value.split('\n');
+
+  return join(
+    hardline,
+    lines.map((line, index) =>
+      index === 0
+        ? line.trimEnd()
+        : ` ${index < lines.length - 1 ? line.trim() : line.trimStart()}`
+    )
+  );
+}

src/slang-utils/is-indentable-block-comment.ts

@@ -0,0 +1,10 @@
+import { BlockComment } from '../slang-nodes';
+
+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
+  // back first.
+  const lines = comment.value.slice(1, -1).split('\n');
+  return lines.length > 1 && lines.every((line) => line.trimStart()[0] === '*');
+}

src/slang-utils/metadata.ts

@@ -38,7 +38,7 @@ function getLeadingOffset(children: Node[]): number {
 export function getNodeMetadata(
   ast: SlangAstNode,
   initialOffset: number,
-  includePeripheralComments = false
+  enclosePeripheralComments = false
 ): Metadata {
   if (typeof initialOffset === 'undefined') {
     throw new Error("Can't initiate metadata with an undefined initialOffset");
@@ -86,10 +86,10 @@ export function getNodeMetadata(
     return offsetsArray;
   }, []);
 
-  const leadingOffset = includePeripheralComments
+  const leadingOffset = enclosePeripheralComments
     ? 0
     : getLeadingOffset(children);
-  const trailingOffset = includePeripheralComments
+  const trailingOffset = enclosePeripheralComments
     ? 0
     : getLeadingOffset(children.reverse());
   const loc = {