Formatting support

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 https://github.com/redhat-developer/vscode-java/issues/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: https://github.com/redhat-developer/vscode-java/issues/2846
  • Quick fixes for detected formatting problems
• AST sync issue
  • https://github.com/redhat-developer/vscode-java/issues/1132
  • https://github.com/redhat-developer/vscode-java/issues/2107

P3

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