npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

prettier-plugin-java

v2.6.5

Published

Prettier Java Plugin

Downloads

491,463

Readme

npm

prettier-plugin-java

Prettier Java Banner

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();
}