Giter Club home page Giter Club logo

capt's Introduction

capt

Download Build Status codebeat badge

Capt is short for Class Annotation Processor Tool on Android.

Like apt, capt provide some mechanism to parse annotations at compile time.

But capt can do more stuff than apt, because capt visit every class that will packing into APK, and apt only visit java sources.

Further more, capt also provides the chance to update every original class.

For more information please see the wiki.

Hope you enjoy it!

Getting Started

Add capt plugin to gradle script classpath:
classpath 'coffeepartner.capt:plugin:1.0.0-RC2'
// Take care, 1.0.0-RC2 is incompatible with Android Gradle Plugin 3.3.0 because of the Guava API's break change,
// 1.0.0 will fix it by using Gradle API instead.
Apply capt plugin on Android application or library module:
apply plugin: 'com.android.application' 
// or apply plugin: 'com.android.library'
apply plugin: 'capt'
Add plugins for capt
dependencies {
    capt 'xxx:xxx:x.y.z'
    capt files('xxx')
    capt project(":xxx") // java library and android library both supported
    debugCapt 'xxx'
    androidTestCapt 'xxx'
}

capt {
    plugins {
        pluginOfCapt {
            // arguments for pluginOfCapt
        }
    }
}

Documentation

  • User guide: This guide contains examples on how to use capt in your gradle script.
  • Writing Capt Plugins: This guide introduce how to develop a plugin of capt.
  • Design document: This document discusses issues we faced while designing capt.

Releases Plan

    • 03/01/2019: Release Candidate 1: stabilized API and feature set
    • 17/01/2019: Release Candidate 2: addressing feedback from RC 1
    • 31/01/2019: Stable Release: General availability

License

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

capt's People

Contributors

dieyidezui avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.