Formatting support

[CsCherrYY]

Typical Problems

• Not easy to use or set up/Don't know how to configure or customize formatting option
• The formatter settings don't take any effect/The formatter result is not as expected
• Indentation problems: indentation should be overridden with formatter profile
• Feature requests: support IntelliJ scheme, support google-java-format, support integrating checkstyle etc.

Work Items

P1

• Introduce VS Code style formatter scheme
  • Introduce new VS Code configuration: java.format.settings
    • Deprecate existing java.format.settings.url and java.format.settings.profile
    • Accepts different formatter schemes (engines)
    • Keep compatibility with current custom profile path
    • Can configure some popular formatter rules
      • A subset of eclipse formatter settings, consist of The settings mentioned in existing Github issues
    • Relationship with VS Code indentation settings: Override?
  • Migrate "VS Code formatter settings preview" to vscode-java
    • The description of the configuration java.format.settings should contain a markdown command to the preview UI
• Other features should respect correct formatter options (especially indentation & tab/space)
  • Code Action/refactoring/quickfix
  • Paste handler

P2

• New capabilities
  • Transformed from IntelliJ formatter settings Provide formatter for IntelliJ default format setting redhat-developer/vscode-java#998
  • Cooperate/integration with "Clean-up"
    • Some features in formatter from IntelliJ side can be found in "Clean-up" from eclipse side, e.g., add braces in if statement: Auto add brackets to if/else/while/do when format code redhat-developer/vscode-java#2846
  • Quick fixes for detected formatting problems
• AST sync issue
  • Formatter changes/deletes my code redhat-developer/vscode-java#1132
  • Bug: Formatter causing some lines get erased redhat-developer/vscode-java#2107

P3

• New capabilities
  • Checkstyle support
  • Google-java-format support
• Persistence: export VS Code formatter settings into other IDE’s scheme

[nickzhums]

Thanks for opening this, very comprehensive summary :)

[wufeiwua]

Any news on this? I'm so expecting the feature.

[nickzhums]

@wufeiwua which one are you referring to?

[wufeiwua]

@wufeiwua which one are you referring to?

Formatter for IntelliJ default style. I tried exporting the configuration file for IDEA, and it was configured in vscode (https://code.visualstudio.com/docs/java/java-linting). But there are still a lot of differences between them.

[nickzhums]

Thanks, let us discuss this