hackit-quickstart

hackit-quickstart

A gradle project generator written in go. Generates gradle projects that use episode6's hackit open source tools.

Why

I wanted a faster way to create new libraries and apps using the episode6/hackit toolkit. I also wanted to learn go.

Usage

Install with

# You'll also need a relatively modern version of gradle to run the initial wrapper task
go get -u github.com/episode6/hackit-quickstart

First, ensure you cd to a git repo with a remote named origin (url is used to pre-populate some of deployable's properties)

git clone git@github.com:<myusername>/<mynewproject>.git
cd <mynewproject>

# OR

mkdir <mynewproject>
cd <mynewproject>
git init
git remote add origin git@github.com:<myusername>/<mynewproject>.git

Then execute the hackit-quickstart command (if you exclude any required flags you'll be asked for them)

Usage of hackit-quickstart:

-config string
    path to config file (default "~/.hackit-quickstart")
-v	Display hackit-quickstart version

-type string
    Type of project to create. Valid values are
      single: A single-module project
      multi: A multi-module project with a single sub-module to start
      sub: A new submodule in an existing multi-module project
-lang string
    Language of project to create. Valid values are
      java: A deployable java library
      groovy: A deployable groovy library
      gradle: A deployable groovy library with the gradle api and an empty gradle plugin.
      android: A deployable android library
      androidApp: An android application
      androidAppDagger: An android application with a default dagger 2 implementation

-group string
    GroupId (aka package name) of library to generate
-name string
    The name of the new module to generate (for a multi-module project, this will be the sub-modules name)
-version string
    Initial version name to use (default "0.0.1-SNAPSHOT")
-licenseName string
    The name of the license you want to use (for deployable libraries) (default "The MIT License (MIT)")

-gdmc string
    Url of a shared gdmc repo to add as a sub-module
-noGdmcRepo
    Dont use a gdmc repo, equivilent to gdmc=""    

-androidBuildToolsVersion string
    For android apps/libs, the value of buildToolsVersion (default "\"26.0.0\"")
-androidCompileSdkVersion string
    For android apps/libs, the value of compileSdkVersion (default "25")
-androidNdkDir string
    Android ndk directory (default "$ANDROID_HOME/ndk-bundle")
-androidSdkDir string
    Android sdk directory (default "$ANDROID_HOME")

hackit-quickstart can be configured via a file or environment variables. By default the app checks for a file at ~/.hackit-quickstart, but that can be overridden using the -config flag. For episode6 projects, I use the following config...

# hackit-quickstart default config

gdmc git@github.com:episode6/hackit-gdmc.git
androidCompileSdkVersion gdmcVersion('android.compilesdk') as Integer
androidBuildToolsVersion gdmcVersion('android.buildtools')

Generated Projects

Generated projects include some or all of the following classpath dependencies by default...

• gradle wrapper v3.3 - All projects
• gdmc - All projects - dependency manager
• deployable - All projects except androidApp - simplified publishing to mavenCentral
• android gradle build tools - android and androidApp

License

MIT: https://github.com/episode6/hackit-quickstart/blob/master/LICENSE