gradle-code-quality-tools-plugin_系统开发案例-程序员客栈

gradle-code-quality-tools-plugin

GradlepluginthatconfiguresErrorProne,Checkstyle,PMD,CPD,Lint,Detekt&Ktlint.Allofthesetoolsarealsoautomaticallyhookedintothecheckgradletask.Below,I'llgomoreintodepthhoweachofthosepluginsareconfigured.

ThispluginrequiresGradle5.0orlater.

Setup

root/build.gradle

buildscript{repositories{mavenCentral()google()gradlePluginPortal()//RequiredfortheErrorproneGradlePlugin.}dependencies{classpath"com.vanniktech:gradle-code-quality-tools-plugin:0.20.0"}}applyplugin:"com.vanniktech.code.quality.tools"

Information:ThispluginisalsoavailableonGradleplugins

Snapshotbuildscript{repositories{maven{url"https://oss.sonatype.org/content/repositories/snapshots"}}dependencies{classpath"com.vanniktech:gradle-code-quality-tools-plugin:0.21.0-SNAPSHOT"}}applyplugin:"com.vanniktech.code.quality.tools"Configuration

Thephilosophyofthispluginistofailearly.Thismeanshavingzerowarnings/errorsreportedfromanytools.Ifyou'rejustgettingstartedwiththisinalargecodebaseyoumightnotbeabletoachievethisrightawayinwhichcaseyoumightwanttosetfailEarlytofalseandthenapplyatafinermoregranularscopehoweachtoolshouldbehavee.g.checkstyle{ignoreFailures=false}.

Thosearealltheavailableconfigurations-shownwithdefaultvaluesandtheirtypes.MoreinformationcanbefoundintheKotlinDocumentationoftheExtensionandtherespectiveextensionsfordesignatedintegrations.

codeQualityTools{booleanfailEarly=truebooleanxmlReports=truebooleanhtmlReports=falsebooleantextReports=falseString[]ignoreProjects=[]checkstyle{booleanenabled=trueStringtoolVersion='8.6'StringconfigFile='code_quality_tools/checkstyle.xml'BooleanignoreFailures=nullBooleanshowViolations=nullStringsource='src'List<String>include=['**/*.java']List<String>exclude=['**/gen/**']}pmd{booleanenabled=trueStringtoolVersion='6.0.0'StringruleSetFile='code_quality_tools/pmd.xml'BooleanignoreFailures=nullStringsource='src'List<String>include=['**/*.java']List<String>exclude=['**/gen/**']}lint{booleanenabled=trueBooleantextReport=nullStringtextOutput='stdout'BooleanabortOnError=nullBooleanwarningsAsErrors=nullBooleancheckAllWarnings=nullStringbaselineFileName=nullBooleanabsolutePaths=nullFilelintConfig=nullBooleancheckReleaseBuilds=falseBooleancheckTestSources=nullBooleancheckDependencies=null}ktlint{booleanenabled=trueStringtoolVersion='0.32.0'booleanexperimental=false}detekt{booleanenabled=trueStringtoolVersion='1.0.0'Stringconfig='code_quality_tools/detekt.yml'StringbaselineFileName=nullbooleanfailFast=true}cpd{booleanenabled=trueStringsource='src'Stringlanguage='java'BooleanignoreFailures=nullintminimumTokenCount=50}errorProne{booleanenabled=trueStringtoolVersion='2.1.3'}kotlin{booleanallWarningsAsErrors=true}}Tools

HereI'llgiveabitmoreinformationabouthoweachofthetoolswillbeapplied.Ifthere'saGradletaskthatthispluginwillgenerateitwillalsobehookedupintothecheckGradletask.Thismeansthatwhenyouexecutecheckalloftheroolswillberunningforyou.

ErrorProne

It'llapplytheErrorProneGradlePluginwhichwillruntogetherwithassemble.There'snoreportgeneratedforthisbutyou'llgetcompilewarnings&errors.

Checkstyle

It'llapplytheCheckstylePluginandgeneratethecheckstyletaskthatwillexecutecheckstyle.TheconfigurationpropertiesofcodeQualityTools->checkstylemirrorthepropertiesfromtheplugin.

PMD

It'llapplythePMDPluginandgeneratethepmdtaskthatwillexecutepmd.TheconfigurationpropertiesofcodeQualityTools->pmdmirrorthepropertiesfromtheplugin.

CPD

It'llapplytheCPDPluginandgeneratethecpdChecktaskthatwillexecutecpd.TheconfigurationpropertiesofcodeQualityTools->cpdmirrorthepropertiesfromtheplugin.

Lint

ThiswillonlyworkwhenoneoftheAndroidPlugins(com.android.application,com.android.library,etc.)areapplied.TheconfigurationpropertiesofcodeQualityTools->lintmirrorthepropertiesfromthelintOptions.

Detekt

It'llusethespecifieddetektversionandgeneratethedetektChecktaskwhichwillrundetektonyourcodebase.

Ktlint

It'llusethespecifiedktlintversionandthengeneratetwotasks.ktlintwhichwillrunktlintoveryourcodeandflagissues.ktlintFormatwillreformatyourcode.

Note:TheremightbesomeconfigurationpropertiesthatarenotmirroredinwhichcasefeelfreetoopenaPR.Personally,Idon'thavetheneedforallofthem.

License

LicensedundertheApacheLicense,Version2.0

gradle-code-quality-tools-plugin

作品详情

重点城市程序员兼职推荐

重点岗位程序员兼职推荐