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 Java

Status

• Working version released
• Please file any bugs

ToDos

• Make everything more prettier ;)
• Increase performance (It's already fast though)

---

Install

yarn add --dev --exact prettier prettier-plugin-java

Use

prettier --write "**/*.java"

Attention

If you're interested in contributing to the development of Prettier for Java, you can follow the CONTRIBUTING guide from Prettier, as it all applies to this repository too.

To test it out on a Java file:

• Clone this repository.
• Run yarn.
• Create a file called test.java.
• Run yarn prettier test.java to check the output.
• Run test.sh ../some_project/**/*.java it on your whole project and check for issues, check test_files/*.error (and compare with the .java and the prettier output *.prettier)
• Check PREVIEW.md for current status of how how certain parts look like (generated automatically from the test cases)

Testing

• You can call yarn testto test against all regular tests