A Gradle plugin to easily integrate Walkmod on your projects
Groovy Java
Switch branches/tags
Nothing to show
Clone or download
Pull request Compare This branch is 12 commits ahead, 1 commit behind abelsromero:master.
Latest commit ea49e5a Apr 1, 2018

README.adoc

Walkmod Gradle Plugin

Build Status Coverage Status Semantic Versioning

The Walkmod Gradle Plugin is the first tool to provide Walkmod integration with Gradle. This plugin adds two new tasks to allow checking and applying walkmod changes to your projects.

Warning
this is a preliminary version and still some work must be done.

Installation

As long as this is a preliminary version, no fixed repository exists. If you wish to test the tool, you’ll need to install it locally from sources. A install task is provided to simplify the installation in maven local. Use the following snippet inside a Gradle build file:

build.gradle
buildscript {
    repositories {
       mavenCentral()
       jcenter()
    }

    dependencies {
        classpath 'org.walkmod:gradle-walkmod-plugin:0.0.1'
    }

    walkmod {
      chains = ['pmd']
    }
}

apply plugin: 'walkmod'

Usage

The plugin adds a three new tasks:

  1. walkmodCheck: checks for possible changes. Same as using walkmod check in the command tool.

  2. walkmodApply: applies changes. Same as using walkmod apply in the command tool.

  3. walkmodPatch: generates a patch. Same as using walkmod patch in the command tool.

Properties

Each tasks provides the following properties for its configuration:

chains

chain names to check or apply. Type: List<String>. Default: empty (all chains).

offline

true to resolve dependencies (uses Ivy), false to resolve locally. Type: boolean. Default: false.

verbose

true to show extra information. Type: boolean. Default: false.

showErrors

true to get full details when something goes wrong. Type: boolean. Default: false.

properties

dynamic parameters for the execution. Type: String

Methods

None right now (this may change in the future).

Contributing

In the spirit of free and open software, everyone is encouraged to help improve this project. If you discover errors or omissions in the source code, documentation, please don’t hesitate to submit an issue or open a pull request with a fix. New contributors are always welcome!

Here are some ways you can contribute:

  • by using prerelease (alpha, beta or preview) versions

  • by reporting bugs

  • by suggesting new features

  • by writing or editing documentation

  • by writing specifications

  • by writing code — No patch is too small.

    • fix typos

    • add comments

    • clean up inconsistent whitespace

    • write tests!

  • by refactoring code

  • by fixing {uri-issues}[issues]

  • by reviewing patches