prettier-plugin-java

What is prettier-plugin-java?

The prettier-plugin-java npm package is a plugin for Prettier that formats Java code. It ensures that Java code adheres to a consistent style, making it easier to read and maintain.

What are prettier-plugin-java's main functionalities?

Code Formatting

This feature automatically formats Java code to follow a consistent style. For example, it ensures proper indentation, spacing, and line breaks.

public class HelloWorld {
  public static void main(String[] args) {
    System.out.println("Hello, World!");
  }
}

Consistent Style

This feature enforces a consistent coding style across the entire codebase, making it easier to read and maintain. It handles things like method spacing, bracket placement, and more.

public class Example {
  private int value;

  public int getValue() {
    return value;
  }

  public void setValue(int value) {
    this.value = value;
  }
}

Integration with Prettier

This feature allows the plugin to be easily integrated with Prettier, enabling seamless formatting of Java code alongside other languages supported by Prettier.

{
  "prettier": {
    "plugins": ["prettier-plugin-java"]
  }
}

Other packages similar to prettier-plugin-java

google-java-format

google-java-format is a program that reformats Java source code to comply with Google Java Style. It is similar to prettier-plugin-java in that it enforces a consistent style, but it specifically adheres to Google's style guide.

spotless

Spotless is a general-purpose code formatter that supports multiple languages, including Java. It can be configured to use different formatters, such as google-java-format or prettier-plugin-java, providing flexibility in formatting rules.

README

prettier-plugin-java

Prettier is an opinionated code formatter which forces a certain coding style. It makes the code consistent through an entire project.

This plugin allows the support of Java on Prettier.

The plugin implementation is pretty straightforward as it uses java-parser (thanks to Chevrotain) visitor to traverse the Concrete Syntax Tree and apply the format processing on each node (it uses Prettier API).

Installation

Pre-requirements

Since the plugin is meant to be used with Prettier, you need to install it:

npm install --save-dev --save-exact prettier

or

yarn add prettier --dev --exact

Install plugin

npm install prettier-plugin-java --save-dev

or

yarn add prettier-plugin-java --dev

CLI

If you installed Prettier globally and want to format java code via the CLI, run the following command:

npm install -g prettier-plugin-java

The plugin will be automatically loaded, check here for more.

Usage

CLI

prettier --write MyJavaFile.java

If the plugin is not automatically loaded:

# Example where the plugin is locate in node_modules
prettier --write MyJavaFile.java --plugin=./node_modules/prettier-plugin-java

API

const prettier = require("prettier");
const javaText = `
public class HelloWorldExample{
  public static void main(String args[]){
    System.out.println("Hello World !");
  }
}
`;

const formattedText = prettier.format(javaText, {
  parser: "java",
  tabWidth: 2
});

Example of formatted code

Input

public class HelloWorld {
public static void main(String[] args) {System.out.println("Hello World!");;;;;}

@Override
public String toString() {
  return "Hello World";
}
  public int sum(int argument1,int argument2,int argument3,int argument4,int argument5
  ) {
    return argument1+argument2+ argument3 +argument4  + argument5;
  }
}

Output

public class HelloWorld {

  public static void main(String[] args) {
    System.out.println("Hello World!");
  }

  @Override
  public String toString() {
    return "Hello World";
  }

  public int sum(
    int argument1,
    int argument2,
    int argument3,
    int argument4,
    int argument5
  ) {
    return argument1 + argument2 + argument3 + argument4 + argument5;
  }
}

Options

We added a custom option entrypoint in order to run prettier on code snippet.

Usage

prettier --write MyJava.java --entrypoint compilationUnit
Here is the exhaustive list of all entrypoints.

Example

MyJavaCode.java content:

public void myfunction() {
    mymethod.is().very().very().very().very().very().very().very().very().very().very().very().very().very().very().big();
}

Run:
prettier --write MyJavaCode.java --entrypoint classBodyDeclaration

Result:

public void myfunction() {
  mymethod
    .is()
    .very()
    .very()
    .very()
    .very()
    .very()
    .very()
    .very()
    .very()
    .very()
    .very()
    .very()
    .very()
    .very()
    .very()
    .big();
}

Changelog

v0.8.0

Enhancements

• Possibility to run the Prettier Java package on every entrypoint defined in the following list (#395):

  [
    "variableInitializerList",
    "block",
    "blockStatements",
    "blockStatement",
    "localVariableDeclarationStatement",
    "localVariableDeclaration",
    "localVariableType",
    "statement",
    "statementWithoutTrailingSubstatement",
    "emptyStatement",
    "labeledStatement",
    "expressionStatement",
    "statementExpression",
    "ifStatement",
    "assertStatement",
    "switchStatement",
    "switchBlock",
    "switchCase",
    "switchLabel",
    "enumConstantName",
    "whileStatement",
    "doStatement",
    "forStatement",
    "basicForStatement",
    "forInit",
    "forUpdate",
    "statementExpressionList",
    "enhancedForStatement",
    "breakStatement",
    "continueStatement",
    "returnStatement",
    "throwStatement",
    "synchronizedStatement",
    "tryStatement",
    "catches",
    "catchClause",
    "catchFormalParameter",
    "catchType",
    "finally",
    "tryWithResourcesStatement",
    "resourceSpecification",
    "resourceList",
    "resource",
    "resourceInit",
    "variableAccess",
    "isBasicForStatement",
    "isLocalVariableDeclaration",
    "classDeclaration",
    "normalClassDeclaration",
    "classModifier",
    "typeParameters",
    "typeParameterList",
    "superclass",
    "superinterfaces",
    "interfaceTypeList",
    "classBody",
    "classBodyDeclaration",
    "classMemberDeclaration",
    "fieldDeclaration",
    "fieldModifier",
    "variableDeclaratorList",
    "variableDeclarator",
    "variableDeclaratorId",
    "variableInitializer",
    "unannType",
    "unannPrimitiveType",
    "unannReferenceType",
    "unannClassOrInterfaceType",
    "unannClassType",
    "unannInterfaceType",
    "unannTypeVariable",
    "methodDeclaration",
    "methodModifier",
    "methodHeader",
    "result",
    "methodDeclarator",
    "receiverParameter",
    "formalParameterList",
    "formalParameter",
    "variableParaRegularParameter",
    "variableArityParameter",
    "variableModifier",
    "throws",
    "exceptionTypeList",
    "exceptionType",
    "methodBody",
    "instanceInitializer",
    "staticInitializer",
    "constructorDeclaration",
    "constructorModifier",
    "constructorDeclarator",
    "simpleTypeName",
    "constructorBody",
    "explicitConstructorInvocation",
    "unqualifiedExplicitConstructorInvocation",
    "qualifiedExplicitConstructorInvocation",
    "enumDeclaration",
    "enumBody",
    "enumConstantList",
    "enumConstant",
    "enumConstantModifier",
    "enumBodyDeclarations",
    "isClassDeclaration",
    "identifyClassBodyDeclarationType",
    "isDims",
    "constantExpression",
    "expression",
    "lambdaExpression",
    "lambdaParameters",
    "lambdaParametersWithBraces",
    "lambdaParameterList",
    "inferredLambdaParameterList",
    "explicitLambdaParameterList",
    "lambdaParameter",
    "regularLambdaParameter",
    "lambdaParameterType",
    "lambdaBody",
    "ternaryExpression",
    "binaryExpression",
    "unaryExpression",
    "unaryExpressionNotPlusMinus",
    "primary",
    "primaryPrefix",
    "primarySuffix",
    "fqnOrRefType",
    "fqnOrRefTypePartRest",
    "fqnOrRefTypePartCommon",
    "fqnOrRefTypePartFirst",
    "parenthesisExpression",
    "castExpression",
    "primitiveCastExpression",
    "referenceTypeCastExpression",
    "newExpression",
    "unqualifiedClassInstanceCreationExpression",
    "classOrInterfaceTypeToInstantiate",
    "typeArgumentsOrDiamond",
    "diamond",
    "methodInvocationSuffix",
    "argumentList",
    "arrayCreationExpression",
    "arrayCreationDefaultInitSuffix",
    "arrayCreationExplicitInitSuffix",
    "dimExprs",
    "dimExpr",
    "classLiteralSuffix",
    "arrayAccessSuffix",
    "methodReferenceSuffix",
    "identifyNewExpressionType",
    "isLambdaExpression",
    "isCastExpression",
    "isPrimitiveCastExpression",
    "isReferenceTypeCastExpression",
    "isRefTypeInMethodRef",
    "interfaceDeclaration",
    "normalInterfaceDeclaration",
    "interfaceModifier",
    "extendsInterfaces",
    "interfaceBody",
    "interfaceMemberDeclaration",
    "constantDeclaration",
    "constantModifier",
    "interfaceMethodDeclaration",
    "interfaceMethodModifier",
    "annotationTypeDeclaration",
    "annotationTypeBody",
    "annotationTypeMemberDeclaration",
    "annotationTypeElementDeclaration",
    "annotationTypeElementModifier",
    "defaultValue",
    "annotation",
    "elementValuePairList",
    "elementValuePair",
    "elementValue",
    "elementValueArrayInitializer",
    "elementValueList",
    "identifyInterfaceBodyDeclarationType",
    "identifyAnnotationBodyDeclarationType",
    "isSimpleElementValueAnnotation",
    "literal",
    "integerLiteral",
    "floatingPointLiteral",
    "booleanLiteral",
    "moduleName",
    "packageName",
    "typeName",
    "expressionName",
    "methodName",
    "packageOrTypeName",
    "ambiguousName",
    "compilationUnit",
    "ordinaryCompilationUnit",
    "modularCompilationUnit",
    "packageDeclaration",
    "packageModifier",
    "importDeclaration",
    "typeDeclaration",
    "moduleDeclaration",
    "moduleDirective",
    "requiresModuleDirective",
    "exportsModuleDirective",
    "opensModuleDirective",
    "usesModuleDirective",
    "providesModuleDirective",
    "requiresModifier",
    "isModuleCompilationUnit",
    "primitiveType",
    "numericType",
    "integralType",
    "floatingPointType",
    "referenceType",
    "classOrInterfaceType",
    "classType",
    "interfaceType",
    "typeVariable",
    "dims",
    "typeParameter",
    "typeParameterModifier",
    "typeBound",
    "additionalBound",
    "typeArguments",
    "typeArgumentList",
    "typeArgument",
    "wildcard",
    "wildcardBounds"
  ];
  

Fixes

Re-Writer

• Fix formatting of empty enums to not insert commas when trailing-comma is enabled #385)

  // Input
  public enum Enum {}
  
  // Prettier v0.7.1
  public enum Enum {
  
  }
  
  // Prettier v0.8.0
  public enum Enum {}
  
  

• Fix formatting of enum with comments #385)

Miscellaneous

• Update prettier dependency to 2.0.5 (#379) & (#400)
• Binary artefacts creation for each release (#399)
• Document Maven plugin (#394)