clava-project-template

February 20, 2025 ยท View on GitHub

A template for developing projects for Clava in Typescript

Installing dev environment

Execute the following commands to download all the required code:

npm install

Compiling and executing Clava-based project

First you need to compile the TypeScript files to JavaScript:

npm run build

Then you can execute your project by running the following on your terminal

npm run run

By default it will run the script main.ts. Take a look inside the scripts field in the package.json file for more information.

You can also run tests, get test coverage information and generate documentation for your project.

Debugging

You can get debugging information using a DEBUG environment variable. This variable is used by the debug module to determine what to expose.

DEBUG="*" npm run run