Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hyperupcall/bake
A Bash-based Make alternative.
https://github.com/hyperupcall/bake
basalt bash make makefile shell
Last synced: 2 months ago
JSON representation
A Bash-based Make alternative.
- Host: GitHub
- URL: https://github.com/hyperupcall/bake
- Owner: hyperupcall
- License: bsd-3-clause
- Created: 2021-10-18T23:54:03.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-01-22T08:18:28.000Z (11 months ago)
- Last Synced: 2024-10-19T05:55:50.678Z (2 months ago)
- Topics: basalt, bash, make, makefile, shell
- Language: Shell
- Homepage: https://hyperupcall.github.io/bake/
- Size: 2.99 MB
- Stars: 25
- Watchers: 4
- Forks: 2
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Bake
A Bash-based Make alternative
## Why?
Make is not meant to be used as a task runner. [Just](https://github.com/casey/just) and [scripts-to-rule-them-all](https://github.com/github/scripts-to-rule-them-all) help, but I wanted a simpler, more portable, and streamlined solution
It's simple: write a `Bakefile.sh` script:
```sh
#!/usr/bin/env bash
task.lint() {
prettier "**/*.{js,css}"
eslint '.'
stylelint "**/*.css"
}
task.deploy() {
yarn build
git commit -m v0.1.0 ... && git tag v0.1.0 ...
gh release ...
}
task.fail() {
printf '%s\n' "$1"
false
}
task.succeed() {
printf '%s\n' 'Success!'
}
```
In the same (or any child) directory:
```txt
$ bake deploy
-> RUNNING TASK 'deploy' =================================
yarn run v1.22.17
...
<- DONE ==================================================
```
When there is a failure...
```txt
$ bake fail 'WOOF'
-> RUNNING TASK 'docs' ===================================
WOOF
<- ERROR =================================================
Error (bake): Your 'Bakefile.sh' did not exit successfully
Stacktrace:
-> Bakefile.sh:235 task.fail()
-> bake:244 __bake_main()
$ echo $?
1
```
Prettified output is sent to standard error, so pipines works
```txt
$ bake succeed 2>/dev/null | cat
Success!
```
If you don't remember the tasks...
```txt
$ bake
Error (bake) No task supplied
Tasks:
-> lint
-> deploy
-> fail
```
To sum it up, _it just works_
## Features
- Generates a `./bake` file, for use in CI, etc.
- Sensible `set`, `shopt`, and `LANG` [defaults](./docs/features.md#sensible-defaults)
- Set variables [à la Make](./docs/features.md#make-esque-variable-setting): `bake CC=clang build`
- Automatically `cd`'s to directory contaning Bakefile
- Pass `-f` to manually specify Bakefile
- Dead-simple, miniscule function API (see [api.md](./docs/api.md) for details)
- Built-in [support](./docs/features.md#watchexec-support) for [watchexec](https://github.com/watchexec/watchexec)
- Includes bundled versions of [bash-term](https://github.com/hyperupcall/bash-term) v0.6.3 and [bash-core](https://github.com/hyperupcall/bash-core) v0.12.0 (HEAD)
## Installation
## Brew
Coming soon...
## Manual
WARNING: Manual is ONLY available on `main` branch and is NOT RELEASE-READY!
```sh
git clone 'https://github.com/hyperupcall/bake' ~/.bake
printf '%s\n' 'PATH="$HOME/.bake/pkg/bin:$PATH"' >> ~/.bashrc
```
## Basalt
Not recommended, as Basalt is still Beta-quality
Use [Basalt](https://github.com/hyperupcall/basalt), a Bash package manager, to install this project globally
```sh
basalt global add hyperupcall/bake
```