Skip to content

Modules

Ben Fagin edited this page Mar 31, 2015 · 5 revisions

The main Flapi project is broken down into several distinct components.

  • flapi-parent - the parent project for the whole build
  • flapi-descriptor - Flapi's own fluent builder, built using the previous version of the tool
  • flapi-runtime - runtime classes and dependencies for generated builders
  • flapi - the main project and supporting tests (under src/)
  • flapi-build-plugin - Maven plugin for generating builders from descriptors at build-time
  • flapi-build-project - parent POM for projects which generate jars containing builders, using the plugin
  • flapi-build-test-producer - test project which extends from the build-project POM and generates some builders
  • flapi-build-test-consumer - test project which consumes the builders generated by the producer
  • flapi-gradle-plugin - Gradle plugin for generating builders from descriptors at build-time
  • flapi-plugin - common base for build plugins

Layout

Originally there was only one component, under the src/ directory. This now contains the main Flapi module, but the parent project is (inconveniently) located under flapi-parent. Eventually the project structure will be changed to put the Flapi module into its own subdirectory. All other modules are located under their individual folders at the root of the repository.

Clone this wiki locally