Skip to content

Conversation

@pugnascotia
Copy link
Contributor

Update the Eclipse formatter settings as follows:

  • Split arguments for methods, constructors etc into separate lines when
    they wrap
  • Enable "joined wrapped lines", which basically means the formatter
    will ignore existing line breaks and join and re-wrap statements. I
    had originally hesitated about enabling this, but without it the
    codebase's style won't be as consistent as it should be, defeating the
    point of all this formatting business.
  • Disable formatting between // tag:: and // end:: comments, which
    are the code snippet markers for the docs. They need a different line
    length, which isn't possible to configure separately.
  • Detect and preserve aligned line comments at the end of consecutive
    lines.
  • And a bunch of other tweaks.

Also update the contribution guidelines.

* Split arguments for methods, constructors etc into separate lines when
  they wrap
* Enable "joined wrapped lines", which basically means the formatter
  will ignore existing line breaks and join and re-wrap statements. I
  had originally hesitated about enabling this, but without it the
  codebase's style won't be as consistent as it should be, defeating the
  point of all this formatting business.
* Disable formatting between `// tag::` and `// end::` comments, which
  are the code snippet markers for the docs. They need a different line
  length, which isn't possible to configure separately.
* Detect and preserve aligned line comments at the end of consecutive
  lines.
* And a bunch of other tweaks.

Also update the contribution guidelines.
@pugnascotia pugnascotia added :Core/Infra/Core Core issues without another label v8.0.0 v7.6.0 labels Oct 24, 2019
@pugnascotia pugnascotia requested a review from rjernst October 24, 2019 09:10
@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-core-infra (:Core/Infra/Core)

Copy link
Contributor

@alpar-t alpar-t left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@pugnascotia pugnascotia merged commit 2d881f1 into elastic:master Oct 29, 2019
@pugnascotia pugnascotia deleted the refine-formatter-settings branch October 29, 2019 09:33
pugnascotia added a commit to pugnascotia/elasticsearch that referenced this pull request Oct 29, 2019
* Split arguments for methods, constructors etc into separate lines when
  they wrap
* Enable "joined wrapped lines", which basically means the formatter
  will ignore existing line breaks and join and re-wrap statements. I
  had originally hesitated about enabling this, but without it the
  codebase's style won't be as consistent as it should be, defeating the
  point of all this formatting business.
* Disable formatting between `// tag::` and `// end::` comments, which
  are the code snippet markers for the docs. They need a different line
  length, which isn't possible to configure separately.
* Detect and preserve aligned line comments at the end of consecutive
  lines.
* And a bunch of other tweaks.

Also update the contribution guidelines.
pugnascotia added a commit that referenced this pull request Oct 29, 2019
Backport of #48446. Update the Eclipse formatter settings as follows:

* Split arguments for methods, constructors etc into separate lines when
  they wrap
* Enable "joined wrapped lines", which basically means the formatter
  will ignore existing line breaks and join and re-wrap statements. I
  had originally hesitated about enabling this, but without it the
  codebase's style won't be as consistent as it should be, defeating the
  point of all this formatting business.
* Disable formatting between `// tag::` and `// end::` comments, which
  are the code snippet markers for the docs. They need a different line
  length, which isn't possible to configure separately.
* Detect and preserve aligned line comments at the end of consecutive
  lines.
* And a bunch of other tweaks.

Also update the contribution guidelines.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants