Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/alkaria999/java-ide-formatter

Code cleanup formatter for IntelliJ Idea, Eclipse IDE & STS Idea
https://github.com/alkaria999/java-ide-formatter

eclipse eclipse-formatter eclipse-ide intellij-formatter intellij-idea intellij-plugin java java-formatter java-ide-formatter java8 sts sts-formatter sts4

Last synced: 1 day ago
JSON representation

Code cleanup formatter for IntelliJ Idea, Eclipse IDE & STS Idea

Host: GitHub
URL: https://github.com/alkaria999/java-ide-formatter
Owner: alkaria999
Created: 2025-02-08T11:09:46.000Z (3 days ago)
Default Branch: main
Last Pushed: 2025-02-08T16:13:13.000Z (2 days ago)
Last Synced: 2025-02-08T17:23:37.328Z (2 days ago)
Topics: eclipse, eclipse-formatter, eclipse-ide, intellij-formatter, intellij-idea, intellij-plugin, java, java-formatter, java-ide-formatter, java8, sts, sts-formatter, sts4
Homepage:
Size: 548 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

        # Java Code Formatter

Ever faced a situation where every member of the team codes as per their convenience and style which causes problems for others to understand their code?

This problem can be countered when all the team member use the same code formatter configured into their IDE. This also helps to maintain a uniform coding style for the whole project thus reducing the rework to lint the code.

# Usage

These code formatting can be configured on Eclipse IDE and IntelliJ IDE as well, so depending which is your favourite IDE, you can easily configure code formatting as shown below.

## Eclipse IDE

Since the code style settings were exported from Eclipse, it is as easy to import it to Eclipse.

### Configure Clean Up code settings

Import the `my-clean-up.xml` file under `Preferences > Java > Code Style > Clean Up`.

![Clean Up](Images/eclipse-clean-up.png)

### Configure Code formatter settings

Import `my-code-formatter.xml` file under `Preferences > Java > Code Style > Formatter`.

![Code Formatter](Images/eclipse-formatter.png)

### Configure Organise Import settings

Import `my-import-order.importorder.xml` file under `Preferences > Java > Code Style > Organize Import`.

![Organize Import](Images/eclipse-organize-import.png)

### Trigger code formatting

To trigger code formatting, navigate to menu `Source > Format`.

## IntelliJ IDE

For importing these setting files in IntelliJ, you need to first install `Eclipse Code Formatter` plugin from `Preferences > Plugins`.

![IntelliJ Eclipse Code Formatter plugin](Images/intellij-eclipse-plugin.png)

### Configure Code formatting and Organise import settings

Once the plugin is installed and IDE is restarted, navigate to `Preferences > Other Settings > Eclipse Code Formatter` and import `my-code-formatter.xml` in `Eclipse Java Formatter config file` and `my-import-order.importorder` in `Import order > From File`.

![IntelliJ Eclipse Code Formatter settings](Images/intellij-eclipse-settings.png)

### Trigger code formatting

To trigger code formatting, navigate to menu `Code > Reformat Code`.

# Conclusion

This settings will help you maintain a uniform code style throughout the project.

> If you liked the formatting, :star: **the repo** and share the repository among your network.

# Contribution

You can update the config files in Eclipse and **send a PR across**, if it looks good, I will be glad to merge your changes in.