baldrick-broth

Build automation tool and task runner

Take your developer workflow to the next level with a custom CLI with relevant documentation for running your task

Highlights:

• Automate tasks such as testing, scaffolding, minification, and compilation of code.
• Reduce the amount of time needed to set up new projects
• YAML configuration with json-schema allowing code assistance in the editor (eg. visual studio code).
• Provide clear documentation for each step of a project build
• Ensure that documentation is always up-to-date and available in the CLI
• Run certain tasks only if certain conditions are met
• Allow developers to define their own model for their project
• Provide an easy way for developers to provide interactive input when running a task

Documentation and links

• Code Maintenance 🔧
• Code Of Conduct
• Api for baldrick-broth
• Contributing 👥 🚧
• Diagram for the code base 📐
• Vocabulary used in the code base 📖
• Architectural Decision Records 📝
• Contributors :busts_in_silhouette:
• Dependencies
• Glossary :book:
• Software engineering principles :gem:
• Overview of Flarebyte.com ecosystem :factory:
• Usage
• Overview for the json schema for broth yaml file
• Json schema for broth yaml file
• Code Analysis
• Agent Notes

Related

• baldrick-zest-engine Run tests declaratively with a few cunning plans

Installation

This package is ESM only.

yarn global add baldrick-broth
baldrick-broth --help

Or alternatively run it:

npx baldrick-broth --help

If you want to tun the latest version from github. Mostly useful for dev:

git clone git@github.com:flarebyte/baldrick-broth.git
yarn global add `pwd`