Skip to content

refactor: leverage Prettier's AstPath and comment attachment #731

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jtkiesel merged 2 commits into from
Jun 12, 2025
+4,276 −5,966
Merged

refactor: leverage Prettier's AstPath and comment attachment #731

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3e01297
refactor: rename printer root files to TypeScript
jtkiesel Apr 26, 2025
58c5cff
refactor: leverage Prettier's AstPath and comment attachment
jtkiesel May 19, 2025
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: 1 addition & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@
"lerna": "8.1.9",
"lint-staged": "15.2.10",
"mocha": "10.8.2",
"prettier": "3.4.2",
"prettier": "^3.0.0",
"sinon": "19.0.2"
}
}
283 changes: 265 additions & 18 deletions packages/java-parser/api.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import {
import type {
CstNode as ChevrotainCstNode,
IToken as ChevrotainIToken,
CstNodeLocation,
Expand All @@ -7,15 +7,10 @@ import {

export interface CstNode extends ChevrotainCstNode {
children: CstChildrenDictionary;
leadingComments?: IToken[];
trailingComments?: IToken[];
ignore?: boolean;
location: CstNodeLocation;
location: Required<CstNodeLocation>;
}

export interface IToken extends ChevrotainIToken {
leadingComments?: IToken[];
trailingComments?: IToken[];
startOffset: number;
startLine: number;
startColumn: number;
Expand All @@ -24,7 +19,246 @@ export interface IToken extends ChevrotainIToken {
endColumn: number;
}

export type CstElement = IToken | CstNode;
export type CstElement =
| IToken
| AdditionalBoundCstNode
| AmbiguousNameCstNode
| AnnotationCstNode
| AnnotationInterfaceBodyCstNode
| AnnotationInterfaceDeclarationCstNode
| AnnotationInterfaceElementDeclarationCstNode
| AnnotationInterfaceElementModifierCstNode
| AnnotationInterfaceMemberDeclarationCstNode
| ArgumentListCstNode
| ArrayAccessSuffixCstNode
| ArrayCreationExpressionCstNode
| ArrayCreationExpressionWithoutInitializerSuffixCstNode
| ArrayCreationWithInitializerSuffixCstNode
| ArrayInitializerCstNode
| AssertStatementCstNode
| BasicForStatementCstNode
| BinaryExpressionCstNode
| BlockCstNode
| BlockStatementCstNode
| BlockStatementsCstNode
| BooleanLiteralCstNode
| BreakStatementCstNode
| CaseConstantCstNode
| CasePatternCstNode
| CastExpressionCstNode
| CatchClauseCstNode
| CatchesCstNode
| CatchFormalParameterCstNode
| CatchTypeCstNode
| ClassBodyCstNode
| ClassBodyDeclarationCstNode
| ClassDeclarationCstNode
| ClassExtendsCstNode
| ClassImplementsCstNode
| ClassLiteralSuffixCstNode
| ClassMemberDeclarationCstNode
| ClassModifierCstNode
| ClassOrInterfaceTypeCstNode
| ClassOrInterfaceTypeToInstantiateCstNode
| ClassPermitsCstNode
| ClassTypeCstNode
| CompactConstructorDeclarationCstNode
| CompilationUnitCstNode
| ComponentPatternCstNode
| ComponentPatternListCstNode
| ConciseLambdaParameterCstNode
| ConciseLambdaParameterListCstNode
| ConditionalExpressionCstNode
| ConstantDeclarationCstNode
| ConstantModifierCstNode
| ConstructorBodyCstNode
| ConstructorDeclarationCstNode
| ConstructorDeclaratorCstNode
| ConstructorModifierCstNode
| ContinueStatementCstNode
| DefaultValueCstNode
| DiamondCstNode
| DimExprCstNode
| DimExprsCstNode
| DimsCstNode
| DoStatementCstNode
| ElementValueArrayInitializerCstNode
| ElementValueCstNode
| ElementValueListCstNode
| ElementValuePairCstNode
| ElementValuePairListCstNode
| EmbeddedExpressionCstNode
| EmptyStatementCstNode
| EnhancedForStatementCstNode
| EnumBodyCstNode
| EnumBodyDeclarationsCstNode
| EnumConstantCstNode
| EnumConstantListCstNode
| EnumConstantModifierCstNode
| EnumDeclarationCstNode
| ExceptionTypeCstNode
| ExceptionTypeListCstNode
| ExplicitConstructorInvocationCstNode
| ExportsModuleDirectiveCstNode
| ExpressionCstNode
| ExpressionNameCstNode
| ExpressionStatementCstNode
| FieldDeclarationCstNode
| FieldModifierCstNode
| FinallyCstNode
| FloatingPointLiteralCstNode
| FloatingPointTypeCstNode
| ForInitCstNode
| FormalParameterCstNode
| FormalParameterListCstNode
| ForStatementCstNode
| ForUpdateCstNode
| FqnOrRefTypeCstNode
| FqnOrRefTypePartCommonCstNode
| FqnOrRefTypePartFirstCstNode
| FqnOrRefTypePartRestCstNode
| GuardCstNode
| IfStatementCstNode
| ImportDeclarationCstNode
| InstanceInitializerCstNode
| IntegerLiteralCstNode
| IntegralTypeCstNode
| InterfaceBodyCstNode
| InterfaceDeclarationCstNode
| InterfaceExtendsCstNode
| InterfaceMemberDeclarationCstNode
| InterfaceMethodDeclarationCstNode
| InterfaceMethodModifierCstNode
| InterfaceModifierCstNode
| InterfacePermitsCstNode
| InterfaceTypeCstNode
| InterfaceTypeListCstNode
| LabeledStatementCstNode
| LambdaBodyCstNode
| LambdaExpressionCstNode
| LambdaParameterListCstNode
| LambdaParametersCstNode
| LambdaParametersWithBracesCstNode
| LambdaParameterTypeCstNode
| LiteralCstNode
| LocalVariableDeclarationCstNode
| LocalVariableDeclarationStatementCstNode
| LocalVariableTypeCstNode
| MatchAllPatternCstNode
| MethodBodyCstNode
| MethodDeclarationCstNode
| MethodDeclaratorCstNode
| MethodHeaderCstNode
| MethodInvocationSuffixCstNode
| MethodModifierCstNode
| MethodNameCstNode
| MethodReferenceSuffixCstNode
| ModularCompilationUnitCstNode
| ModuleDeclarationCstNode
| ModuleDirectiveCstNode
| ModuleNameCstNode
| NewExpressionCstNode
| NormalClassDeclarationCstNode
| NormalInterfaceDeclarationCstNode
| NormalLambdaParameterCstNode
| NormalLambdaParameterListCstNode
| NumericTypeCstNode
| OpensModuleDirectiveCstNode
| OrdinaryCompilationUnitCstNode
| PackageDeclarationCstNode
| PackageModifierCstNode
| PackageNameCstNode
| PackageOrTypeNameCstNode
| ParenthesisExpressionCstNode
| PatternCstNode
| PrimaryCstNode
| PrimaryPrefixCstNode
| PrimarySuffixCstNode
| PrimitiveCastExpressionCstNode
| PrimitiveTypeCstNode
| ProvidesModuleDirectiveCstNode
| QualifiedExplicitConstructorInvocationCstNode
| ReceiverParameterCstNode
| RecordBodyCstNode
| RecordBodyDeclarationCstNode
| RecordComponentCstNode
| RecordComponentListCstNode
| RecordComponentModifierCstNode
| RecordDeclarationCstNode
| RecordHeaderCstNode
| RecordPatternCstNode
| ReferenceTypeCastExpressionCstNode
| ReferenceTypeCstNode
| RegularLambdaParameterCstNode
| RequiresModifierCstNode
| RequiresModuleDirectiveCstNode
| ResourceCstNode
| ResourceListCstNode
| ResourceSpecificationCstNode
| ResultCstNode
| ReturnStatementCstNode
| ShiftOperatorCstNode
| SimpleTypeNameCstNode
| StatementCstNode
| StatementExpressionCstNode
| StatementExpressionListCstNode
| StatementWithoutTrailingSubstatementCstNode
| StaticInitializerCstNode
| StringTemplateCstNode
| SwitchBlockCstNode
| SwitchBlockStatementGroupCstNode
| SwitchLabelCstNode
| SwitchRuleCstNode
| SwitchStatementCstNode
| SynchronizedStatementCstNode
| TemplateArgumentCstNode
| TemplateCstNode
| TextBlockTemplateCstNode
| ThrowsCstNode
| ThrowStatementCstNode
| TryStatementCstNode
| TryWithResourcesStatementCstNode
| TypeArgumentCstNode
| TypeArgumentListCstNode
| TypeArgumentsCstNode
| TypeArgumentsOrDiamondCstNode
| TypeBoundCstNode
| TypeDeclarationCstNode
| TypeIdentifierCstNode
| TypeNameCstNode
| TypeParameterCstNode
| TypeParameterListCstNode
| TypeParameterModifierCstNode
| TypeParametersCstNode
| TypePatternCstNode
| TypeVariableCstNode
| UnannClassOrInterfaceTypeCstNode
| UnannClassTypeCstNode
| UnannInterfaceTypeCstNode
| UnannPrimitiveTypeCstNode
| UnannPrimitiveTypeWithOptionalDimsSuffixCstNode
| UnannReferenceTypeCstNode
| UnannTypeCstNode
| UnannTypeVariableCstNode
| UnaryExpressionCstNode
| UnaryExpressionNotPlusMinusCstNode
| UnqualifiedClassInstanceCreationExpressionCstNode
| UnqualifiedExplicitConstructorInvocationCstNode
| UsesModuleDirectiveCstNode
| VariableAccessCstNode
| VariableArityParameterCstNode
| VariableArityRecordComponentCstNode
| VariableDeclaratorCstNode
| VariableDeclaratorIdCstNode
| VariableDeclaratorListCstNode
| VariableInitializerCstNode
| VariableInitializerListCstNode
| VariableModifierCstNode
| VariableParaRegularParameterCstNode
| WhileStatementCstNode
| WildcardBoundsCstNode
| WildcardCstNode
| YieldStatementCstNode;

export declare type CstChildrenDictionary = {
[identifier: string]: CstElement[];
Expand All @@ -38,7 +272,10 @@ export function lexAndParse(
cst: CstNode;
};

export function parse(text: string, startProduction?: string): CstNode;
export function parse(
text: string,
startProduction?: string
): CstNode & { comments?: IToken[] };

export const BaseJavaCstVisitor: JavaCstVisitorConstructor<any, any>;
export const BaseJavaCstVisitorWithDefaults: JavaCstVisitorWithDefaultsConstructor<
Expand All @@ -57,6 +294,7 @@ export abstract class JavaCstVisitor<IN, OUT> implements ICstVisitor<IN, OUT> {
integerLiteral(ctx: IntegerLiteralCtx, param?: IN): OUT;
floatingPointLiteral(ctx: FloatingPointLiteralCtx, param?: IN): OUT;
booleanLiteral(ctx: BooleanLiteralCtx, param?: IN): OUT;
shiftOperator(cts: ShiftOperatorCtx, param?: IN): OUT;
primitiveType(ctx: PrimitiveTypeCtx, param?: IN): OUT;
numericType(ctx: NumericTypeCtx, param?: IN): OUT;
integralType(ctx: IntegralTypeCtx, param?: IN): OUT;
Expand Down Expand Up @@ -300,7 +538,7 @@ export abstract class JavaCstVisitor<IN, OUT> implements ICstVisitor<IN, OUT> {
param?: IN
): OUT;
normalLambdaParameterList(ctx: NormalLambdaParameterListCtx, param?: IN): OUT;
normalLambdaParameter(ctx: LambdaParameterCtx, param?: IN): OUT;
normalLambdaParameter(ctx: NormalLambdaParameterCtx, param?: IN): OUT;
regularLambdaParameter(ctx: RegularLambdaParameterCtx, param?: IN): OUT;
lambdaParameterType(ctx: LambdaParameterTypeCtx, param?: IN): OUT;
conciseLambdaParameter(ctx: ConciseLambdaParameterCtx, param?: IN): OUT;
Expand Down Expand Up @@ -385,6 +623,7 @@ export abstract class JavaCstVisitorWithDefaults<IN, OUT>
integerLiteral(ctx: IntegerLiteralCtx, param?: IN): OUT;
floatingPointLiteral(ctx: FloatingPointLiteralCtx, param?: IN): OUT;
booleanLiteral(ctx: BooleanLiteralCtx, param?: IN): OUT;
shiftOperator(cts: ShiftOperatorCtx, param?: IN): OUT;
primitiveType(ctx: PrimitiveTypeCtx, param?: IN): OUT;
numericType(ctx: NumericTypeCtx, param?: IN): OUT;
integralType(ctx: IntegralTypeCtx, param?: IN): OUT;
Expand Down Expand Up @@ -628,7 +867,7 @@ export abstract class JavaCstVisitorWithDefaults<IN, OUT>
param?: IN
): OUT;
normalLambdaParameterList(ctx: NormalLambdaParameterListCtx, param?: IN): OUT;
normalLambdaParameter(ctx: LambdaParameterCtx, param?: IN): OUT;
normalLambdaParameter(ctx: NormalLambdaParameterCtx, param?: IN): OUT;
regularLambdaParameter(ctx: RegularLambdaParameterCtx, param?: IN): OUT;
lambdaParameterType(ctx: LambdaParameterTypeCtx, param?: IN): OUT;
conciseLambdaParameter(ctx: ConciseLambdaParameterCtx, param?: IN): OUT;
Expand Down Expand Up @@ -755,6 +994,16 @@ export type BooleanLiteralCtx = {
False?: IToken[];
};

export interface ShiftOperatorCstNode extends CstNode {
name: "shiftOperator";
children: ShiftOperatorCtx;
}

export type ShiftOperatorCtx = {
Less?: IToken[];
Greater?: IToken[];
};

export interface PrimitiveTypeCstNode extends CstNode {
name: "primitiveType";
children: PrimitiveTypeCtx;
Expand Down Expand Up @@ -1801,17 +2050,16 @@ export interface CompilationUnitCstNode extends CstNode {

export type AbstractOrdinaryCompilationUnitCtx = {
ordinaryCompilationUnit: OrdinaryCompilationUnitCstNode[];
EOF: IToken[];
};

export type AbstractModularCompilationUnitCtx = {
modularCompilationUnit: OrdinaryCompilationUnitCstNode[];
EOF: IToken[];
};

export type CompilationUnitCtx =
| AbstractOrdinaryCompilationUnitCtx
| AbstractModularCompilationUnitCtx;
| AbstractModularCompilationUnitCtx
| { EOF: IToken[] };

export interface OrdinaryCompilationUnitCstNode extends CstNode {
name: "ordinaryCompilationUnit";
Expand Down Expand Up @@ -2894,10 +3142,10 @@ export type NormalLambdaParameterListCtx = {

export interface NormalLambdaParameterCstNode extends CstNode {
name: "normalLambdaParameter";
children: LambdaParameterCtx;
children: NormalLambdaParameterCtx;
}

export type LambdaParameterCtx = {
export type NormalLambdaParameterCtx = {
regularLambdaParameter?: RegularLambdaParameterCstNode[];
variableArityParameter?: VariableArityParameterCstNode[];
};
Expand Down Expand Up @@ -2967,8 +3215,7 @@ export type BinaryExpressionCtx = {
referenceType?: ReferenceTypeCstNode[];
AssignmentOperator?: IToken[];
expression?: ExpressionCstNode[];
Less?: IToken[];
Greater?: IToken[];
shiftOperator?: ShiftOperatorCstNode[];
BinaryOperator?: IToken[];
};

Expand Down
Loading