PrintableNode (#1498)

* Using `PrintableNode` as a more correct type for `StrictAstNode`

* A specialized comment handler is not needed as prettier was always taking care of this

* replacing all `AstNode` references for the more accurate `PrintableNode`

* updating `hasPrettierIgnore` type

Author: Janther

src/index.ts

@@ -17,7 +17,7 @@ import type {
   RequiredOptions,
   SupportLanguage
 } from 'prettier';
-import type { AstNode } from './slang-nodes/types.d.ts';
+import type { PrintableNode } from './slang-nodes/types.d.ts';
 
 const slangParserId = 'slang';
 const antlrParserId = 'antlr';
@@ -40,7 +40,7 @@ const languages: SupportLanguage[] = [
 
 // https://prettier.io/docs/en/plugins.html#parsers
 const antlrParser = { astFormat: antlrAstId, parse: antlrParse, ...loc };
-const slangParser: Parser<AstNode> = {
+const slangParser: Parser<PrintableNode> = {
   astFormat: slangAstId,
   parse: slangParse,
   locStart,
@@ -54,8 +54,7 @@ const parsers = {
 
 const antlrCanAttachComment = ({ type }: { type: string }): boolean =>
   typeof type === 'string' && type !== 'BlockComment' && type !== 'LineComment';
-const canAttachComment = (node: AstNode): boolean =>
-  typeof node !== 'string' &&
+const canAttachComment = (node: PrintableNode | undefined): boolean =>
   node !== undefined &&
   node.kind && // Make sure it's not Location
   !isComment(node);
@@ -73,7 +72,7 @@ const antlrPrinter = {
   print: antlrPrint,
   printComment: comments.printComment
 };
-const slangPrinter: Printer<AstNode> = {
+const slangPrinter: Printer<PrintableNode | undefined> = {
   canAttachComment,
   handleComments,
   isBlockComment,

src/slang-comments/handler.ts

@@ -5,8 +5,8 @@ import type { Comment } from '../slang-nodes/types.d.ts';
 function handler(
   comment: Comment,
   text: string
-  // options: ParserOptions<AstNode>,
-  // ast: AstNode,
+  // options: ParserOptions<PrintableNode>,
+  // ast: PrintableNode,
   // isLastComment: boolean
 ): boolean {
   const { precedingNode, enclosingNode, followingNode } = comment;

src/slang-comments/handlers/handle-storage-layout-specifier-comments.ts

@@ -10,7 +10,6 @@ import handleModifierInvocationComments from './handle-modifier-invocation-comme
 import handleParametersDeclarationComments from './handle-parameters-declaration-comments.js';
 import handlePositionalArgumentsDeclarationComments from './handle-positional-arguments-declaration-comments.js';
 import handleSourceUnitMembersComments from './handle-source-unit-members-comments.js';
-import handleStorageLayoutSpecifierComments from './handle-storage-layout-specifier-comments.js';
 import handleStructDefinitionComments from './handle-struct-definition-comments.js';
 import handleWhileStatementComments from './handle-while-statement-comments.js';
 import handleYulBlockComments from './handle-yul-block-comments.js';
@@ -28,7 +27,6 @@ export default [
   handleParametersDeclarationComments,
   handlePositionalArgumentsDeclarationComments,
   handleSourceUnitMembersComments,
-  handleStorageLayoutSpecifierComments,
   handleStructDefinitionComments,
   handleWhileStatementComments,
   handleYulBlockComments

src/slang-comments/handlers/index.ts

@@ -1,9 +1,9 @@
-import type { Comment, StrictAstNode } from '../../slang-nodes/types.d.ts';
+import type { Comment, PrintableNode } from '../../slang-nodes/types.d.ts';
 
 interface HandlerParams {
   text: string;
-  precedingNode?: StrictAstNode;
-  enclosingNode?: StrictAstNode;
-  followingNode?: StrictAstNode;
+  precedingNode?: PrintableNode;
+  enclosingNode?: PrintableNode;
+  followingNode?: PrintableNode;
   comment: Comment;
 }

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

@@ -1,9 +1,11 @@
 import { isComment } from '../slang-utils/is-comment.js';
 
 import type { AstPath, Doc } from 'prettier';
-import type { AstNode } from '../slang-nodes/types.d.ts';
+import type { PrintableNode } from '../slang-nodes/types.d.ts';
 
-export function printComment({ node: comment }: AstPath<AstNode>): Doc {
+export function printComment({
+  node: comment
+}: AstPath<PrintableNode | undefined>): Doc {
   if (isComment(comment)) {
     return comment.print();
   }

src/slang-comments/printer.ts

@@ -9,7 +9,7 @@ import { Expression } from './Expression.js';
 import type * as ast from '@nomicfoundation/slang/ast';
 import type { AstPath, Doc, ParserOptions } from 'prettier';
 import type { CollectedMetadata, PrintFunction } from '../types.d.ts';
-import type { AstNode } from './types.d.ts';
+import type { PrintableNode } from './types.d.ts';
 
 const tryToHug = createHugFunction(['%']);
 
@@ -38,7 +38,7 @@ export class AdditiveExpression extends SlangNode {
   constructor(
     ast: ast.AdditiveExpression,
     collected: CollectedMetadata,
-    options: ParserOptions<AstNode>
+    options: ParserOptions<PrintableNode>
   ) {
     super(ast, collected);
 
@@ -59,7 +59,7 @@ export class AdditiveExpression extends SlangNode {
   print(
     path: AstPath<AdditiveExpression>,
     print: PrintFunction,
-    options: ParserOptions<AstNode>
+    options: ParserOptions<PrintableNode>
   ): Doc {
     return printAdditiveExpression(this, path, print, options);
   }

src/slang-nodes/AdditiveExpression.ts

@@ -7,7 +7,7 @@ import { Expression } from './Expression.js';
 import type * as ast from '@nomicfoundation/slang/ast';
 import type { AstPath, Doc, ParserOptions } from 'prettier';
 import type { CollectedMetadata, PrintFunction } from '../types.d.ts';
-import type { AstNode } from './types.d.ts';
+import type { PrintableNode } from './types.d.ts';
 
 export class AndExpression extends SlangNode {
   readonly kind = NonterminalKind.AndExpression;
@@ -21,7 +21,7 @@ export class AndExpression extends SlangNode {
   constructor(
     ast: ast.AndExpression,
     collected: CollectedMetadata,
-    options: ParserOptions<AstNode>
+    options: ParserOptions<PrintableNode>
   ) {
     super(ast, collected);
 
@@ -39,7 +39,7 @@ export class AndExpression extends SlangNode {
   print(
     path: AstPath<AndExpression>,
     print: PrintFunction,
-    options: ParserOptions<AstNode>
+    options: ParserOptions<PrintableNode>
   ): Doc {
     return printLogicalOperation(this, path, print, options);
   }

src/slang-nodes/AndExpression.ts

@@ -7,7 +7,7 @@ import { NamedArgumentsDeclaration } from './NamedArgumentsDeclaration.js';
 
 import type { ParserOptions } from 'prettier';
 import type { CollectedMetadata } from '../types.d.ts';
-import type { AstNode } from './types.d.ts';
+import type { PrintableNode } from './types.d.ts';
 
 const createNonterminalVariant = createNonterminalVariantSimpleCreator<
   ast.ArgumentsDeclaration,
@@ -25,7 +25,7 @@ export class ArgumentsDeclaration extends SlangNode {
   constructor(
     ast: ast.ArgumentsDeclaration,
     collected: CollectedMetadata,
-    options: ParserOptions<AstNode>
+    options: ParserOptions<PrintableNode>
   ) {
     super(ast, collected);
 

src/slang-nodes/ArgumentsDeclaration.ts

@@ -5,7 +5,7 @@ import { ArrayValues } from './ArrayValues.js';
 import type * as ast from '@nomicfoundation/slang/ast';
 import type { AstPath, Doc, ParserOptions } from 'prettier';
 import type { CollectedMetadata, PrintFunction } from '../types.d.ts';
-import type { AstNode } from './types.d.ts';
+import type { PrintableNode } from './types.d.ts';
 
 export class ArrayExpression extends SlangNode {
   readonly kind = NonterminalKind.ArrayExpression;
@@ -15,7 +15,7 @@ export class ArrayExpression extends SlangNode {
   constructor(
     ast: ast.ArrayExpression,
     collected: CollectedMetadata,
-    options: ParserOptions<AstNode>
+    options: ParserOptions<PrintableNode>
   ) {
     super(ast, collected);