You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@flink.apache.org by se...@apache.org on 2018/05/13 12:19:44 UTC
[3/3] flink git commit: [FLINK-9348] [docs] Scalastyle documentatiom
for IntelliJ IDE setup
[FLINK-9348] [docs] Scalastyle documentatiom for IntelliJ IDE setup
This closes #5999
Project: http://git-wip-us.apache.org/repos/asf/flink/repo
Commit: http://git-wip-us.apache.org/repos/asf/flink/commit/d82fbf45
Tree: http://git-wip-us.apache.org/repos/asf/flink/tree/d82fbf45
Diff: http://git-wip-us.apache.org/repos/asf/flink/diff/d82fbf45
Branch: refs/heads/master
Commit: d82fbf4529146b38d929a3c31a767843fed3d64e
Parents: 10c9f87
Author: Yazdan.JS <y_...@yahoo.com>
Authored: Sat May 12 17:00:54 2018 -0400
Committer: Stephan Ewen <se...@apache.org>
Committed: Sun May 13 13:51:00 2018 +0200
----------------------------------------------------------------------
docs/internals/ide_setup.md | 7 ++++++-
1 file changed, 6 insertions(+), 1 deletion(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/flink/blob/d82fbf45/docs/internals/ide_setup.md
----------------------------------------------------------------------
diff --git a/docs/internals/ide_setup.md b/docs/internals/ide_setup.md
index 340544d..dd72c6b 100644
--- a/docs/internals/ide_setup.md
+++ b/docs/internals/ide_setup.md
@@ -81,7 +81,7 @@ to enable support for Scala projects and files:
files for the IDE to work with but without installing libraries.
8. Build the Project (Build -> Make Project)
-### Checkstyle
+### Checkstyle For Java
IntelliJ supports checkstyle within the IDE using the Checkstyle-IDEA plugin.
1. Install the "Checkstyle-IDEA" plugin from the IntelliJ plugin repository.
@@ -108,10 +108,15 @@ Once the plugin is installed you can directly import `"tools/maven/checkstyle.xm
You can scan an entire module by opening the Checkstyle tools window and
clicking the "Check Module" button. The scan should report no errors.
+### Checkstyle For Scala
+
+Enable scalastyle in Intellij by selecting Settings -> Editor -> Inspections, then searching for "Scala style inspections". Also Place `"tools/maven/scalastyle_config.xml"` in the `"<root>/.idea"` or `"<root>/project"` directory.
+
<span class="label label-info">Note</span> Some modules are not fully covered by checkstyle,
which include `flink-core`, `flink-optimizer`, and `flink-runtime`.
Nevertheless please make sure that code you add/modify in these modules still conforms to the checkstyle rules.
+
## Eclipse
**NOTE:** From our experience, this setup does not work with Flink