Skip to content

Commit f19949b

Browse files
jtkieseljtkiesel
committed
refactor: leverage Prettier's AstPath and comment attachment
1 parent 55052ce commit f19949b

File tree

76 files changed

+4479
-5775
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

76 files changed

+4479
-5775
lines changed

‎package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@
4141
"lerna": "8.1.9",
4242
"lint-staged": "15.2.10",
4343
"mocha": "10.8.2",
44-
"prettier": "3.4.2",
44+
"prettier": "^3.0.0",
4545
"sinon": "19.0.2"
4646
}
4747
}

‎packages/java-parser/api.d.ts

+265-18
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
import {
1+
import type {
22
CstNode as ChevrotainCstNode,
33
IToken as ChevrotainIToken,
44
CstNodeLocation,
@@ -7,24 +7,261 @@ import {
77

88
export interface CstNode extends ChevrotainCstNode {
99
children: CstChildrenDictionary;
10-
leadingComments?: IToken[];
11-
trailingComments?: IToken[];
10+
location: Required<CstNodeLocation>;
11+
comments?: IToken[];
1212
ignore?: boolean;
13-
location: CstNodeLocation;
1413
}
1514

1615
export interface IToken extends ChevrotainIToken {
17-
leadingComments?: IToken[];
18-
trailingComments?: IToken[];
1916
startOffset: number;
2017
startLine: number;
2118
startColumn: number;
2219
endOffset: number;
2320
endLine: number;
2421
endColumn: number;
25-
}
26-
27-
export type CstElement = IToken | CstNode;
22+
comments?: IToken[];
23+
}
24+
25+
export type CstElement =
26+
| IToken
27+
| AdditionalBoundCstNode
28+
| AmbiguousNameCstNode
29+
| AnnotationCstNode
30+
| AnnotationInterfaceBodyCstNode
31+
| AnnotationInterfaceDeclarationCstNode
32+
| AnnotationInterfaceElementDeclarationCstNode
33+
| AnnotationInterfaceElementModifierCstNode
34+
| AnnotationInterfaceMemberDeclarationCstNode
35+
| ArgumentListCstNode
36+
| ArrayAccessSuffixCstNode
37+
| ArrayCreationExpressionCstNode
38+
| ArrayCreationExpressionWithoutInitializerSuffixCstNode
39+
| ArrayCreationWithInitializerSuffixCstNode
40+
| ArrayInitializerCstNode
41+
| AssertStatementCstNode
42+
| BasicForStatementCstNode
43+
| BinaryExpressionCstNode
44+
| BlockCstNode
45+
| BlockStatementCstNode
46+
| BlockStatementsCstNode
47+
| BooleanLiteralCstNode
48+
| BreakStatementCstNode
49+
| CaseConstantCstNode
50+
| CasePatternCstNode
51+
| CastExpressionCstNode
52+
| CatchClauseCstNode
53+
| CatchesCstNode
54+
| CatchFormalParameterCstNode
55+
| CatchTypeCstNode
56+
| ClassBodyCstNode
57+
| ClassBodyDeclarationCstNode
58+
| ClassDeclarationCstNode
59+
| ClassExtendsCstNode
60+
| ClassImplementsCstNode
61+
| ClassLiteralSuffixCstNode
62+
| ClassMemberDeclarationCstNode
63+
| ClassModifierCstNode
64+
| ClassOrInterfaceTypeCstNode
65+
| ClassOrInterfaceTypeToInstantiateCstNode
66+
| ClassPermitsCstNode
67+
| ClassTypeCstNode
68+
| CompactConstructorDeclarationCstNode
69+
| CompilationUnitCstNode
70+
| ComponentPatternCstNode
71+
| ComponentPatternListCstNode
72+
| ConciseLambdaParameterCstNode
73+
| ConciseLambdaParameterListCstNode
74+
| ConditionalExpressionCstNode
75+
| ConstantDeclarationCstNode
76+
| ConstantModifierCstNode
77+
| ConstructorBodyCstNode
78+
| ConstructorDeclarationCstNode
79+
| ConstructorDeclaratorCstNode
80+
| ConstructorModifierCstNode
81+
| ContinueStatementCstNode
82+
| DefaultValueCstNode
83+
| DiamondCstNode
84+
| DimExprCstNode
85+
| DimExprsCstNode
86+
| DimsCstNode
87+
| DoStatementCstNode
88+
| ElementValueArrayInitializerCstNode
89+
| ElementValueCstNode
90+
| ElementValueListCstNode
91+
| ElementValuePairCstNode
92+
| ElementValuePairListCstNode
93+
| EmbeddedExpressionCstNode
94+
| EmptyStatementCstNode
95+
| EnhancedForStatementCstNode
96+
| EnumBodyCstNode
97+
| EnumBodyDeclarationsCstNode
98+
| EnumConstantCstNode
99+
| EnumConstantListCstNode
100+
| EnumConstantModifierCstNode
101+
| EnumDeclarationCstNode
102+
| ExceptionTypeCstNode
103+
| ExceptionTypeListCstNode
104+
| ExplicitConstructorInvocationCstNode
105+
| ExportsModuleDirectiveCstNode
106+
| ExpressionCstNode
107+
| ExpressionNameCstNode
108+
| ExpressionStatementCstNode
109+
| FieldDeclarationCstNode
110+
| FieldModifierCstNode
111+
| FinallyCstNode
112+
| FloatingPointLiteralCstNode
113+
| FloatingPointTypeCstNode
114+
| ForInitCstNode
115+
| FormalParameterCstNode
116+
| FormalParameterListCstNode
117+
| ForStatementCstNode
118+
| ForUpdateCstNode
119+
| FqnOrRefTypeCstNode
120+
| FqnOrRefTypePartCommonCstNode
121+
| FqnOrRefTypePartFirstCstNode
122+
| FqnOrRefTypePartRestCstNode
123+
| GuardCstNode
124+
| IfStatementCstNode
125+
| ImportDeclarationCstNode
126+
| InstanceInitializerCstNode
127+
| IntegerLiteralCstNode
128+
| IntegralTypeCstNode
129+
| InterfaceBodyCstNode
130+
| InterfaceDeclarationCstNode
131+
| InterfaceExtendsCstNode
132+
| InterfaceMemberDeclarationCstNode
133+
| InterfaceMethodDeclarationCstNode
134+
| InterfaceMethodModifierCstNode
135+
| InterfaceModifierCstNode
136+
| InterfacePermitsCstNode
137+
| InterfaceTypeCstNode
138+
| InterfaceTypeListCstNode
139+
| LabeledStatementCstNode
140+
| LambdaBodyCstNode
141+
| LambdaExpressionCstNode
142+
| LambdaParameterListCstNode
143+
| LambdaParametersCstNode
144+
| LambdaParametersWithBracesCstNode
145+
| LambdaParameterTypeCstNode
146+
| LiteralCstNode
147+
| LocalVariableDeclarationCstNode
148+
| LocalVariableDeclarationStatementCstNode
149+
| LocalVariableTypeCstNode
150+
| MatchAllPatternCstNode
151+
| MethodBodyCstNode
152+
| MethodDeclarationCstNode
153+
| MethodDeclaratorCstNode
154+
| MethodHeaderCstNode
155+
| MethodInvocationSuffixCstNode
156+
| MethodModifierCstNode
157+
| MethodNameCstNode
158+
| MethodReferenceSuffixCstNode
159+
| ModularCompilationUnitCstNode
160+
| ModuleDeclarationCstNode
161+
| ModuleDirectiveCstNode
162+
| ModuleNameCstNode
163+
| NewExpressionCstNode
164+
| NormalClassDeclarationCstNode
165+
| NormalInterfaceDeclarationCstNode
166+
| NormalLambdaParameterCstNode
167+
| NormalLambdaParameterListCstNode
168+
| NumericTypeCstNode
169+
| OpensModuleDirectiveCstNode
170+
| OrdinaryCompilationUnitCstNode
171+
| PackageDeclarationCstNode
172+
| PackageModifierCstNode
173+
| PackageNameCstNode
174+
| PackageOrTypeNameCstNode
175+
| ParenthesisExpressionCstNode
176+
| PatternCstNode
177+
| PrimaryCstNode
178+
| PrimaryPrefixCstNode
179+
| PrimarySuffixCstNode
180+
| PrimitiveCastExpressionCstNode
181+
| PrimitiveTypeCstNode
182+
| ProvidesModuleDirectiveCstNode
183+
| QualifiedExplicitConstructorInvocationCstNode
184+
| ReceiverParameterCstNode
185+
| RecordBodyCstNode
186+
| RecordBodyDeclarationCstNode
187+
| RecordComponentCstNode
188+
| RecordComponentListCstNode
189+
| RecordComponentModifierCstNode
190+
| RecordDeclarationCstNode
191+
| RecordHeaderCstNode
192+
| RecordPatternCstNode
193+
| ReferenceTypeCastExpressionCstNode
194+
| ReferenceTypeCstNode
195+
| RegularLambdaParameterCstNode
196+
| RequiresModifierCstNode
197+
| RequiresModuleDirectiveCstNode
198+
| ResourceCstNode
199+
| ResourceListCstNode
200+
| ResourceSpecificationCstNode
201+
| ResultCstNode
202+
| ReturnStatementCstNode
203+
| ShiftOperatorCstNode
204+
| SimpleTypeNameCstNode
205+
| StatementCstNode
206+
| StatementExpressionCstNode
207+
| StatementExpressionListCstNode
208+
| StatementWithoutTrailingSubstatementCstNode
209+
| StaticInitializerCstNode
210+
| StringTemplateCstNode
211+
| SwitchBlockCstNode
212+
| SwitchBlockStatementGroupCstNode
213+
| SwitchLabelCstNode
214+
| SwitchRuleCstNode
215+
| SwitchStatementCstNode
216+
| SynchronizedStatementCstNode
217+
| TemplateArgumentCstNode
218+
| TemplateCstNode
219+
| TextBlockTemplateCstNode
220+
| ThrowsCstNode
221+
| ThrowStatementCstNode
222+
| TryStatementCstNode
223+
| TryWithResourcesStatementCstNode
224+
| TypeArgumentCstNode
225+
| TypeArgumentListCstNode
226+
| TypeArgumentsCstNode
227+
| TypeArgumentsOrDiamondCstNode
228+
| TypeBoundCstNode
229+
| TypeDeclarationCstNode
230+
| TypeIdentifierCstNode
231+
| TypeNameCstNode
232+
| TypeParameterCstNode
233+
| TypeParameterListCstNode
234+
| TypeParameterModifierCstNode
235+
| TypeParametersCstNode
236+
| TypePatternCstNode
237+
| TypeVariableCstNode
238+
| UnannClassOrInterfaceTypeCstNode
239+
| UnannClassTypeCstNode
240+
| UnannInterfaceTypeCstNode
241+
| UnannPrimitiveTypeCstNode
242+
| UnannPrimitiveTypeWithOptionalDimsSuffixCstNode
243+
| UnannReferenceTypeCstNode
244+
| UnannTypeCstNode
245+
| UnannTypeVariableCstNode
246+
| UnaryExpressionCstNode
247+
| UnaryExpressionNotPlusMinusCstNode
248+
| UnqualifiedClassInstanceCreationExpressionCstNode
249+
| UnqualifiedExplicitConstructorInvocationCstNode
250+
| UsesModuleDirectiveCstNode
251+
| VariableAccessCstNode
252+
| VariableArityParameterCstNode
253+
| VariableArityRecordComponentCstNode
254+
| VariableDeclaratorCstNode
255+
| VariableDeclaratorIdCstNode
256+
| VariableDeclaratorListCstNode
257+
| VariableInitializerCstNode
258+
| VariableInitializerListCstNode
259+
| VariableModifierCstNode
260+
| VariableParaRegularParameterCstNode
261+
| WhileStatementCstNode
262+
| WildcardBoundsCstNode
263+
| WildcardCstNode
264+
| YieldStatementCstNode;
28265

29266
export declare type CstChildrenDictionary = {
30267
[identifier: string]: CstElement[];
@@ -57,6 +294,7 @@ export abstract class JavaCstVisitor<IN, OUT> implements ICstVisitor<IN, OUT> {
57294
integerLiteral(ctx: IntegerLiteralCtx, param?: IN): OUT;
58295
floatingPointLiteral(ctx: FloatingPointLiteralCtx, param?: IN): OUT;
59296
booleanLiteral(ctx: BooleanLiteralCtx, param?: IN): OUT;
297+
shiftOperator(cts: ShiftOperatorCtx, param?: IN): OUT;
60298
primitiveType(ctx: PrimitiveTypeCtx, param?: IN): OUT;
61299
numericType(ctx: NumericTypeCtx, param?: IN): OUT;
62300
integralType(ctx: IntegralTypeCtx, param?: IN): OUT;
@@ -304,7 +542,7 @@ export abstract class JavaCstVisitor<IN, OUT> implements ICstVisitor<IN, OUT> {
304542
param?: IN
305543
): OUT;
306544
normalLambdaParameterList(ctx: NormalLambdaParameterListCtx, param?: IN): OUT;
307-
normalLambdaParameter(ctx: LambdaParameterCtx, param?: IN): OUT;
545+
normalLambdaParameter(ctx: NormalLambdaParameterCtx, param?: IN): OUT;
308546
regularLambdaParameter(ctx: RegularLambdaParameterCtx, param?: IN): OUT;
309547
lambdaParameterType(ctx: LambdaParameterTypeCtx, param?: IN): OUT;
310548
conciseLambdaParameter(ctx: ConciseLambdaParameterCtx, param?: IN): OUT;
@@ -389,6 +627,7 @@ export abstract class JavaCstVisitorWithDefaults<IN, OUT>
389627
integerLiteral(ctx: IntegerLiteralCtx, param?: IN): OUT;
390628
floatingPointLiteral(ctx: FloatingPointLiteralCtx, param?: IN): OUT;
391629
booleanLiteral(ctx: BooleanLiteralCtx, param?: IN): OUT;
630+
shiftOperator(cts: ShiftOperatorCtx, param?: IN): OUT;
392631
primitiveType(ctx: PrimitiveTypeCtx, param?: IN): OUT;
393632
numericType(ctx: NumericTypeCtx, param?: IN): OUT;
394633
integralType(ctx: IntegralTypeCtx, param?: IN): OUT;
@@ -636,7 +875,7 @@ export abstract class JavaCstVisitorWithDefaults<IN, OUT>
636875
param?: IN
637876
): OUT;
638877
normalLambdaParameterList(ctx: NormalLambdaParameterListCtx, param?: IN): OUT;
639-
normalLambdaParameter(ctx: LambdaParameterCtx, param?: IN): OUT;
878+
normalLambdaParameter(ctx: NormalLambdaParameterCtx, param?: IN): OUT;
640879
regularLambdaParameter(ctx: RegularLambdaParameterCtx, param?: IN): OUT;
641880
lambdaParameterType(ctx: LambdaParameterTypeCtx, param?: IN): OUT;
642881
conciseLambdaParameter(ctx: ConciseLambdaParameterCtx, param?: IN): OUT;
@@ -763,6 +1002,16 @@ export type BooleanLiteralCtx = {
7631002
False?: IToken[];
7641003
};
7651004

1005+
export interface ShiftOperatorCstNode extends CstNode {
1006+
name: "shiftOperator";
1007+
children: ShiftOperatorCtx;
1008+
}
1009+
1010+
export type ShiftOperatorCtx = {
1011+
Less?: IToken[];
1012+
Greater?: IToken[];
1013+
};
1014+
7661015
export interface PrimitiveTypeCstNode extends CstNode {
7671016
name: "primitiveType";
7681017
children: PrimitiveTypeCtx;
@@ -1819,17 +2068,16 @@ export interface CompilationUnitCstNode extends CstNode {
18192068

18202069
export type AbstractOrdinaryCompilationUnitCtx = {
18212070
ordinaryCompilationUnit: OrdinaryCompilationUnitCstNode[];
1822-
EOF: IToken[];
18232071
};
18242072

18252073
export type AbstractModularCompilationUnitCtx = {
18262074
modularCompilationUnit: OrdinaryCompilationUnitCstNode[];
1827-
EOF: IToken[];
18282075
};
18292076

18302077
export type CompilationUnitCtx =
18312078
| AbstractOrdinaryCompilationUnitCtx
1832-
| AbstractModularCompilationUnitCtx;
2079+
| AbstractModularCompilationUnitCtx
2080+
| { EOF: IToken[] };
18332081

18342082
export interface OrdinaryCompilationUnitCstNode extends CstNode {
18352083
name: "ordinaryCompilationUnit";
@@ -2912,10 +3160,10 @@ export type NormalLambdaParameterListCtx = {
29123160

29133161
export interface NormalLambdaParameterCstNode extends CstNode {
29143162
name: "normalLambdaParameter";
2915-
children: LambdaParameterCtx;
3163+
children: NormalLambdaParameterCtx;
29163164
}
29173165

2918-
export type LambdaParameterCtx = {
3166+
export type NormalLambdaParameterCtx = {
29193167
regularLambdaParameter?: RegularLambdaParameterCstNode[];
29203168
variableArityParameter?: VariableArityParameterCstNode[];
29213169
};
@@ -2985,8 +3233,7 @@ export type BinaryExpressionCtx = {
29853233
referenceType?: ReferenceTypeCstNode[];
29863234
AssignmentOperator?: IToken[];
29873235
expression?: ExpressionCstNode[];
2988-
Less?: IToken[];
2989-
Greater?: IToken[];
3236+
shiftOperator?: ShiftOperatorCstNode[];
29903237
BinaryOperator?: IToken[];
29913238
};
29923239

0 commit comments

Comments
 (0)