Getting Started

Getting Started with Compozitor

Before everything

Compozitor is an API for producing source code generation tools. At least, at this moment, we are not planning to create a set of built-in generators. If you wanna produce this and contribute back to the project, you are more than welcome.

Which kind of problem you wanna solve? What is your use case?

This is the first question you need to answer. Are you bothered with the boilerplate code you need to deal with? You can create a generator. Are you willing to standardize your persistence layer? You can create a generator. Are you willing to generate documentation based on your source code? You can create a generator.

That's the thing: Have a huge and bothered problem do you wanna solve? Use Compozitor to create the generator.

Do have a working solution

Please, do not try to create a generator if you haven't a working solution. It can seem counter-intuitive, but trying to create a generator without having a working solution will take you at least twice the effort on development and testing.

So, what is a working solution in fact? The answer is simple: how the generated source code will look like? A generated source code should "emulate" a source code produced by a human, with a well-defined API, testable, extensible, and so on.

How to know if my use case worths for a generator?

The first valuable information you have is that you are bothered with something. But, to make this feeling more tangible, you can just make a simple calculation. How many hours this generator will save compared with manual production? How fast would be to fix a bug that is spread in infra-structural code?

Compozitor was created to give you a powerful tool for problem-solving. If you need any assistance, please join us on slack.