generator-android-lib

Scaffold an Android library (.aar) with boilerplate code including CLI tasks that build, test, and deploy with quality gates, CI-services, and dependency management.

Table of contents

• Table of contents
• 1. Features
• 2. Installation
• 3. Usage
  • 3.1. Running tests
  • 3.2. Publishing your library
• 4. Extend this generator
  • 4.1. Debugging
  • 4.2. Options
• 5. Sub-generators
• 6. Contributors
• 7. License

1. Features

generator-android-lib creates a base template to start a new Android library (.aar).

• License selection with many SPDX options
• Gradle build (with support of optional and provided dependencies)
• Maven central compatible artifacts (aar, sources, javadocs)
• Ready for spock tests (documentation)
• Bintray publication (+ jars signing and maven central publishing)
• Travis-CI integration (CI and healthy badge)
• Coveralls integration (code coverage badge)
• Target jdk compatibility check with animal sniffer (you may use newer jdk to build, and keep compatibility with older jdk)
• Code quality checks (checkstyle, pmd, findbugs)
• Release process (like maven release)

2. Installation

$ npm install --global generator-android-lib

3. Usage

⚠️This template generates files in the current directory.

Be sure to change to a new directory first if you don't want to overwrite existing files.

$ yo android-lib

That'll generate a project with all the common tools setup. This includes:

• Android Studio-compatible source code
• Ready-to-run *.
• JUnit, Robolectric, and Jacoco unit test and code coverage (optionally tracked on Coveralls)
• Linters
  • checkstyle for code standards
  • PMD for complexity analysis
  • FindBugs for potential defects
• GitHub repository set-up, including
  • GitHub Issue labels with git-labelmaker
  • github-changelog-generator
• A README.md with Badges
• Travis CI continuous integration (optional)
• An SPDX License
• JCenter binary publication

3.1. Running tests

Once the project is scaffolded, inside the project folder run:

$ ./gradlew test

3.2. Publishing your library

Once your tests are passing (ideally with Travis CI and and Coveralls green runs), you might be ready to publish your code to JCenter. We recommend you using npm version to tag release correctly.

$ # TODO: add version bump command
$ git push --follow-tags
# ATTENTION: There is no turning back here.
$ # TODO: add publish command

4. Extend this generator

First of all, make sure you're comfortable with Yeoman composability feature. Then in your own generator:

varGenerator=require('yeoman-generator');module.exports=classextendsGenerator({default(){this.composeWith(require.resolve('generator-android-lib/generators/app'),{/* provide the options you want */});}});

4.1. Debugging

🐛 Debug generator-android-lib

Running into problems? Read

1. 📖 How to debug Yeoman generators for instructions on debugging with node-inspector and Chrome dev-tools.
2. 📖 Debugging Generators (official documentation).

4.2. Options

Here's a list of our supported options:

• boilerplate (Boolean, default true) include or not the Android Studio directories and files
• linters (Boolean, default true) include or not checkstyle, PMD, and FindBugs
• git (Boolean, default true) include or not the git files (.gitattributes, .gitignore).
• license (Boolean, default true) include or not a LICENSE file.
• travis (Boolean, default true) include or not a .travis.yml file.
• githubAccount (String) Account name for GitHub repo location.
• readme (String) content of the README.md file. Given this option, generator-android-lib will still generate the title (with badges) and the license section.

5. Sub-generators

If you don't need all the features provided by the main generator, you can still use a limited set of features by composing with our sub generators directly.

Remember you can see the options of each sub generators by running yo android-lib:sub --help.

• android-lib:boilerplate
• android-lib:linters
• android-lib:git
• android-lib:security installs the OWASP LAPSE+ Project
• android-lib:readme

6. Contributors

6.1. Authors

• Greg Swindle and
• Mukesh Korat.

6.2. You? Contribute to generator-vz-lib-android

We warmly welcome collaboration with the inclusive Contributor Covenant Code of Conduct.

If you want help us out with defect reports, documentation, development, or testing, please read the CONTRIBUTING document.

6.3. About generator-android-lib

This generator was inspired by:

• cesarferreira/generator-android-library We originally forked this, but soon decided to start over: its dependencies are so outdated, refactoring would essentially be a rewrite. :person_frowning:
• xvik/generator-lib-java Great features, Android's' idiosyncrasies demand different dependencies. 👽
• yeoman/generator-nodegenerator-android-lib basically plagiarizes generator-node. 😜

7. License

Apache 2.0 © Greg Swindle and Mukesh Korat.

---