GitHub user vanzin opened a pull request:
https://github.com/apache/spark/pull/6502
[SPARK-3873] [build] Add style checker to enforce import ordering.
The checker tries to follow as closely as possible the guidelines of
the code style document, and makes some decisions where the guide is
not clear. In particular:
- wildcard imports come first when there are other imports in the
same package
- multi-import blocks come before single imports
- lower-case names inside multi-import blocks come before others
In some projects, such as graphx, there seems to be a convention to
separate o.a.s imports from the project's own; to simplify the
checker, I chose not to allow that, which is a strict interpretation
of the code style guide, even though I think it makes sense.
Since the checks are based on syntax only, some edge cases may
generate spurious warnings; for example, when class names start
with a lower case letter (and are thus treated as a package name
by the checker).
The checker is currently only generating warnings, and since there
are many of those, the build output does get a little noisy. The
idea is to fix the code (and the checker, as needed) little by little
instead of having a huge change that touches everywhere.
You can merge this pull request into a Git repository by running:
$ git pull https://github.com/vanzin/spark SPARK-3873
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/spark/pull/6502.patch
To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:
This closes #6502
----
commit b3b87b193c16f2348a1827030a7ac565f84282cd
Author: Marcelo Vanzin <[email protected]>
Date: 2014-10-10T22:01:29Z
[SPARK-3873] [build] Add style checker to enforce import ordering.
The checker tries to follow as closely as possible the guidelines of
the code style document, and makes some decisions where the guide is
not clear. In particular:
- wildcard imports come first when there are other imports in the
same package
- multi-import blocks come before single imports
- lower-case names inside multi-import blocks come before others
In some projects, such as graphx, there seems to be a convention to
separate o.a.s imports from the project's own; to simplify the
checker, I chose not to allow that, which is a strict interpretation
of the code style guide, even though I think it makes sense.
Since the checks are based on syntax only, some edge cases may
generate spurious warnings; for example, when class names start
with a lower case letter (and are thus treated as a package name
by the checker).
The checker is currently only generating warnings, and since there
are many of those, the build output does get a little noisy. The
idea is to fix the code (and the checker, as needed) little by little
instead of having a huge change that touches everywhere.
----
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at [email protected] or file a JIRA ticket
with INFRA.
---
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
