From 54960f1088db76074d55ec8a46388d96617cf811 Mon Sep 17 00:00:00 2001 From: "Yazdan.JS" Date: Sat, 12 May 2018 17:00:54 -0400 Subject: [PATCH] [FLINK-9348] scalastyle documentatiom for IntelliJ IDE setup --- docs/internals/ide_setup.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/docs/internals/ide_setup.md b/docs/internals/ide_setup.md index 340544d734670..dd72c6b341ad4 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 `"/.idea"` or `"/project"` directory. + Note 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