When making changes, edit the files in src/. Do not directly edit bin/antigen.zsh as that file is generated automatically. Run make to regenerate it.

All the tests are in the tests folder and are run using the [cram][] test system, to install required dependencies use:

sudo make install-deps

Note: You'll need to install dependencies only if you are running without Docker.

With that you can run the tests as:

make tests

By default it will run tests using [Docker][docker] with images from [DockerHub][dockerhub] using zsh version 5.3. You can customize which Docker image it runs against as follows:

make tests CONTAINER_IMAGE=docker-hub/image-name ZSH_VERSION=

Where $CONTAINER_IMAGE is a Docker Hub image name. By default desyncr/zsh-docker-zsh-5.3.

Docker version used is 17.03.1-ce.

You may as well run tests locally without Docker. Use:

make tests USE_CONTAINER=no

If you are making a feature addition, I'd really appreciate if you can add a test for your feature. Even if you can add a test for an existing feature, that would be great as the tests are currently seriously lagging behind the full functionality of Antigen.