Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add option to IDEA plugin (and CLI) to format JavaDoc #724 #986

Open
wants to merge 6 commits into
base: develop
Choose a base branch
from

Commits on Jan 21, 2024

  1. Add option to CLI and IDEA plugin to format JavaDoc palantir#724

    * This adds an option to the IDEA plugin (checkbox) to format JavaDoc comments.
      It is disabled by default.
    * As the IDEA plugin (sometimes) uses the bootstrapping formatter service, which in turn
      uses the command line tool, this also add an option `--format-javadoc` to
      the command line tool.
    * To pass the options to the FormatterService loaded via service provider, I added a
      method `withOptions` to the service provided interface, which returns a new (immutable)
      instance with the updated options. Compared with the suggestion from the issue comment
      (palantir#724 (comment)),
      this (a) does not require deprecating methods and (b) the options can be set independently
      of where the formatter is actually used.
    * Since the infrastructure to pass options to the formatter now exists, we could also
      add more options to the code style select configuration in the IDEA plugin, but I'm
      not sure if that makes sense (I want to use Palantir, after all).
    * The issue also mentioned API compatibility. The service provider interface is compatible,
      most other classes and methods are internal. But if somebody more familar with the code
      base could take another look, that would be great.
    * I also added a few tests for the new option.
    awa-xima committed Jan 21, 2024
    Configuration menu
    Copy the full SHA
    29dab8c View commit details
    Browse the repository at this point in the history
  2. Apply spotless

    awa-xima committed Jan 21, 2024
    Configuration menu
    Copy the full SHA
    5fcfec9 View commit details
    Browse the repository at this point in the history
  3. Run spotless again...

    awa-xima committed Jan 21, 2024
    Configuration menu
    Copy the full SHA
    78b8f72 View commit details
    Browse the repository at this point in the history

Commits on Jan 23, 2024

  1. Configuration menu
    Copy the full SHA
    80a8e87 View commit details
    Browse the repository at this point in the history

Commits on Apr 29, 2024

  1. Configuration menu
    Copy the full SHA
    cf17693 View commit details
    Browse the repository at this point in the history
  2. Add changelog entry

    awa-xima committed Apr 29, 2024
    Configuration menu
    Copy the full SHA
    7faa25e View commit details
    Browse the repository at this point in the history