Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ import slangParse from './slangSolidityParser.js';
import slangPrint from './slangPrinter.js';
import { isBlockComment, isComment } from './slang-utils/is-comment.js';
import { locEnd, locStart } from './slang-utils/loc.js';
import { hasPrettierIgnore } from './slang-utils/has-prettier-ignore.js';

import type {
Parser,
Expand Down Expand Up @@ -78,6 +79,7 @@ const slangPrinter: Printer<AstNode> = {
isBlockComment,
massageAstNode,
print: slangPrint,
hasPrettierIgnore,
printComment
};

Expand Down
20 changes: 20 additions & 0 deletions src/slang-utils/has-prettier-ignore.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
import { isBlockComment, isComment } from './is-comment.js';

import type { AstPath } from 'prettier';
import type { AstNode } from '../slang-nodes/types.js';

export function hasPrettierIgnore({ node }: AstPath<AstNode>): boolean {
if (typeof node === 'string' || node === undefined || isComment(node))
return false;

// Prettier sets SourceUnit's comments to undefined after assigning comments
// to each node.
return Boolean(
node.comments?.some(
(comment) =>
comment.value
.slice(2, isBlockComment(comment) ? -2 : undefined)
.trim() === 'prettier-ignore'
)
);
}
60 changes: 1 addition & 59 deletions src/slangPrinter.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@
import { isBlockComment } from './slang-utils/is-comment.js';
import { locEnd, locStart } from './slang-utils/loc.js';

import type { AstPath, Doc, ParserOptions } from 'prettier';
import type {
AstNode,
Expand All @@ -9,72 +6,17 @@ import type {
} from './slang-nodes/types.d.ts';
import type { PrintFunction } from './types.d.ts';

function hasNodeIgnoreComment({ comments }: StrictAstNode): boolean {
// Prettier sets SourceUnit's comments to undefined after assigning comments
// to each node.
return Boolean(
comments?.some(
(comment) =>
comment.value
.slice(2, isBlockComment(comment) ? -2 : undefined)
.trim() === 'prettier-ignore'
)
);
}

function ignoreComments(path: AstPath<StrictAstNode>): void {
const node = path.node;
// We ignore anything that is not an object
if (node === null || typeof node !== 'object') return;

let key: keyof StrictAstNode;
for (key in node) {
switch (key) {
// We ignore `kind` and `loc` since these are added by the parser.
// `updateMetadata` is an internal function.
case 'kind':
case 'loc':
case 'updateMetadata':
break;
// The key `comments` will contain every comment for this node.
case 'comments':
if (node.comments !== undefined) {
path.each(({ node }) => (node.printed = true), key);
}
break;
default:
// If the value for that key is an Array or an Object we go deeper.
const childNode = node[key];
if (typeof childNode === 'object') {
if (Array.isArray(childNode)) {
path.each(ignoreComments, key);
break;
}
path.call(ignoreComments, key);
}
}
}
}

// Nodes take care of undefined and string properties so we can restrict path
// to AstPath<StrictAstNode>
function genericPrint(
path: AstPath<Exclude<StrictAstNode, StrictPolymorphicNode>>,
options: ParserOptions<AstNode>,
print: PrintFunction
): Doc {
const node = path.node;

if (hasNodeIgnoreComment(node)) {
ignoreComments(path);

return options.originalText.slice(locStart(node), locEnd(node));
}

// Since each node has a print function with a specific AstPath, the union of
// all nodes into AstNode creates a print function with an AstPath of the
// intersection of all nodes. This forces us to cast this with a never type.
return node.print(path as AstPath<never>, print, options);
return path.node.print(path as AstPath<never>, print, options);
}

export default genericPrint;