[УСТАРЕЛО] Плагин Gradle для статического анализа

⚠️ Форк этого проекта поддерживается по адресу https://github.com/GradleUp/static-analysis-plugin/ Пожалуйста, выполните миграцию, используя идентификатор плагина com.gradleup.static-analysis.

Плагин Gradle для простого применения одинаковой конфигурации инструментов статического анализа в различных проектах Android, Java или Kotlin.

Поддерживает Task Configuration Avoidance, поэтому при использовании этого плагина вы не получаете накладных расходов на скорость сборки!

Описание

Gradle поддерживает множество популярных инструментов статического анализа (Checkstyle, PMD, FindBugs и т.д.) с помощью набора встроенных плагинов. Использование этих плагинов в модуле Android потребует дополнительной настройки для компенсации различий между моделью, принятой в плагине Android, и моделью Java.

Плагин gradle-static-analysis-plugin нацелен на предоставление:

гибкой, настраиваемой стратегии штрафов для сборок
простой, удобной для Android интеграции для всех инструментов статического анализа
удобного способа совместного использования одинаковой конфигурации в разных проектах
здоровых, версионируемых и настраиваемых настроек по умолчанию

Поддерживаемые инструменты

Плагин поддерживает различные инструменты статического анализа для проектов на Java, Kotlin и Android:

Checkstyle
PMD
FindBugs [УСТАРЕЛО] [Удалено в Gradle 6.0]
SpotBugs
Detekt
Android Lint
KtLint

Обратите внимание, что доступность инструментов зависит от проекта, к которому применяется плагин. Для получения дополнительных сведений обратитесь к странице supported tools.

Инструменты на рассмотрении

CPD (Обнаружение дублированного кода) #150
error-prone #151
Jetbrains IDEA Inspections #152

По всем рассматриваемым инструментам обращайтесь к issues.

Поддержка проектов Android «из коробки»

Проекты Android используют модель Gradle, несовместимую с моделью Java, поддерживаемой встроенными плагинами инструментов статического анализа. Применение gradle-static-analysis-plugin к вашему проекту Android гарантирует, что все необходимые задачи будут созданы и правильно настроены без каких-либо дополнительных хлопот.

Добавление плагина в проект

Примените плагин из jCenter как зависимость classpath

buildscript {
    repositories {
       jcenter()
    }
    dependencies {
        classpath 'com.novoda:gradle-static-analysis-plugin:1.2'
    }
}

apply plugin: 'com.novoda.static-analysis'

или из Gradle Plugins Repository:

plugins {
    id 'com.novoda.static-analysis' version '1.2'
}

Простое использование

Типичная конфигурация плагина выглядит так:

staticAnalysis {
    penalty {
        maxErrors = 0
        maxWarnings = 0
    }
    checkstyle { }
    pmd { }
    findbugs { }
    spotbugs { }
    detekt { }
    lintOptions { }
}

Это включит все инструменты с их настройками по умолчанию и создаст задачу evaluateViolations. При запуске задачи ./gradlew evaluateViolations будут выполнены все настроенные инструменты, а отчеты будут выведены в консоль. Для более продвинутых конфигураций обратитесь к страницам advanced usage и supported tools.

Пример приложения

Доступны два образца проектов Android: один состоит из обычного приложения — доступен здесь, а другой включает многомодульную настройку, доступную здесь. Оба образца демонстрируют конфигурацию с использованием Checkstyle, FindBugs, SpotBugs, PMD, Lint, Ktlint и Detekt.

Снимки (Snapshots)

Сборочные снимки (snapshot builds) из ветки develop автоматически развертываются в репозитории, который не синхронизирован с JCenter. Чтобы использовать сборочный снимок, добавьте дополнительный репозиторий Maven следующим образом:

repositories {
    maven {
        url 'https://dl.bintray.com/novoda-oss/snapshots/'
    }
}

Последнюю версию снимка можно найти по этой ссылке.

План развития

Этот проект регулярно используется во многих проектах Novoda и в других внешних проектах без известных критических проблем.

Будущие улучшения и интеграции новых инструментов можно найти в трекере задач репозитория.

gradle-static-analysis-plugin

Популярное