Support Center & Knowledge base

Setup

To use the TypeScript Build Pipeline, all you have to do is to add this dependency in your devDependencies in your root package.json:

"devDependencies": {
    "@dolittle/typescript.build": "^5.0.0"
}

We have examples for how to set up a typescript project with both a project with a single package and multiple projects using Yarn Workspaces that basically has all the files and configurations you’d need to get it working. So copying all this from the folder with the strategy you want to use when starting a new project is a good start.

Having Yarn globally installed is a pre-requisite to fully utilize this build pipeline solution.

npm i -g yarn

It is required to have a tsconfig.json and package.json in every package.

All the source files must be sitting in a folder called ‘Source’. Follow the structure given in the examples

We recommend to have similar configurations (package.json, tsconfig.json) as the one provided under the examples of the project structure you want to use. The you’re also free to override ‘compilerOptions’ settings yourself if you wish to, for example if you need to target a specific version of EcmaScript or need to allow javascript files.