prettier-plugin-java 0.8.2 → 1.0.2

package/LICENSE

@@ -0,0 +1,204 @@
+
+    Copyright 2018-2021 the original author or authors from the JHipster project
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+    TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+    1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+    2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+    3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+    4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+    5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+    6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+    7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+    8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+    9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+    END OF TERMS AND CONDITIONS
+
+    APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+    Copyright [yyyy] [name of copyright owner]
+
+    Licensed under the Apache License, Version 2.0 (the "License");
+    you may not use this file except in compliance with the License.
+    You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.

package/README.md

@@ -121,7 +121,7 @@ We added a custom option ```entrypoint``` in order to run prettier on code snipp
 
 ### Usage
 ```prettier --write MyJava.java --entrypoint compilationUnit``` \
-[Here](https://github.com/jhipster/prettier-java/blob/master/packages/prettier-plugin-java/src/options.js) is the exhaustive list of all entrypoints.
+[Here](https://github.com/jhipster/prettier-java/blob/main/packages/prettier-plugin-java/src/options.js) is the exhaustive list of all entrypoints.
 
 ### Example
 MyJavaCode.java content:

package/package.json

@@ -1,14 +1,14 @@
 {
   "name": "prettier-plugin-java",
-  "version": "0.8.2",
+  "version": "1.0.2",
   "description": "Prettier Java Plugin",
   "main": "src/index.js",
   "repository": "https://github.com/jhipster/prettier-java",
   "license": "Apache-2.0",
   "dependencies": {
-    "java-parser": "0.8.2",
-    "lodash": "4.17.20",
-    "prettier": "2.1.1"
+    "java-parser": "1.0.2",
+    "lodash": "4.17.21",
+    "prettier": "2.2.1"
   },
   "scripts": {
     "test": "npm-run-all test:unit test:e2e-core",
@@ -19,5 +19,6 @@
     "test:e2e-jhipster2": "node scripts/clone-samples e2e-jhipster2 && mocha \"test/repository-test/jhipster-2-test.js\"",
     "test:all": "npm-run-all test test:e2e-jhipster1 test:e2e-jhipster2",
     "clone-samples": "node scripts/clone-samples.js"
-  }
+  },
+  "gitHead": "d4dbac80d37d361f314205956547becfafca685f"
 }

package/src/options.js

@@ -25,9 +25,11 @@ module.exports = {
       { value: "assertStatement" },
       { value: "switchStatement" },
       { value: "switchBlock" },
-      { value: "switchCase" },
+      { value: "switchBlockStatementGroup" },
       { value: "switchLabel" },
-      { value: "enumConstantName" },
+      { value: "switchRule" },
+      { value: "switchRuleLabel" },
+      { value: "caseConstant" },
       { value: "whileStatement" },
       { value: "doStatement" },
       { value: "forStatement" },
@@ -52,9 +54,11 @@ module.exports = {
       { value: "resourceList" },
       { value: "resource" },
       { value: "resourceInit" },
+      { value: "yieldStatement" },
       { value: "variableAccess" },
       { value: "isBasicForStatement" },
       { value: "isLocalVariableDeclaration" },
+      { value: "isClassicSwitchLabel" },
       { value: "classDeclaration" },
       { value: "normalClassDeclaration" },
       { value: "classModifier" },
@@ -74,6 +78,7 @@ module.exports = {
       { value: "variableInitializer" },
       { value: "unannType" },
       { value: "unannPrimitiveType" },
+      { value: "unannPrimitiveTypeWithOptionalDimsSuffix" },
       { value: "unannReferenceType" },
       { value: "unannClassOrInterfaceType" },
       { value: "unannClassType" },
@@ -113,7 +118,6 @@ module.exports = {
       { value: "isClassDeclaration" },
       { value: "identifyClassBodyDeclarationType" },
       { value: "isDims" },
-      { value: "constantExpression" },
       { value: "expression" },
       { value: "lambdaExpression" },
       { value: "lambdaParameters" },

package/src/printers/blocks-and-statements.js

@@ -1,7 +1,7 @@
 "use strict";
 
 const { line, softline, hardline } = require("prettier").doc.builders;
-const { group, indent, concat, join } = require("./prettier-builder");
+const { group, indent, dedent, concat, join } = require("./prettier-builder");
 const { printTokenWithComments } = require("./comments/format-comments");
 const {
   hasLeadingLineComments,
@@ -195,7 +195,10 @@ class BlocksAndStatementPrettierVisitor {
   }
 
   switchBlock(ctx) {
-    const switchCases = this.mapVisit(ctx.switchCase);
+    const switchCases =
+      ctx.switchBlockStatementGroup !== undefined
+        ? this.mapVisit(ctx.switchBlockStatementGroup)
+        : this.mapVisit(ctx.switchRule);
 
     return putIntoBraces(
       rejectAndJoin(hardline, switchCases),
@@ -205,27 +208,63 @@ class BlocksAndStatementPrettierVisitor {
     );
   }
 
-  switchCase(ctx) {
-    const switchLabel = this.visit(ctx.switchLabel);
+  switchBlockStatementGroup(ctx) {
+    const switchLabels = this.mapVisit(ctx.switchLabel);
+
+    const labels = [];
+    for (let i = 0; i < switchLabels.length; i++) {
+      labels.push(concat([switchLabels[i], ctx.Colon[i]]));
+    }
+
     const blockStatements = this.visit(ctx.blockStatements);
 
-    return indent(rejectAndJoin(hardline, [switchLabel, blockStatements]));
+    return indent(
+      rejectAndJoin(hardline, [
+        dedent(rejectAndJoin(hardline, labels)),
+        blockStatements
+      ])
+    );
   }
 
   switchLabel(ctx) {
     if (ctx.Case) {
-      const constantExpression = this.visit(ctx.constantExpression);
-      return rejectAndConcat([
-        concat([ctx.Case[0], " "]),
-        constantExpression,
-        ctx.Colon[0]
-      ]);
+      const caseConstants = this.mapVisit(ctx.caseConstant);
+
+      const commas = ctx.Comma
+        ? ctx.Comma.map(elt => {
+            return concat([elt, line]);
+          })
+        : [];
+
+      return group(
+        indent(
+          rejectAndConcat([
+            concat([ctx.Case[0], " "]),
+            rejectAndJoinSeps(commas, caseConstants)
+          ])
+        )
+      );
     }
 
-    return concat([ctx.Default[0], ctx.Colon[0]]);
+    return concat([ctx.Default[0]]);
   }
 
-  enumConstantName(ctx) {
+  switchRule(ctx) {
+    const switchLabel = this.visit(ctx.switchLabel);
+
+    let caseInstruction;
+    if (ctx.throwStatement !== undefined) {
+      caseInstruction = this.visit(ctx.throwStatement);
+    } else if (ctx.block !== undefined) {
+      caseInstruction = this.visit(ctx.block);
+    } else {
+      caseInstruction = concat([this.visit(ctx.expression), ctx.Semicolon[0]]);
+    }
+
+    return join(" ", [switchLabel, ctx.Arrow[0], caseInstruction]);
+  }
+
+  caseConstant(ctx) {
     return this.visitSingle(ctx);
   }
 
@@ -522,6 +561,11 @@ class BlocksAndStatementPrettierVisitor {
     ]);
   }
 
+  yieldStatement(ctx) {
+    const expression = this.visit(ctx.expression);
+    return join(" ", [ctx.Yield[0], concat([expression, ctx.Semicolon[0]])]);
+  }
+
   variableAccess(ctx) {
     return this.visitSingle(ctx);
   }
@@ -533,6 +577,10 @@ class BlocksAndStatementPrettierVisitor {
   isLocalVariableDeclaration() {
     return "isLocalVariableDeclaration";
   }
+
+  isClassicSwitchLabel() {
+    return "isClassicSwitchLabel";
+  }
 }
 
 module.exports = {

package/src/printers/classes.js

@@ -43,7 +43,7 @@ class ClassesPrettierVisitor {
     const optionalTypeParams = this.visit(ctx.typeParameters);
     const optionalSuperClasses = this.visit(ctx.superclass);
     const optionalSuperInterfaces = this.visit(ctx.superinterfaces);
-    const body = this.visit(ctx.classBody);
+    const body = this.visit(ctx.classBody, { isNormalClassDeclaration: true });
 
     let superClassesPart = "";
     if (optionalSuperClasses) {
@@ -113,7 +113,7 @@ class ClassesPrettierVisitor {
     return group(rejectAndJoinSeps(commas, interfaceType));
   }
 
-  classBody(ctx) {
+  classBody(ctx, param) {
     let content = "";
     if (ctx.classBodyDeclaration !== undefined) {
       const classBodyDeclsVisited = reject(
@@ -126,15 +126,24 @@ class ClassesPrettierVisitor {
 
       content = rejectAndJoinSeps(separators, classBodyDeclsVisited);
 
+      // edge case when we have SemiColons
+      let shouldHardline = false;
+      ctx.classBodyDeclaration.forEach(elt => {
+        if (
+          (elt.children.classMemberDeclaration &&
+            !elt.children.classMemberDeclaration[0].children.Semicolon) ||
+          elt.children.constructorDeclaration
+        ) {
+          shouldHardline = true;
+        }
+      });
+
       if (
-        !(
-          ctx.classBodyDeclaration[0].children.classMemberDeclaration !==
-            undefined &&
-          (ctx.classBodyDeclaration[0].children.classMemberDeclaration[0]
-            .children.fieldDeclaration !== undefined ||
-            ctx.classBodyDeclaration[0].children.classMemberDeclaration[0]
-              .children.Semicolon !== undefined)
-        )
+        (ctx.classBodyDeclaration[0].children.classMemberDeclaration ||
+          ctx.classBodyDeclaration[0].children.constructorDeclaration) &&
+        shouldHardline &&
+        param &&
+        param.isNormalClassDeclaration
       ) {
         content = rejectAndConcat([hardline, content]);
       }
@@ -300,10 +309,10 @@ class ClassesPrettierVisitor {
   }
 
   unannType(ctx) {
-    if (ctx.unannReferenceType !== undefined) {
-      return this.visit(ctx.unannReferenceType);
-    }
+    return this.visitSingle(ctx);
+  }
 
+  unannPrimitiveTypeWithOptionalDimsSuffix(ctx) {
     const unannPrimitiveType = this.visit(ctx.unannPrimitiveType);
     const dims = this.visit(ctx.dims);
 
@@ -345,6 +354,7 @@ class ClassesPrettierVisitor {
         currentSegment = [];
       } else if (token.name === "annotation") {
         currentSegment.push(this.visit([token]));
+        currentSegment.push(" ");
       } else {
         currentSegment.push(token);
         if (
@@ -402,11 +412,6 @@ class ClassesPrettierVisitor {
     const declarator = this.visit(ctx.methodDeclarator);
     const throws = this.visit(ctx.throws);
 
-    let throwsPart = "";
-    if (throws) {
-      throwsPart = indent(rejectAndConcat([softline, throws]));
-    }
-
     return group(
       concat([
         rejectAndJoin(" ", [
@@ -414,7 +419,7 @@ class ClassesPrettierVisitor {
           rejectAndJoin(line, annotations),
           result,
           declarator,
-          throwsPart
+          throws
         ])
       ])
     );
@@ -514,7 +519,8 @@ class ClassesPrettierVisitor {
 
   throws(ctx) {
     const exceptionTypeList = this.visit(ctx.exceptionTypeList);
-    return join(" ", [ctx.Throws[0], exceptionTypeList]);
+    const throwsDeclaration = join(" ", [ctx.Throws[0], exceptionTypeList]);
+    return group(indent(rejectAndConcat([softline, throwsDeclaration])));
   }
 
   exceptionTypeList(ctx) {
@@ -554,11 +560,6 @@ class ClassesPrettierVisitor {
     const throws = this.visit(ctx.throws);
     const constructorBody = this.visit(ctx.constructorBody);
 
-    let throwsPart = "";
-    if (throws) {
-      throwsPart = indent(rejectAndConcat([softline, throws]));
-    }
-
     return rejectAndJoin(" ", [
       group(
         rejectAndJoin(hardline, [
@@ -566,7 +567,7 @@ class ClassesPrettierVisitor {
           rejectAndJoin(" ", [
             join(" ", otherModifiers),
             constructorDeclarator,
-            throwsPart
+            throws
           ])
         ])
       ),

package/src/printers/expressions.js

@@ -22,10 +22,6 @@ const {
 } = require("./printer-utils");
 
 class ExpressionsPrettierVisitor {
-  constantExpression(ctx) {
-    return this.visitSingle(ctx);
-  }
-
   expression(ctx, params) {
     return this.visitSingle(ctx, params);
   }
@@ -171,7 +167,7 @@ class ExpressionsPrettierVisitor {
       groupsOfOperator,
       sortedBinaryOperators
     } = separateTokensIntoGroups(ctx);
-    const segmentsSplittedByBinaryOperator = [];
+    const segmentsSplitByBinaryOperator = [];
     let currentSegment = [];
 
     if (groupsOfOperator.length === 1 && groupsOfOperator[0].length === 0) {
@@ -216,7 +212,7 @@ class ExpressionsPrettierVisitor {
           );
         }
       }
-      segmentsSplittedByBinaryOperator.push(
+      segmentsSplitByBinaryOperator.push(
         group(rejectAndJoin(" ", currentSegment))
       );
     });
@@ -231,7 +227,7 @@ class ExpressionsPrettierVisitor {
               group(
                 rejectAndJoinSeps(
                   sortedBinaryOperators.map(elt => concat([" ", elt, line])),
-                  segmentsSplittedByBinaryOperator
+                  segmentsSplitByBinaryOperator
                 )
               )
             ])
@@ -245,7 +241,7 @@ class ExpressionsPrettierVisitor {
     return group(
       rejectAndJoinSeps(
         sortedBinaryOperators.map(elt => concat([" ", elt, line])),
-        segmentsSplittedByBinaryOperator
+        segmentsSplitByBinaryOperator
       )
     );
   }
@@ -345,7 +341,10 @@ class ExpressionsPrettierVisitor {
         suffixes.push(this.visit(ctx.primarySuffix[i]));
       }
 
-      if (countMethodInvocation === 1) {
+      if (
+        countMethodInvocation === 1 &&
+        ctx.primaryPrefix[0].children.newExpression === undefined
+      ) {
         return group(
           rejectAndConcat([
             primaryPrefix,
@@ -362,7 +361,7 @@ class ExpressionsPrettierVisitor {
   }
 
   primaryPrefix(ctx, params) {
-    if (ctx.This || ctx.Void || ctx.Boolean) {
+    if (ctx.This || ctx.Void) {
       return printTokenWithComments(this.getSingle(ctx));
     }
 
@@ -587,10 +586,6 @@ class ExpressionsPrettierVisitor {
   }
 
   methodInvocationSuffix(ctx, params) {
-    if (ctx.argumentList === undefined) {
-      return rejectAndConcat([ctx.LBrace[0], ctx.RBrace[0]]);
-    }
-
     const argumentList = this.visit(ctx.argumentList);
     if (params && params.shouldDedent) {
       return dedent(

package/src/printers/lexical-structure.js

@@ -3,7 +3,7 @@ const { printTokenWithComments } = require("./comments/format-comments");
 
 class LexicalStructurePrettierVisitor {
   literal(ctx) {
-    if (ctx.CharLiteral || ctx.StringLiteral || ctx.Null) {
+    if (ctx.CharLiteral || ctx.TextBlock || ctx.StringLiteral || ctx.Null) {
       return printTokenWithComments(this.getSingle(ctx));
     }
     return this.visitSingle(ctx);