Building datafiles

Datafiles are static JSON files that are generated against individual tags defined in your project configuration, which is later consumed by applications using provided SDKs.

Usage#

$ npx eventvisor build

Output#

The output will be in the datafiles directory:

datafiles/
├── eventvisor-tag-web.json
├── eventvisor-tag-mobile.json
└── eventvisor-tag-backend.json

System files#

Next to datafiles, the CLI will also generate a few files that are used internally by Eventvisor.

They are located in .eventvisor directory. If you wish to maintain incremental revision numbers, you are advised to commit them to your Git repository so future builds can increment the revision number from there.

Revision#

By default, Eventvisor will increment the revision number as found in .eventvisor/REVISION file for each build.

Custom revision#

You can optionally customize the revision property's value in generated datafiles by passing the --revision flag:

$ npx eventvisor build --revision 100

Revision from hash#

Each new build will lead to datafile content changes, even if individual tagged datafiles didn't have any specific changes from the definitions, because the revision number will always be incremented.

To avoid this, you can pass the --revision-from-hash flag to use the hash of the datafile content as the revision number:

$ npx eventvisor build --revision-from-hash

This is highly useful for caching purposes.

Printing#

If you wish to only write the contents of a newly generated datafile without actually writing it to the file system, you can pass --json flag:

$ npx eventvisor build --tag=web --json --pretty