All features printed.

Janther · Janther · commit 4f394dc56979 · 2024-08-15T20:16:32.000+12:00
diff --git a/src/nodes/ModifierDefinition.js b/src/nodes/ModifierDefinition.js
@@ -1,7 +1,7 @@
 import { doc } from 'prettier';
 import { printSeparatedList } from '../common/printer-helpers.js';
 
-const { group, indent, line } = doc.builders;
+const { dedent, group, indent, line } = doc.builders;
 
 const modifierParameters = (node, path, print) => {
   if (node.parameters?.length > 0) {
@@ -32,16 +32,22 @@ const override = (node, path, print) => {
 
 const body = (node, path, print) => {
   if (!node.body) return ';';
-  if (node.isVirtual) return group([' ', path.call(print, 'body')]);
-  return [' ', path.call(print, 'body')];
+  if (node.isVirtual) return group(path.call(print, 'body'));
+  return [path.call(print, 'body')];
 };
 
 export const ModifierDefinition = {
   print: ({ node, path, print }) => [
     'modifier ',
     node.name,
     modifierParameters(node, path, print),
-    group(indent([virtual(node), override(node, path, print)])),
+    group(
+      indent([
+        virtual(node),
+        override(node, path, print),
+        node.body ? dedent(line) : ''
+      ])
+    ),
     body(node, path, print)
   ]
 };
diff --git a/src/slang-comments/handlers/handle-interface-definition-comments.ts b/src/slang-comments/handlers/handle-interface-definition-comments.ts
@@ -0,0 +1,37 @@
+import { NonterminalKind } from '@nomicfoundation/slang/kinds/index.js';
+import { getNextNonSpaceNonCommentCharacter } from '../../slang-utils/backward-compatibility.js';
+import addHubNodeFirstComment from './add-hub-node-first-comment.js';
+import addHubNodeLastComment from './add-hub-node-last-comment.js';
+
+import type { HandlerParams } from './types';
+
+export default function handleInterfaceDefinitionComments({
+  text,
+  precedingNode,
+  enclosingNode,
+  followingNode,
+  comment
+}: HandlerParams): boolean {
+  if (enclosingNode?.kind !== NonterminalKind.InterfaceDefinition) {
+    return false;
+  }
+
+  const nextCharacter = getNextNonSpaceNonCommentCharacter(text, comment);
+
+  // The comment is at the end of the body of the InterfaceDefinition.
+  if (precedingNode?.kind === NonterminalKind.InterfaceMembers) {
+    addHubNodeLastComment(precedingNode, comment);
+    return true;
+  }
+
+  // The last comments before the body.
+  if (
+    nextCharacter === '{' &&
+    followingNode?.kind === NonterminalKind.InterfaceMembers
+  ) {
+    addHubNodeFirstComment(followingNode, comment);
+    return true;
+  }
+
+  return false;
+}
diff --git a/src/slang-comments/handlers/handle-library-definition-comments.ts b/src/slang-comments/handlers/handle-library-definition-comments.ts
@@ -0,0 +1,37 @@
+import { NonterminalKind } from '@nomicfoundation/slang/kinds/index.js';
+import { getNextNonSpaceNonCommentCharacter } from '../../slang-utils/backward-compatibility.js';
+import addHubNodeFirstComment from './add-hub-node-first-comment.js';
+import addHubNodeLastComment from './add-hub-node-last-comment.js';
+
+import type { HandlerParams } from './types';
+
+export default function handleLibraryDefinitionComments({
+  text,
+  precedingNode,
+  enclosingNode,
+  followingNode,
+  comment
+}: HandlerParams): boolean {
+  if (enclosingNode?.kind !== NonterminalKind.LibraryDefinition) {
+    return false;
+  }
+
+  const nextCharacter = getNextNonSpaceNonCommentCharacter(text, comment);
+
+  // The comment is at the end of the body of the ContractDefinition.
+  if (precedingNode?.kind === NonterminalKind.LibraryMembers) {
+    addHubNodeLastComment(precedingNode, comment);
+    return true;
+  }
+
+  // The last comments before the body.
+  if (
+    nextCharacter === '{' &&
+    followingNode?.kind === NonterminalKind.LibraryMembers
+  ) {
+    addHubNodeFirstComment(followingNode, comment);
+    return true;
+  }
+
+  return false;
+}
diff --git a/src/slang-comments/handlers/index.ts b/src/slang-comments/handlers/index.ts
@@ -2,6 +2,8 @@ import handleBlockComments from './handle-block-comments.js';
 import handleContractDefinitionComments from './handle-contract-definition-comments.js';
 import handleElseBranchComments from './handle-else-branch-comments.js';
 import handleIfStatementComments from './handle-if-statement-comments.js';
+import handleInterfaceDefinitionComments from './handle-interface-definition-comments.js';
+import handleLibraryDefinitionComments from './handle-library-definition-comments.js';
 import handleParametersDeclarationComments from './handle-parameters-declaration-comments.js';
 import handlePositionalArgumentsDeclarationComments from './handle-positional-arguments-declaration-comments.js';
 import handleWhileStatementComments from './handle-while-statement-comments.js';
@@ -12,6 +14,8 @@ export default [
   handleContractDefinitionComments,
   handleElseBranchComments,
   handleIfStatementComments,
+  handleInterfaceDefinitionComments,
+  handleLibraryDefinitionComments,
   handleParametersDeclarationComments,
   handlePositionalArgumentsDeclarationComments,
   handleWhileStatementComments,
diff --git a/src/slang-nodes/ConstantDefinition.ts b/src/slang-nodes/ConstantDefinition.ts
@@ -4,9 +4,9 @@ import { TypeName } from './TypeName.js';
 import { Expression } from './Expression.js';
 
 import type * as ast from '@nomicfoundation/slang/ast';
-import type { /*AstPath,*/ Doc, ParserOptions } from 'prettier';
+import type { AstPath, Doc, ParserOptions } from 'prettier';
 import type { AstNode } from '../slang-nodes';
-import type { SlangNode } from '../types';
+import type { PrintFunction, SlangNode } from '../types';
 
 export class ConstantDefinition implements SlangNode {
   readonly kind = NonterminalKind.ConstantDefinition;
@@ -39,12 +39,12 @@ export class ConstantDefinition implements SlangNode {
     this.loc = metadata.loc;
   }
 
-  // TODO: implement print
-  print(/*
-    path: AstPath<ConstantDefinition>,
-    print: PrintFunction,
-    options: ParserOptions<AstNode>
-  */): Doc {
-    return ['TODO: ConstantDefinition'];
+  print(path: AstPath<ConstantDefinition>, print: PrintFunction): Doc {
+    return [
+      path.call(print, 'typeName'),
+      ` constant ${this.name} = `,
+      path.call(print, 'value'),
+      ';'
+    ];
   }
 }
diff --git a/src/slang-nodes/OverridePaths.ts b/src/slang-nodes/OverridePaths.ts
@@ -3,8 +3,9 @@ import { getNodeMetadata, updateMetadata } from '../slang-utils/metadata.js';
 import { IdentifierPath } from './IdentifierPath.js';
 
 import type * as ast from '@nomicfoundation/slang/ast';
-import type { /*AstPath,*/ Doc /*, ParserOptions*/ } from 'prettier';
-import type { SlangNode } from '../types';
+import type { AstPath, Doc } from 'prettier';
+import type { PrintFunction, SlangNode } from '../types';
+import { printSeparatedList } from '../slang-printers/print-separated-list.js';
 
 export class OverridePaths implements SlangNode {
   readonly kind = NonterminalKind.OverridePaths;
@@ -32,12 +33,7 @@ export class OverridePaths implements SlangNode {
     this.loc = metadata.loc;
   }
 
-  // TODO: implement print
-  print(/*
-    path: AstPath<OverridePaths>,
-    print: PrintFunction,
-    options: ParserOptions<AstNode>
-  */): Doc {
-    return ['TODO: OverridePaths'];
+  print(path: AstPath<OverridePaths>, print: PrintFunction): Doc {
+    return printSeparatedList(path.map(print, 'items'));
   }
 }
diff --git a/src/slang-nodes/OverridePathsDeclaration.ts b/src/slang-nodes/OverridePathsDeclaration.ts
@@ -3,8 +3,8 @@ import { getNodeMetadata, updateMetadata } from '../slang-utils/metadata.js';
 import { OverridePaths } from './OverridePaths.js';
 
 import type * as ast from '@nomicfoundation/slang/ast';
-import type { /*AstPath,*/ Doc /*, ParserOptions*/ } from 'prettier';
-import type { SlangNode } from '../types';
+import type { AstPath, Doc } from 'prettier';
+import type { PrintFunction, SlangNode } from '../types';
 
 export class OverridePathsDeclaration implements SlangNode {
   readonly kind = NonterminalKind.OverridePathsDeclaration;
@@ -27,12 +27,7 @@ export class OverridePathsDeclaration implements SlangNode {
     this.loc = metadata.loc;
   }
 
-  // TODO: implement print
-  print(/*
-    path: AstPath<OverridePathsDeclaration>,
-    print: PrintFunction,
-    options: ParserOptions<AstNode>
-  */): Doc {
-    return ['TODO: OverridePathsDeclaration'];
+  print(path: AstPath<OverridePathsDeclaration>, print: PrintFunction): Doc {
+    return ['(', path.call(print, 'paths'), ')'];
   }
 }
diff --git a/src/slang-nodes/PrefixExpression.ts b/src/slang-nodes/PrefixExpression.ts
@@ -33,6 +33,10 @@ export class PrefixExpression implements SlangNode {
 
     this.comments = metadata.comments;
     this.loc = metadata.loc;
+
+    if (this.operator === 'delete') {
+      this.operator = `${this.operator} `;
+    }
   }
 
   print(path: AstPath<PrefixExpression>, print: PrintFunction): Doc {
diff --git a/src/slang-nodes/StateVariableAttributes.ts b/src/slang-nodes/StateVariableAttributes.ts
@@ -1,11 +1,15 @@
 import { NonterminalKind } from '@nomicfoundation/slang/kinds/index.js';
+import { doc } from 'prettier';
 import { getNodeMetadata, updateMetadata } from '../slang-utils/metadata.js';
+import { sortFunctionAttributes } from '../slang-utils/sort-function-attributes.js';
 import { StateVariableAttribute } from './StateVariableAttribute.js';
 
 import type * as ast from '@nomicfoundation/slang/ast';
 import type { AstPath, Doc } from 'prettier';
 import type { PrintFunction, SlangNode } from '../types';
 
+const { line } = doc.builders;
+
 export class StateVariableAttributes implements SlangNode {
   readonly kind = NonterminalKind.StateVariableAttributes;
 
@@ -27,11 +31,13 @@ export class StateVariableAttributes implements SlangNode {
 
     this.comments = metadata.comments;
     this.loc = metadata.loc;
+
+    this.items = this.items.sort(sortFunctionAttributes);
   }
 
   print(path: AstPath<StateVariableAttributes>, print: PrintFunction): Doc {
     return this.items.length
-      ? path.map(print, 'items').map((item) => [' ', item])
+      ? path.map(print, 'items').map((item) => [line, item])
       : '';
   }
 }
diff --git a/src/slang-nodes/StateVariableDefinition.ts b/src/slang-nodes/StateVariableDefinition.ts
@@ -1,4 +1,5 @@
 import { NonterminalKind } from '@nomicfoundation/slang/kinds/index.js';
+import { doc } from 'prettier';
 import { getNodeMetadata, updateMetadata } from '../slang-utils/metadata.js';
 import { TypeName } from './TypeName.js';
 import { StateVariableAttributes } from './StateVariableAttributes.js';
@@ -9,6 +10,8 @@ import type { AstPath, Doc, ParserOptions } from 'prettier';
 import type { AstNode } from '../slang-nodes';
 import type { PrintFunction, SlangNode } from '../types';
 
+const { group, indent, indentIfBreak } = doc.builders;
+
 export class StateVariableDefinition implements SlangNode {
   readonly kind = NonterminalKind.StateVariableDefinition;
 
@@ -50,11 +53,19 @@ export class StateVariableDefinition implements SlangNode {
   }
 
   print(path: AstPath<StateVariableDefinition>, print: PrintFunction): Doc {
+    const attributesDoc = group(indent(path.call(print, 'attributes')), {
+      id: Symbol('Slang.StateVariableDefinition.attributes')
+    });
+
     return [
       path.call(print, 'typeName'),
-      path.call(print, 'attributes'),
+      attributesDoc,
       ` ${this.name}`,
-      this.value ? path.call(print, 'value') : '',
+      this.value
+        ? indentIfBreak(path.call(print, 'value'), {
+            groupId: attributesDoc.id!
+          })
+        : '',
       ';'
     ];
   }
diff --git a/src/slang-nodes/TupleDeconstructionStatement.ts b/src/slang-nodes/TupleDeconstructionStatement.ts
@@ -1,5 +1,5 @@
-import { doc } from 'prettier';
 import { NonterminalKind } from '@nomicfoundation/slang/kinds/index.js';
+import { doc } from 'prettier';
 import { getNodeMetadata, updateMetadata } from '../slang-utils/metadata.js';
 import { TupleDeconstructionElements } from './TupleDeconstructionElements.js';
 import { Expression } from './Expression.js';
@@ -57,7 +57,8 @@ export class TupleDeconstructionStatement implements SlangNode {
       typeof this.expression.variant !== 'string' &&
       this.expression.variant.kind === NonterminalKind.TupleExpression
         ? [') = ', path.call(print, 'expression')]
-        : group([') =', indent([line, path.call(print, 'expression'), ';'])])
+        : group([') =', indent([line, path.call(print, 'expression')])]),
+      ';'
     ];
   }
 }
diff --git a/src/slang-nodes/TypeExpression.ts b/src/slang-nodes/TypeExpression.ts
@@ -3,9 +3,9 @@ import { getNodeMetadata, updateMetadata } from '../slang-utils/metadata.js';
 import { TypeName } from './TypeName.js';
 
 import type * as ast from '@nomicfoundation/slang/ast';
-import type { /*AstPath,*/ Doc, ParserOptions } from 'prettier';
+import type { AstPath, Doc, ParserOptions } from 'prettier';
 import type { AstNode } from '../slang-nodes';
-import type { SlangNode } from '../types';
+import type { PrintFunction, SlangNode } from '../types';
 
 export class TypeExpression implements SlangNode {
   readonly kind = NonterminalKind.TypeExpression;
@@ -32,12 +32,7 @@ export class TypeExpression implements SlangNode {
     this.loc = metadata.loc;
   }
 
-  // TODO: implement print
-  print(/*
-    path: AstPath<TypeExpression>,
-    print: PrintFunction,
-    options: ParserOptions<AstNode>
-  */): Doc {
-    return ['TODO: TypeExpression'];
+  print(path: AstPath<TypeExpression>, print: PrintFunction): Doc {
+    return ['type(', path.call(print, 'typeName'), ')'];
   }
 }
diff --git a/src/slang-nodes/UntypedTupleMember.ts b/src/slang-nodes/UntypedTupleMember.ts
@@ -3,8 +3,8 @@ import { getNodeMetadata, updateMetadata } from '../slang-utils/metadata.js';
 import { StorageLocation } from './StorageLocation.js';
 
 import type * as ast from '@nomicfoundation/slang/ast';
-import type { /*AstPath,*/ Doc /*, ParserOptions*/ } from 'prettier';
-import type { SlangNode } from '../types';
+import type { AstPath, Doc } from 'prettier';
+import type { PrintFunction, SlangNode } from '../types';
 
 export class UntypedTupleMember implements SlangNode {
   readonly kind = NonterminalKind.UntypedTupleMember;
@@ -35,12 +35,10 @@ export class UntypedTupleMember implements SlangNode {
     this.loc = metadata.loc;
   }
 
-  // TODO: implement print
-  print(/*
-    path: AstPath<UntypedTupleMember>,
-    print: PrintFunction,
-    options: ParserOptions<AstNode>
-  */): Doc {
-    return ['TODO: UntypedTupleMemberUntypedTupleMember'];
+  print(path: AstPath<UntypedTupleMember>, print: PrintFunction): Doc {
+    return [
+      this.storageLocation ? [path.call(print, 'storageLocation'), ' '] : '',
+      this.name
+    ];
   }
 }
diff --git a/src/slang-nodes/VariableDeclarationType.ts b/src/slang-nodes/VariableDeclarationType.ts
@@ -27,7 +27,7 @@ export class VariableDeclarationType implements SlangNode {
 
     this.variant =
       ast.variant instanceof TerminalNode
-        ? ast.variant.type
+        ? ast.variant.text
         : new TypeName(ast.variant, offsets[0], options);
 
     metadata = updateMetadata(
diff --git a/src/slang-utils/loc.ts b/src/slang-utils/loc.ts
@@ -1,4 +1,4 @@
-import type { AstNode, StrictAstNode } from '../slang-nodes';
+import type { AstNode } from '../slang-nodes';
 import type { Comment } from '../types';
 
 export function locStart(node: AstNode | Comment): number {
diff --git a/tests/config/run-format-test.js b/tests/config/run-format-test.js
@@ -42,7 +42,6 @@ const unstableAstTests = new Map(
 
 const testsWithSlang = new Map(
   [
-    // "AllSolidityFeatures/AllSolidityFeatures.sol",
     // "Comments/Comments.sol", // TODO: finish Comments
   ].map((fixture) => {
     const [file, testSlang = () => true] = Array.isArray(fixture)
diff --git a/tests/format/AllSolidityFeatures/AllSolidityFeatures.sol b/tests/format/AllSolidityFeatures/AllSolidityFeatures.sol
diff --git a/tests/format/AllSolidityFeatures/__snapshots__/format.test.js.snap b/tests/format/AllSolidityFeatures/__snapshots__/format.test.js.snap
diff --git a/tests/format/AllSolidityFeatures/format.test.js b/tests/format/AllSolidityFeatures/format.test.js
diff --git a/tests/format/AllSolidityFeaturesV0.4.26/AllSolidityFeatures.sol b/tests/format/AllSolidityFeaturesV0.4.26/AllSolidityFeatures.sol
diff --git a/tests/format/AllSolidityFeaturesV0.4.26/__snapshots__/format.test.js.snap b/tests/format/AllSolidityFeaturesV0.4.26/__snapshots__/format.test.js.snap
diff --git a/tests/format/AllSolidityFeaturesV0.4.26/format.test.js b/tests/format/AllSolidityFeaturesV0.4.26/format.test.js

Original file line number	Diff line number	Diff line change
`@@ -33,6 +33,10 @@ export class PrefixExpression implements SlangNode {`
`33`	`33`
`34`	`34`	`this.comments = metadata.comments;`
`35`	`35`	`this.loc = metadata.loc;`
	`36`	`+`
	`37`	`+ if (this.operator === 'delete') {`
	`38`	+ this.operator = `${this.operator} `;
	`39`	`+ }`
`36`	`40`	`}`
`37`	`41`
`38`	`42`	`print(path: AstPath<PrefixExpression>, print: PrintFunction): Doc {`