@andyjessop/bakery v0.0.2

Bakery

Bakery is a monorepo task runner that allows you to efficiently run scripts across multiple packages in your repository. It provides commands to run tasks on all packages or only on affected packages based on changes since a specified commit.

Roadmap

• Run tasks
• Run tasks on affected packages
• Cache task output
• Remote task cache

Installation

bun install @andyjessop/bakery --save-dev

Alternateively, clone this repo as a starter template: https://github.com/andyjessop/bakery-template

And then run bun install in the root directory.

Task Dependencies

In a monorepo, tasks usually depend on other tasks. In order to ensure that they run in the right order, create a bakery.json like this:

{
	"tasks": {
		"build": {
			"dependsOn": ["build", "lint", "test"]
		},
		"lint": {
			"dependsOn": []
		},
		"test": {
			"dependsOn": []
		}
	}
}

Here we have the build task depending on lint, test, and the build tasks of all its dependencies (recursively). This means that when you run bunx bakery run --script=build, Bakery will run lint and test first, and then build.

Project structure

Reference the Bun docs to learn how to set up a monorepo with Bun: Workspace setup.

Usage

To use Bakery, navigate to your monorepo's root directory and run the following commands:

Running a script on all packages

To run a script on all packages in the monorepo, use the run command followed by the --script flag:

bunx bakery run --script=<script-name>

Replace with the name of the script you want to run, such as test or build. For example:

bunx bakery run --script=test
bunx bakery run --script=build

Running a script on affected packages

To run a script only on packages affected by changes since a specific commit, use the affected command followed by the --script flag:

bunx bakery affected --script=<script-name>

Replace with the name of the script you want to run. Bakery will automatically determine which packages have been affected by changes and run the specified script only on those packages. For example:

bunx bakery affected --script=test

Running a script on specific packages

To run a script on specific packages, use the run command with the --script flag and the packages flag followed by a comma-separated list of package names:

bunx bakery run --script=<script-name> packages=<package1>,<package2>,...

Replace with the name of the script you want to run, and ,,... with the names of the packages you want to include. For example:

bunx bakery run --script=test packages=pkg-a,pkg-b

Configuration

Bakery looks for a bakery.json file in the root directory of your monorepo to configure task dependencies. The bakery.json file should have the following structure:

{
  "tasks": {
    "<script-name>": {
      "dependsOn": ["<dependency1>", "<dependency2>", ...]
    }
  }
}

Replace with the name of the script, and , , etc., with the names of the packages that the script depends on.

How it works

Bakery uses a graph-based approach to determine the affected packages and the order in which tasks should be executed. It analyzes the dependencies between packages and builds a task pipeline based on the specified script and the affected packages.

The task runner then executes the tasks in the pipeline, ensuring that dependencies are respected and that tasks are run in parallel when possible.

Requirements

Bun runtime environment.