traf 🚀
Avoid unnecessary builds, tests, lint and more in your monorepo CI. Optimize your development process by intelligently finding affected dependencies and selectively triggering builds and tests only when needed.
Monorepo support
This lib is designed to work with any monorepo, supported by the following packages:
- nx -
@traf/nx
If you want to add support for another monorepo tool, please open an issue.
@traf/core
A library that finds affected projects in a monorepo, based on the changed lines in the current branch.
Installation
npm install @traf/coreUsage
import { trueAffected } = from '@traf/core';
const affected = await trueAffected({
rootTsConfig: 'tsconfig.base.json',
projects: [
{
name: 'proj1',
sourceRoot: '<project source>',
tsConfig: '<project source>/tsconfig.json',
},
// ...
],
})Options
| Option | Type | Description | Default |
|---|---|---|---|
rootTsConfig |
string |
The path to the root tsconfig file | |
projects |
Project[] |
An array of projects to check | |
cwd |
string |
The current working directory | |
base |
string |
The base branch to compare against | origin/main |
include |
(string | Regexp)[] |
Glob patterns to include (relative to projects' source root) | spec & test files |
rootTsConfig- The path to the root tsconfig file, should include thepathsprop with all projects mapping sots-morphcan find the references.
Project
| Option | Type | Description |
|---|---|---|
name |
string |
The project name |
sourceRoot |
string |
The project source root |
tsConfig |
string |
The project tsconfig file (should only include the project files) |
implicitDependencies |
string[] |
An array of implicit dependencies |
How it works?
The algorithm is based on the following steps:
- Using git to find all changed lines in the current branch.
- Using ts-morph to find the changed element (function, class, const etc..) per line.
- Using ts-morph findReferences to find all references to the changed element recursively.
- For each reference, find the project that contains the reference and add it to the affected projects list.