move indented preserved empty lines logic into it's own function (#1528)

Janther · web-flow · commit 163f6e2c4036 · 2026-04-28T09:18:11.000-04:00
* move indented preserved empty lines logic into it's own function

* Nullish Coalescing Operator is more accurate for describing undefined comments length
diff --git a/src/slang-nodes/ContractMembers.ts b/src/slang-nodes/ContractMembers.ts
@@ -1,7 +1,5 @@
 import { NonterminalKind } from '@nomicfoundation/slang/cst';
-import { doc } from 'prettier';
-import { printSeparatedItem } from '../slang-printers/print-separated-item.js';
-import { printPreservingEmptyLines } from '../slang-printers/print-preserving-empty-lines.js';
+import { printIndentedPreservingEmptyLines } from '../slang-printers/print-preserving-empty-lines.js';
 import { extractVariant } from '../slang-utils/extract-variant.js';
 import { SlangNode } from './SlangNode.js';
 import { ContractMember } from './ContractMember.js';
@@ -11,8 +9,6 @@ import type { AstPath, Doc, ParserOptions } from 'prettier';
 import type { CollectedMetadata, PrintFunction } from '../types.d.ts';
 import type { PrintableNode } from './types.d.ts';
 
-const { hardline } = doc.builders;
-
 export class ContractMembers extends SlangNode {
   readonly kind = NonterminalKind.ContractMembers;
 
@@ -35,11 +31,6 @@ export class ContractMembers extends SlangNode {
     path: AstPath<ContractMembers>,
     options: ParserOptions<PrintableNode>
   ): Doc {
-    return this.items.length > 0 || (this.comments?.length || 0) > 0
-      ? printSeparatedItem(
-          printPreservingEmptyLines(this, path, print, options),
-          { firstSeparator: hardline }
-        )
-      : '';
+    return printIndentedPreservingEmptyLines(this, path, print, options);
   }
 }
diff --git a/src/slang-nodes/InterfaceMembers.ts b/src/slang-nodes/InterfaceMembers.ts
@@ -1,7 +1,5 @@
 import { NonterminalKind } from '@nomicfoundation/slang/cst';
-import { doc } from 'prettier';
-import { printSeparatedItem } from '../slang-printers/print-separated-item.js';
-import { printPreservingEmptyLines } from '../slang-printers/print-preserving-empty-lines.js';
+import { printIndentedPreservingEmptyLines } from '../slang-printers/print-preserving-empty-lines.js';
 import { extractVariant } from '../slang-utils/extract-variant.js';
 import { SlangNode } from './SlangNode.js';
 import { ContractMember } from './ContractMember.js';
@@ -11,8 +9,6 @@ import type { AstPath, Doc, ParserOptions } from 'prettier';
 import type { CollectedMetadata, PrintFunction } from '../types.d.ts';
 import type { PrintableNode } from './types.d.ts';
 
-const { hardline } = doc.builders;
-
 export class InterfaceMembers extends SlangNode {
   readonly kind = NonterminalKind.InterfaceMembers;
 
@@ -35,11 +31,6 @@ export class InterfaceMembers extends SlangNode {
     path: AstPath<InterfaceMembers>,
     options: ParserOptions<PrintableNode>
   ): Doc {
-    return this.items.length > 0 || (this.comments?.length || 0) > 0
-      ? printSeparatedItem(
-          printPreservingEmptyLines(this, path, print, options),
-          { firstSeparator: hardline }
-        )
-      : '';
+    return printIndentedPreservingEmptyLines(this, path, print, options);
   }
 }
diff --git a/src/slang-nodes/LibraryMembers.ts b/src/slang-nodes/LibraryMembers.ts
@@ -1,7 +1,5 @@
 import { NonterminalKind } from '@nomicfoundation/slang/cst';
-import { doc } from 'prettier';
-import { printSeparatedItem } from '../slang-printers/print-separated-item.js';
-import { printPreservingEmptyLines } from '../slang-printers/print-preserving-empty-lines.js';
+import { printIndentedPreservingEmptyLines } from '../slang-printers/print-preserving-empty-lines.js';
 import { extractVariant } from '../slang-utils/extract-variant.js';
 import { SlangNode } from './SlangNode.js';
 import { ContractMember } from './ContractMember.js';
@@ -11,8 +9,6 @@ import type { AstPath, Doc, ParserOptions } from 'prettier';
 import type { CollectedMetadata, PrintFunction } from '../types.d.ts';
 import type { PrintableNode } from './types.d.ts';
 
-const { hardline } = doc.builders;
-
 export class LibraryMembers extends SlangNode {
   readonly kind = NonterminalKind.LibraryMembers;
 
@@ -35,11 +31,6 @@ export class LibraryMembers extends SlangNode {
     path: AstPath<LibraryMembers>,
     options: ParserOptions<PrintableNode>
   ): Doc {
-    return this.items.length > 0 || (this.comments?.length || 0) > 0
-      ? printSeparatedItem(
-          printPreservingEmptyLines(this, path, print, options),
-          { firstSeparator: hardline }
-        )
-      : '';
+    return printIndentedPreservingEmptyLines(this, path, print, options);
   }
 }
diff --git a/src/slang-nodes/Statements.ts b/src/slang-nodes/Statements.ts
@@ -1,7 +1,5 @@
 import { NonterminalKind } from '@nomicfoundation/slang/cst';
-import { doc } from 'prettier';
-import { printSeparatedItem } from '../slang-printers/print-separated-item.js';
-import { printPreservingEmptyLines } from '../slang-printers/print-preserving-empty-lines.js';
+import { printIndentedPreservingEmptyLines } from '../slang-printers/print-preserving-empty-lines.js';
 import { extractVariant } from '../slang-utils/extract-variant.js';
 import { SlangNode } from './SlangNode.js';
 import { Statement } from './Statement.js';
@@ -11,8 +9,6 @@ import type { AstPath, Doc, ParserOptions } from 'prettier';
 import type { CollectedMetadata, PrintFunction } from '../types.d.ts';
 import type { PrintableNode } from './types.d.ts';
 
-const { hardline } = doc.builders;
-
 export class Statements extends SlangNode {
   readonly kind = NonterminalKind.Statements;
 
@@ -35,11 +31,6 @@ export class Statements extends SlangNode {
     path: AstPath<Statements>,
     options: ParserOptions<PrintableNode>
   ): Doc {
-    return this.items.length > 0 || (this.comments?.length || 0) > 0
-      ? printSeparatedItem(
-          printPreservingEmptyLines(this, path, print, options),
-          { firstSeparator: hardline }
-        )
-      : '';
+    return printIndentedPreservingEmptyLines(this, path, print, options);
   }
 }
diff --git a/src/slang-nodes/YulStatements.ts b/src/slang-nodes/YulStatements.ts
@@ -1,7 +1,5 @@
 import { NonterminalKind } from '@nomicfoundation/slang/cst';
-import { doc } from 'prettier';
-import { printSeparatedItem } from '../slang-printers/print-separated-item.js';
-import { printPreservingEmptyLines } from '../slang-printers/print-preserving-empty-lines.js';
+import { printIndentedPreservingEmptyLines } from '../slang-printers/print-preserving-empty-lines.js';
 import { extractVariant } from '../slang-utils/extract-variant.js';
 import { SlangNode } from './SlangNode.js';
 import { YulStatement } from './YulStatement.js';
@@ -11,8 +9,6 @@ import type { AstPath, Doc, ParserOptions } from 'prettier';
 import type { CollectedMetadata, PrintFunction } from '../types.d.ts';
 import type { PrintableNode } from './types.d.ts';
 
-const { hardline } = doc.builders;
-
 export class YulStatements extends SlangNode {
   readonly kind = NonterminalKind.YulStatements;
 
@@ -35,11 +31,6 @@ export class YulStatements extends SlangNode {
     path: AstPath<YulStatements>,
     options: ParserOptions<PrintableNode>
   ): Doc {
-    return this.items.length > 0 || (this.comments?.length || 0) > 0
-      ? printSeparatedItem(
-          printPreservingEmptyLines(this, path, print, options),
-          { firstSeparator: hardline }
-        )
-      : '';
+    return printIndentedPreservingEmptyLines(this, path, print, options);
   }
 }
diff --git a/src/slang-printers/print-comments.ts b/src/slang-printers/print-comments.ts
@@ -16,7 +16,7 @@ export function printComments(
   path: AstPath<PrintableNode>,
   options: ParserOptions<PrintableNode>
 ): Doc[] {
-  const lastPrintableIndex = (node.comments ?? []).findLastIndex(isPrintable);
+  const lastPrintableIndex = node.comments?.findLastIndex(isPrintable) ?? -1;
   if (lastPrintableIndex === -1) {
     return [];
   }
diff --git a/src/slang-printers/print-preserving-empty-lines.ts b/src/slang-printers/print-preserving-empty-lines.ts
@@ -2,6 +2,7 @@ import { NonterminalKind } from '@nomicfoundation/slang/cst';
 import { doc, util } from 'prettier';
 import { locEnd } from '../slang-utils/loc.js';
 import { printComments } from './print-comments.js';
+import { printSeparatedItem } from './print-separated-item.js';
 
 import type { AstPath, Doc, ParserOptions } from 'prettier';
 import type { LineCollection, PrintableNode } from '../slang-nodes/types.d.ts';
@@ -36,3 +37,17 @@ export function printPreservingEmptyLines(
       }, 'items')
     : printComments(node, path, options);
 }
+
+export function printIndentedPreservingEmptyLines(
+  node: LineCollection,
+  path: AstPath<LineCollection>,
+  print: PrintFunction,
+  options: ParserOptions<PrintableNode>
+): Doc {
+  return node.items.length > 0 || (node.comments?.length ?? 0) > 0
+    ? printSeparatedItem(
+        printPreservingEmptyLines(node, path, print, options),
+        { firstSeparator: hardline }
+      )
+    : '';
+}

Original file line number	Diff line number	Diff line change
`@@ -16,7 +16,7 @@ export function printComments(`
`16`	`16`	`path: AstPath<PrintableNode>,`
`17`	`17`	`options: ParserOptions<PrintableNode>`
`18`	`18`	`): Doc[] {`
`19`		`- const lastPrintableIndex = (node.comments ?? []).findLastIndex(isPrintable);`
	`19`	`+ const lastPrintableIndex = node.comments?.findLastIndex(isPrintable) ?? -1;`
`20`	`20`	`if (lastPrintableIndex === -1) {`
`21`	`21`	`return [];`
`22`	`22`	`}`