Files in this directory are used by the Algorand code generator when generating code and opening PRs.
Since different repositories have different requirements for code generation, we've outsourced the generation commands to each individual SDK repository through the use of a generation script. This file, named generate.sh and located in the SDK repository's templates directory, should contain every command required to generate code from the model schema. An example generation script is included here.
When run from the Docker container, the generation script will include the following environment variables:
$TEMPLATE– A prebuilttemplatecommand$ALGOD_SPEC— The absolute path of the Algod spec file$INDEXER_SPEC— The absolute path of the indexer spec file
A Docker environment is necessary for installing a repository's dependencies in order to run post-generation scripts and formatters. The Dockerfile is a multi-stage stage build with the following structure:
- Builder - Takes the
algorand-generatorDocker image, builds the template command, and runs whatever commands are found in thetemplates/generate.shscript. The generated code is available afterwards in the/repodirectory. - Formatter — With a different base image than before, this stage is used to install dependencies and format the code before publishing. For example, the JavaScript SDK uses the
nodebase image, installs dependencies, and runs thePrettiercode formatter. Be sure to copy generated code from the previous stage before preparing files for publishing. We encourage repositories to utilize amake formatcommand during this stage to improve consistency across the SDKs. - Publisher — Reusing the image from the builder stage, the publish stage will create a new branch and open a pull request based on whatever code is found in the
/repodirectory. Make sure to copy the prepared code from the last stage.
We've included an example Dockerfile in the examples directory, similar to the one being used by the JavaScript SDK.