android-check


Source link: https://github.com/noveogroup/android-check

Android Check

Static code analysis plugin for Android project.

Usage

Modifications in <project_dir>/build.gradle:

buildscript {

  repositories {
 jcenter() 
}

  dependencies {

...

classpath 'com.noveogroup.android:check:1.2.5'

...
  
}
 
}

Modifications in <project_dir>/<module_name>/build.gradle:

apply plugin: 'com.noveogroup.android.check'

Configuration

Recommended

Recommended configuration is a default one (empty).

// no configuration

Hardcore

check {

abortOnError true
checkstyle {
 config hard() 
}

findbugs {
 config hard() 
}

pmd {
 config hard() 
}
 
}

Skip checking

check {
 skip true 
}

Skip Checkstyle only

check {
 checkstyle {
 skip true 
}
 
}

Skip FindBugs only

check {
 findbugs {
 skip true 
}
 
}

Skip PMD only

check {
 pmd {
 skip true 
}
 
}

Description

// configuration is optional check {

// skip source code checking or not, false by default
skip true/false
// fails build if code style violation is found, false by default
abortOnError true/false
// configuration of Checkstyle checker
checkstyle {

  // skip Checkstyle, false by default
  skip true/false

// fails build if Checkstyle rule violation is found, false by default
  abortOnError true/false

// configuration file
  config project.file('path/to/checkstyle.xml')
  // configuration resource
  // see http://gradle.org/docs/2.2/release-notes#sharing-configuration-files-across-builds
  config resources.text.fromFile(someTask)
  // configuration path
  config 'path/to/checkstyle.xml'
  // predefined configurations: easy and hard
  config easy()
  config hard()
  // by default plugin finds configuration file in <rootProject>/config/checkstyle.xml,
  // after that in <project>/config/checkstyle.xml and if there are no configuration
  // file, easy() configuration will be used.

// directory for report files
  report new File(project.buildDir, 'reports/pmd')
  // XML report file
  reportXML new File(project.buildDir, 'reports/checkstyle/checkstyle.xml')
  // HTML report file
  reportHTML new File(project.buildDir, 'reports/checkstyle/checkstyle.html')

}

// configuration of FindBugs checker
findbugs {

  // the same configuration as for Checkstyle

// by default plugin finds configuration file in <rootProject>/config/findbugs.xml,
  // after that in <project>/config/findbugs.xml and if there are no configuration
  // file, easy() configuration will be used.

}

// configuration of PMD checker
pmd {

  // the same configuration as for Checkstyle

// by default plugin finds configuration file in <rootProject>/config/pmd.xml,
  // after that in <project>/config/pmd.xml and if there are no configuration
  // file, easy() configuration will be used.

}
 
}

Developed By

License

Copyright (c) 2017 Noveo Group  Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:  The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.  Except as contained in this notice, the name(s) of the above copyright holders shall not be used in advertising or otherwise to promote the sale, use or other dealings in this Software without prior written authorization.  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. 

Resources

JFixture is an open source library based on the popular .NET library, AutoFixture.

JFixture is a Java library to assist in the writing of Unit Tests, particularly when following Test Driven Development. It generates types based on the concept of 'constrained non-determinism', which is an implementation of the Generated Value xUnit test pattern.

Rx wrapper for the Firebase Android library.

Failsafe is a lightweight, zero-dependency library for handling failures. It was designed to be as easy to use as possible, with a concise API for handling everyday use cases and the flexibility to handle everything else.

This project is implementation of ideas from Managing state reactive way article.

"vcard-androidParser" is an android library for developers who wish to get ez-vcard working for android devices or simply it can be used to parse vcf or vcard files in android

A tiny library for implementing endless loading list easily in Android applications, similar to those seen in Facebook or Twitter apps.

Topics


2D Engines   3D Engines   9-Patch   Action Bars   Activities   ADB   Advertisements   Analytics   Animations   ANR   AOP   API   APK   APT   Architecture   Audio   Autocomplete   Background Processing   Backward Compatibility   Badges   Bar Codes   Benchmarking   Bitmaps   Bluetooth   Blur Effects   Bread Crumbs   BRMS   Browser Extensions   Build Systems   Bundles   Buttons   Caching   Camera   Canvas   Cards   Carousels   Changelog   Checkboxes   Cloud Storages   Color Analysis   Color Pickers   Colors   Comet/Push   Compass Sensors   Conferences   Content Providers   Continuous Integration   Crash Reports   Credit Cards   Credits   CSV   Curl/Flip   Data Binding   Data Generators   Data Structures   Database   Database Browsers   Date &   Debugging   Decompilers   Deep Links   Dependency Injections   Design   Design Patterns   Dex   Dialogs   Distributed Computing   Distribution Platforms   Download Managers   Drawables   Emoji   Emulators   EPUB   Equalizers &   Event Buses   Exception Handling   Face Recognition   Feedback &   File System   File/Directory   Fingerprint   Floating Action   Fonts   Forms   Fragments   FRP   FSM   Functional Programming   Gamepads   Games   Geocaching   Gestures   GIF   Glow Pad   Gradle Plugins   Graphics   Grid Views   Highlighting   HTML   HTTP Mocking   Icons   IDE   IDE Plugins   Image Croppers   Image Loaders   Image Pickers   Image Processing   Image Views   Instrumentation   Intents   Job Schedulers   JSON   Keyboard   Kotlin   Layouts   Library Demos   List View   List Views   Localization   Location   Lock Patterns   Logcat   Logging   Mails   Maps   Markdown   Mathematics   Maven Plugins   MBaaS   Media   Menus   Messaging   MIME   Mobile Web   Native Image   Navigation   NDK   Networking   NFC   NoSQL   Number Pickers   OAuth   Object Mocking   OCR Engines   OpenGL   ORM   Other Pickers   Parallax List   Parcelables   Particle Systems   Password Inputs   PDF   Permissions   Physics Engines   Platforms   Plugin Frameworks   Preferences   Progress Indicators   ProGuard   Properties   Protocol Buffer   Pull To   Purchases   Push/Pull   QR Codes   Quick Return   Radio Buttons   Range Bars   Ratings   Recycler Views   Resources   REST   Ripple Effects   RSS   Screenshots   Scripting   Scroll Views   SDK   Search Inputs   Security   Sensors   Services   Showcase Views   Signatures   Sliding Panels   Snackbars   SOAP   Social Networks   Spannable   Spinners   Splash Screens   SSH   Static Analysis   Status Bars   Styling   SVG   System   Tags   Task Managers   TDD &   Template Engines   Testing   Testing Tools   Text Formatting   Text Views   Text Watchers   Text-to   Toasts   Toolkits For   Tools   Tooltips   Trainings   TV   Twitter   Updaters   USB   User Stories   Utils   Validation   Video   View Adapters   View Pagers   Views   Watch Face   Wearable Data   Wearables   Weather   Web Tools   Web Views   WebRTC   WebSockets   Wheel Widgets   Wi-Fi   Widgets   Windows   Wizards   XML   XMPP   YAML   ZIP Codes