https://github.com/gradle/tooling-commons

A small layer on top of the Gradle Tooling API that provides the Tooling Client and other convenience useful for IDE integration.
https://github.com/gradle/tooling-commons

Last synced: about 1 month ago
JSON representation

A small layer on top of the Gradle Tooling API that provides the Tooling Client and other convenience useful for IDE integration.

• Host: GitHub
• URL: https://github.com/gradle/tooling-commons
• Owner: gradle
• License: other
• Archived: true
• Created: 2015-03-15T00:58:25.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2018-10-03T07:58:29.000Z (about 6 years ago)
• Last Synced: 2024-09-22T19:04:24.613Z (about 2 months ago)
• Language: Java
• Homepage:
• Size: 1.79 MB
• Stars: 9
• Watchers: 53
• Forks: 14
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
Tooling Commons

===============

# Overview

Tooling Commons is a set of libraries to facilitate building tools on top of [Gradle](http://www.gradle.org). Its development is driven by the requirements that come

out of the _Buildship_ project.

# Applying

Include the Gradle releases repository:

    maven {

        name 'gradle-releases'

        url 'https://repo.gradle.org/gradle/libs-releases'

    }

Include the Tooling Commons dependencies:

    dependencies {

        compile 'com.gradleware.tooling:toolingmodel:'

        compile 'com.gradleware.tooling:toolingclient:'

        compile 'com.gradleware.tooling:toolingutils:'

    }

Including the `toolingmodel` dependency will include the `toolingclient` and `toolingutils` dependencies transitively.

# Building

Naturally, the Tooling Commons libraries are built with Gradle. Gradle provides an innovative [wrapper](http://gradle.org/docs/current/userguide/gradle_wrapper.html) that allows

you to work with a Gradle build without having to manually install Gradle. The wrapper is a batch script on Windows and a shell script on other operating systems.

You should use the wrapper to build the Tooling Commons libraries. Generally, you should use the wrapper for any wrapper-enabled project because it guarantees building with the

Gradle version that the build was intended to use.

To build the entire project including running all tests, run the following in the root of the checkout.

    ./gradlew build

To build the entire project including running all cross-version tests, run the following in the root of the checkout.

    ./gradlew build -Pcom.gradleware.tooling.integtest.versions=all

# Continuous Integration

The Tooling Commons libraries are continuously built on our [Continuous Integration Server](https://builds.gradle.org/project.html?projectId=Tooling_Commons&tab=projectOverview).

# Compatibility

The Tooling Commons libraries are in an early stage of maturity in terms of their public API. Currently, we do not make

any commitments to providing backward-compatibility. We do strive to keep the APIs as stable as possible, though.

# Support

Ath this point in time, we do not provide official support for the Tooling Commons libraries.

# Feedback and Contributions

Both feedback and contributions are very welcome.

# License

This plugin is available under the [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0.html).

Copyright 2015 the original author or authors.