Verace.js

An assorted collection of tools

Compontents

Build Tool /bt

• Compatable with typescript and go
• Produces a self-contained executable from typescript
• Asset embedding
• Typescript API
• Dynamic build hooks (e.g. build time)

Running

$ npx verace -p verace.js

See the [ build tool docs ] for more.

Threading Pools /tp

• Easy multithreading from a worker

Running

$ npx tp -p verace.js

See the threading pools docs for more.

Hacking

Prerequisites

The following local dependencies are needed in $PATH

• NodeJS >= 16
• Go >= 1.18
• VHS >= 0.3

Installing package dependencies

1. Install npm dependencies for all subprojects:

$ npm run dep

Building

All projects are built with verace. Each one's configuration allows a unified build command:

$ verace build-exe

Contributing

PR Checklist

Note you must have the latest verace build accessible in your $PATH. E.g. by running

$ cp bt/bin/verace ~/.local/bin

1. Code styling

$ npm run lint

2. Testing

$ npm run test

3. VHS Gifs

$ npm run vhs

4. API Reference

$ npm run doc

Or run

$ npm run predep

for all of them at once.