Ошибка контрольного стиля с LineLength и JavadocMethod - PullRequest
Новая
       32

Ошибка контрольного стиля с LineLength и JavadocMethod

1 голос
/ 27 января 2020

Вчера я обновил оболочку Gradle (до версии 6.1) в личном проекте ( lifx-client ). В этом проекте я использую Checkstyle для проверки некоторых правил в коде. После выполнения задачи обновления :checkstyleMain возникает следующая ошибка: 

$ ./gradlew checkstyleMain
> Task :checkstyleMain FAILED

FAILURE: Build failed with an exception.

* What went wrong:
Execution failed for task ':checkstyleMain'.
> Unable to create Root Module: config {/Users/me/Projects/Miscellanea/
  lifx-client/config/checkstyle/checkstyle.xml}, classpath { ...

После выполнения некоторых тестов с файлом конфигурации Checkstyle (его можно увидеть в checkstyle. xml), Я обнаружил, что ошибка исчезает, если я закомментирую модули: 

    <module name="LineLength">
      <property name="max" value="120"/>
      <property name="ignorePattern" value="^package.*|^import.*|a href|href|http://|https://|ftp://"/>
    </module>

и 

    <module name="JavadocMethod">
      <property name="scope" value="public"/>
      <property name="allowMissingJavadoc" value="true"/>
      <property name="allowMissingParamTags" value="true"/>
      <property name="allowMissingThrowsTags" value="true"/>
      <property name="allowMissingReturnTag" value="true"/>
      <property name="minLineCount" value="2"/>
      <property name="allowedAnnotations" value="Override,Test,Before,Given,When,Then,And"/>
      <property name="allowThrowsTagsForSubclasses" value="true"/>
      <property name="tokens" value="METHOD_DEF"/>
    </module>

Любые подсказки о проблеме и / или как ее исправить?

Спасибо заранее.

1 Ответ

1 голос
/ 27 января 2020

Вам необходимо найти точное сообщение об ошибке библиотеки checkstyle от вашего плагина checkstyle.

Скорее всего, вы столкнулись с известными критическими изменениями совместимости в библиотеке checkyle. Пожалуйста, просмотрите https://checkstyle.org/releasenotes.html для поиска "JavadocMethod" и "LineLength", откройте связанные проблемы Guthub, и вы увидите "Замечание по миграции", которое объясняет, как обновить конфигурацию для решения проблемы.

...