This page contains internal documentation for development.

You can use the generate-classes.sh to generate ViewControllers and other classes to emulate a large project. This is useful, for example, to test the performance of swizzling in a large project without having to check in thousands of lines of code.

The diagrams are created with PlantUml. The advantage of PlantUml over other diagram tools is that you describe the diagrams with text, and you don't have to worry about UML and layout, which can be time-consuming for changes. Furthermore, the diagrams can be stored in git.

With Visual Studio Code and the PlantUml Plugin you can create diagrams, view them and export them. If you don't want to use Visual Studio Code, there are many alternatives.

For learning the syntax and quickly playing around you can check out Plant Text.

Visual Studio Code needs a rendering engine for PlantUml. We recommend using the following Docker image:

docker run -d -p 8080:8080 plantuml/plantuml-server:jetty

To ensure the rendering server is running properly, visit with localhost:8080.

Finally, you have to configure the rendering server in Visual Studio Code. For this, open the settings of Visual Studio Code. Choose Extensions > PlantUML configuration. Click on Edit in settings.json. Then paste the following into the config:

{
  "plantuml.server": "http://localhost:8080",
  "plantuml.render": "PlantUMLServer"
}

Save the settings and you should be able to render a diagram.

You can find the official guide here: configure a rendering server.