<!-- There are some rules that we only want to enable in an IDE. These  -->
<!-- are extracted to a separate file, and merged into the IDE-specific -->
<!-- Checkstyle config by the `:configureIdeCheckstyle` task.           -->

<module name="IdeFragment">

    <!-- See CONTRIBUTING.md for our guidelines on Javadoc -->

    <module name="MissingJavadocMethod">
        <property name="severity" value="warning" />

  tasks.named('idea').configure {
    doFirst { throw new GradleException("Use of the 'idea' task has been deprecated. For details on importing into IntelliJ see CONTRIBUTING.md.") }
  }
}

tasks.register('configureIdeCheckstyle') {
  group = 'ide'
  description = 'Generated a suitable checkstyle config for IDEs'

  String checkstyleConfig = 'build-tools-internal/src/main/resources/checkstyle.xml'

not work by default with the IntelliJ plugin, so instead an IDE-specific config
file is generated automatically after IntelliJ finishes syncing. You can
manually generate the file with `./gradlew configureIdeCheckstyle` in case
it is removed due to a `./gradlew clean` or other action.

IntelliJ should be automatically configured to use the generated rules after