|
1 | | -# intellij-java-code-aligner |
| 1 | +# Java Code Aligner |
2 | 2 |
|
3 | 3 |  |
4 | 4 | [](https://plugins.jetbrains.com/plugin/17939-java-code-aligner) |
5 | 5 | [](https://plugins.jetbrains.com/plugin/17939-java-code-aligner) |
6 | 6 |
|
7 | | -## Template ToDo list |
8 | | -- [x] Create a new [IntelliJ Platform Plugin Template][template] project. |
9 | | -- [ ] Get known with the [template documentation][template]. |
10 | | -- [ ] Verify the [pluginGroup](/gradle.properties), [plugin ID](/src/main/resources/META-INF/plugin.xml) and [sources package](/src/main/kotlin). |
11 | | -- [ ] Review the [Legal Agreements](https://plugins.jetbrains.com/docs/marketplace/legal-agreements.html). |
12 | | -- [ ] [Publish a plugin manually](https://plugins.jetbrains.com/docs/intellij/publishing-plugin.html?from=IJPluginTemplate) for the first time. |
13 | | -- [ ] Set the Plugin ID in the above README badges. |
14 | | -- [ ] Set the [Deployment Token](https://plugins.jetbrains.com/docs/marketplace/plugin-upload.html). |
15 | | -- [ ] Click the <kbd>Watch</kbd> button on the top of the [IntelliJ Platform Plugin Template][template] to be notified about releases containing new features and fixes. |
16 | | - |
17 | 7 | <!-- Plugin description --> |
18 | | -This Fancy IntelliJ Platform Plugin is going to be your implementation of the brilliant ideas that you have. |
| 8 | +Provides displaying the Java code as aligned horizontally in columns without actual formatting of the code. |
| 9 | + |
| 10 | +It mainly serves for _increasing code readability_ and _reducing tension_ |
| 11 | +when reading dozens of tightly placed code lines with different elements. |
| 12 | + |
| 13 | +More formally the plugin provides: |
19 | 14 |
|
20 | | -This specific section is a source for the [plugin.xml](/src/main/resources/META-INF/plugin.xml) file which will be extracted by the [Gradle](/build.gradle.kts) during the build process. |
| 15 | +- alignment of consecutive fields, local variables and params in columns of annotations, modifiers, types, names, |
| 16 | + initializers; |
| 17 | +- alignment of consecutive assignments by the equal sign; |
| 18 | +- pretty rich set of alignment settings in `File | Settings | Editor | Inlay Hints | Java | Java Code Aligner`. |
21 | 19 |
|
22 | | -To keep everything working, do not remove `<!-- ... -->` sections. |
| 20 | +From the technical side, plugin works by adding invisible inlay hints (like the ones shown as parameter names for method |
| 21 | +calls), which can be made visible via `Enable debug mode` in settings above. |
| 22 | + |
| 23 | +Additionally, the plugin provides **folding of explicit types** to `var` and `final var` for local variable |
| 24 | +declarations, which can be enabled in `File | Settings | Editor | General | Code Folding | Java Code Aligner`. |
23 | 25 | <!-- Plugin description end --> |
24 | 26 |
|
25 | 27 | ## Installation |
26 | 28 |
|
27 | 29 | - Using IDE built-in plugin system: |
28 | | - |
29 | | - <kbd>Settings/Preferences</kbd> > <kbd>Plugins</kbd> > <kbd>Marketplace</kbd> > <kbd>Search for "intellij-java-code-aligner"</kbd> > |
| 30 | + |
| 31 | + <kbd>Settings/Preferences</kbd> > <kbd>Plugins</kbd> > <kbd>Marketplace</kbd> > <kbd>Search for " |
| 32 | + intellij-java-code-aligner"</kbd> > |
30 | 33 | <kbd>Install Plugin</kbd> |
31 | | - |
| 34 | + |
32 | 35 | - Manually: |
33 | 36 |
|
34 | 37 | Download the [latest release](https://github.com/bash-spbu/intellij-java-code-aligner/releases/latest) and install it manually using |
|
0 commit comments