\n\n# Bakery\n\nBakery 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.\n\n## Roadmap\n\n- [x] Run tasks\n- [ ] Run tasks on affected packages\n- [ ] Cache task output\n- [ ] Remote task cache\n\n## Installation\n\n```bash\nbun install @andyjessop/bakery --save-dev\n```\n\nAlternateively, clone this repo as a starter template: https://github.com/andyjessop/bakery-template\n\nAnd then run `bun install` in the root directory.\n\n### Task Dependencies\n\nIn 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:\n\n```json\n{\n\t\"tasks\": {\n\t\t\"build\": {\n\t\t\t\"dependsOn\": [\"build\", \"lint\", \"test\"]\n\t\t},\n\t\t\"lint\": {\n\t\t\t\"dependsOn\": []\n\t\t},\n\t\t\"test\": {\n\t\t\t\"dependsOn\": []\n\t\t}\n\t}\n}\n```\n\nHere 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`.\n\n### Project structure\n\nReference the Bun docs to learn how to set up a monorepo with Bun: [Workspace setup](https://bun.sh/docs/install/workspaces).\n\n## Usage\n\nTo use Bakery, navigate to your monorepo's root directory and run the following commands:\n\n### Running a script on all packages\n\nTo run a script on all packages in the monorepo, use the run command followed by the --script flag:\n\n```bash\nbunx bakery run --script=\n```\n\nReplace with the name of the script you want to run, such as test or build. For example:\n\n```bash\nbunx bakery run --script=test\nbunx bakery run --script=build\n```\n\n### Running a script on affected packages\n\nTo run a script only on packages affected by changes since a specific commit, use the affected command followed by the --script flag:\n\n```bash\nbunx bakery affected --script=\n```\n\nReplace 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:\n\n```bash\nbunx bakery affected --script=test\n```\n\n### Running a script on specific packages\n\nTo 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:\n\n```bash\nbunx bakery run --script= packages=,,...\n```\n\nReplace with the name of the script you want to run, and ,,... with the names of the packages you want to include. For example:\n\n```bash\nbunx bakery run --script=test packages=pkg-a,pkg-b\n```\n\n## Configuration\n\nBakery 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:\n\n```json\n{\n \"tasks\": {\n \"\": {\n \"dependsOn\": [\"\", \"\", ...]\n }\n }\n}\n```\n\nReplace with the name of the script, and , , etc., with the names of the packages that the script depends on.\n\n## How it works\n\nBakery 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.\n\nThe task runner then executes the tasks in the pipeline, ensuring that dependencies are respected and that tasks are run in parallel when possible.\n\n## Requirements\n\nBun runtime environment.\n","readmeFilename":"README.md"}
![](\"./assets/bakery.png\")