Skip to content
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

Fix/712 handle comments with static invocations #715

Merged
merged 3 commits into from
Jan 22, 2025
Merged

Fix/712 handle comments with static invocations #715

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8246a23
fix: handle edge cases with comments in fqn parts
clementdessoude Jan 20, 2025
2a1c78e
fix: do not add dot before dims in fqn parts
clementdessoude Jan 20, 2025
4d366ee
refactor: simplify logic for printing fqn parts
clementdessoude Jan 20, 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
87 changes: 22 additions & 65 deletions packages/prettier-plugin-java/src/printers/expressions.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -367,15 +367,10 @@ export class ExpressionsPrettierVisitor extends BaseCstPrettierPrinter {
const fqnOrRefType =
ctx.primaryPrefix[0].children.fqnOrRefType?.[0].children;
const hasFqnRefPart = fqnOrRefType?.fqnOrRefTypePartRest !== undefined;
const {
isCapitalizedIdentifier,
isCapitalizedIdentifierWithoutTrailingComment
} = this.handleStaticInvocations(fqnOrRefType);
const isCapitalizedIdentifier = this.isCapitalizedIdentifier(fqnOrRefType);

const shouldBreakBeforeFirstMethodInvocation =
countMethodInvocation > 1 &&
hasFqnRefPart &&
!isCapitalizedIdentifierWithoutTrailingComment;
countMethodInvocation > 1 && hasFqnRefPart && !isCapitalizedIdentifier;

const shouldBreakBeforeMethodInvocations =
shouldBreakBeforeFirstMethodInvocation ||
Expand Down Expand Up @@ -425,20 +420,6 @@ export class ExpressionsPrettierVisitor extends BaseCstPrettierPrinter {
);
}

private handleStaticInvocations(fqnOrRefType: FqnOrRefTypeCtx | undefined) {
const lastFqnRefPartDot = this.lastFqnOrRefDot(fqnOrRefType);
const isCapitalizedIdentifier = this.isCapitalizedIdentifier(fqnOrRefType);
const isCapitalizedIdentifierWithoutTrailingComment =
isCapitalizedIdentifier &&
(lastFqnRefPartDot === undefined ||
!hasLeadingComments(lastFqnRefPartDot));

return {
isCapitalizedIdentifier,
isCapitalizedIdentifierWithoutTrailingComment
};
}

primaryPrefix(ctx: PrimaryPrefixCtx, params: any) {
if (ctx.This || ctx.Void) {
return printTokenWithComments(this.getSingle(ctx) as IToken);
Expand Down Expand Up @@ -468,47 +449,31 @@ export class ExpressionsPrettierVisitor extends BaseCstPrettierPrinter {
const fqnOrRefTypePartFirst = this.visit(ctx.fqnOrRefTypePartFirst);
const fqnOrRefTypePartRest = this.mapVisit(ctx.fqnOrRefTypePartRest);
const dims = this.visit(ctx.dims);
const dots = ctx.Dot ? ctx.Dot : [];
const isMethodInvocation = ctx.Dot && ctx.Dot.length === 1;
const dots = ctx.Dot
? ctx.Dot.map(dot => {
if (hasLeadingComments(dot)) {
return concat([softline, dot]);
}
return dot;
})
: [];

if (
params !== undefined &&
params.shouldBreakBeforeFirstMethodInvocation === true
params?.shouldBreakBeforeFirstMethodInvocation === true &&
ctx.Dot !== undefined
) {
// when fqnOrRefType is a method call from an object
if (isMethodInvocation) {
return rejectAndConcat([
indent(
rejectAndJoin(concat([softline, dots[0]]), [
fqnOrRefTypePartFirst,
rejectAndJoinSeps(dots.slice(1), fqnOrRefTypePartRest),
dims
])
)
]);
// otherwise it is a fully qualified name but we need to exclude when it is just a method call
} else if (ctx.Dot) {
return indent(
rejectAndConcat([
rejectAndJoinSeps(dots.slice(0, dots.length - 1), [
fqnOrRefTypePartFirst,
...fqnOrRefTypePartRest.slice(0, fqnOrRefTypePartRest.length - 1)
]),
softline,
rejectAndConcat([
dots[dots.length - 1],
fqnOrRefTypePartRest[fqnOrRefTypePartRest.length - 1]
]),
dims
])
);
}
dots[dots.length - 1] = concat([softline, ctx.Dot[ctx.Dot.length - 1]]);
}

return rejectAndConcat([
rejectAndJoinSeps(dots, [fqnOrRefTypePartFirst, ...fqnOrRefTypePartRest]),
dims
]);
return indent(
rejectAndConcat([
rejectAndJoinSeps(dots, [
fqnOrRefTypePartFirst,
...fqnOrRefTypePartRest
]),
dims
])
);
}

fqnOrRefTypePartFirst(ctx: FqnOrRefTypePartFirstCtx) {
Expand Down Expand Up @@ -907,14 +872,6 @@ export class ExpressionsPrettierVisitor extends BaseCstPrettierPrinter {
);
}

private lastFqnOrRefDot(fqnOrRefType: FqnOrRefTypeCtx | undefined) {
if (fqnOrRefType === undefined || fqnOrRefType.Dot === undefined) {
return undefined;
}

return fqnOrRefType.Dot[fqnOrRefType.Dot.length - 1];
}

private getPrimarySuffixes(
ctx: PrimaryCtx,
newExpression: NewExpressionCtx | undefined,
Expand Down
98 changes: 78 additions & 20 deletions packages/prettier-plugin-java/test/unit-test/member_chain/_input.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,25 +1,83 @@
public class BreakLongFunctionCall {

public void doSomething() {
return new Object().something().more();
}
public void doSomething() {
return new Object().something().more();
}

public void doSomethingNewWithComment() {
return new Object()
new Object()
// comment
.something().more();

new Object().something()
// comment
.more();
}

public void doSomethingWithComment() {
return Object
Object
// comment
.something().more();

java.Object
// comment
.something().more();

java.averyveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryverylong.Object
// comment
.something().more();

java
// comment
.averyveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryverylong.Object
.something().more();

java
.averyveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryverylong
// comment
.Object
.something().more();

java.averyveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryverylong.Object
.something().more();

Object.something()
// comment
.more();

averyveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryverylong.java
// comment
.util()
.java.java();

averyveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryverylong
// comment
.java
.util()
.java.java();

averyveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryverylong.java
/* comment */
.util()
.java.java();

averyveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryverylong.java/* comment */
.util()
.java.java();

averyveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryverylong.java
/* comment */.util()
.java.java();
}

public void doSomethingWithComment() {
return object
object
// comment
.something().more();

object.something()
// comment
.more();
}

public void doSomethingNewWithComment() {
Expand All @@ -40,28 +98,28 @@ public void doSomethingWithComment() {
.something().more();
}

public void doSomethingLongNew() {
return something().more().and().that().as().well().but().not().something().something();
public void doSomethingLongNew() {
return something().more().and().that().as().well().but().not().something().something();
}

public void doSomethingLongWithArgument() {
return something().more(firstArgument, secondArgument).and(firstArgument, secondArgument, thirdArgument, fourthArgument, fifthArgument);
}

public void doSomethingLongNew2() {
return new Object().something().more().and().that().as().well().but().not().something();
}
public void doSomethingLongNew2() {
return new Object().something().more().and().that().as().well().but().not().something();
}

public void doSomethingLongStatic() {
return Object.something().more().and().that().as().well().but().not().something();
}
public void doSomethingLongStatic() {
return Object.something().more().and().that().as().well().but().not().something();
}

public void singleInvocationOnNewExpression() {
new Instance(aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa, aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa).invocation(aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa, aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa);
}
public void singleInvocationOnNewExpression() {
new Instance(aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa, aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa).invocation(aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa, aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa);
}

public void multipleInvocationsOnNewExpression() {
new Instance(aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa, aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa).invocation(aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa, aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa).andAnother();
}
public void multipleInvocationsOnNewExpression() {
new Instance(aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa, aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa).invocation(aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa, aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa).andAnother();
}

}
67 changes: 64 additions & 3 deletions packages/prettier-plugin-java/test/unit-test/member_chain/_output.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,24 +5,85 @@ public void doSomething() {
}

public void doSomethingNewWithComment() {
return new Object()
new Object()
// comment
.something()
.more();

new Object()
.something()
// comment
.more();
}

public void doSomethingWithComment() {
return Object
Object
// comment
.something()
.more();

java.Object
// comment
.something()
.more();

java.averyveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryverylong.Object
// comment
.something()
.more();

java
// comment
.averyveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryverylong.Object.something()
.more();

java.averyveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryverylong
// comment
.Object.something()
.more();

java.averyveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryverylong.Object.something()
.more();

Object.something()
// comment
.more();

averyveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryverylong.java
// comment
.util()
.java.java();

averyveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryverylong
// comment
.java
.util()
.java.java();

averyveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryverylong.java
/* comment */
.util()
.java.java();

averyveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryverylong.java/* comment */
.util()
.java.java();

averyveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryverylong.java
/* comment */.util()
.java.java();
}

public void doSomethingWithComment() {
return object
object
// comment
.something()
.more();

object
.something()
// comment
.more();
}

public void doSomethingNewWithComment() {
Expand Down
Loading