Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/redthing1/wox
a highly flexible recipe build system/modern make replacement
https://github.com/redthing1/wox
build build-system d dlang make recipe
Last synced: 5 days ago
JSON representation
a highly flexible recipe build system/modern make replacement
- Host: GitHub
- URL: https://github.com/redthing1/wox
- Owner: redthing1
- Created: 2023-05-17T01:39:04.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-05-18T00:52:55.000Z (over 1 year ago)
- Last Synced: 2024-11-08T08:26:54.964Z (about 2 months ago)
- Topics: build, build-system, d, dlang, make, recipe
- Language: C
- Homepage:
- Size: 269 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-d - wox - A highly flexible recipe build system inspired by Make (Build Tools / Bare metal / kernel development)
README
# wox
**wox** is a highly flexible recipe build system, inspired by [make](https://www.gnu.org/software/make/manual/make.html). wox is also based on learning from other build systems inspired by make such as [knit](https://github.com/zyedidia/knit).
wox is designed to provide all the power and flexibility of arbitrary recipe-based builds, while at the same time addressing make's shortcomings.
## features
+ build scripts are written in [wren](https://wren.io/), and declaratively export a set of recipes
+ recipes with multiple outputs are supported
+ better change detection with virtual targets
+ detect changes in recipe steps when cache is enabled (`-k`)
+ multithreaded recipe building by default
## see a real example
```wren
import "wox" for W, R
var TARGET = "./hello"
var cc = W.cliopt("-cc", "gcc")
var cflags = ["-Wall", "-std=c11"]
var srcs = W.glob("./*.c")
var objs = W.exts_replace(srcs, ".c", ".o")
var src_obj_pairs = W.zip(srcs, objs)
var obj_recipes = src_obj_pairs.map { |x|
return W.recipe(x[1], [x[0]], [x[1]],
[ R.c("%(cc) %(W.join(cflags)) -c %(x[0]) -o %(x[1])") ]
)
}.toList
var main_recipe = W.recipe("main", objs, [TARGET],
[ R.c("%(cc) %(W.join(cflags)) %(W.join(objs)) -o %(TARGET)") ]
)
var clean_recipe = W.virtual_recipe("clean", [],
[ R.c("rm -f %(W.join(objs)) %(TARGET)") ]
)
var all_recipe = W.meta_recipe("all", [main_recipe])
var BUILD_RECIPES = obj_recipes + [main_recipe, clean_recipe, all_recipe]
class Build {
static recipes { BUILD_RECIPES }
static default_recipe { "all" }
}
```
## build
the recommended way to build is with [redbuild](https://github.com/redthing1/redbuild2).
```sh
redbuild build
```
alternatively, build using the D toolchain:
```sh
cd src
dub build -b release
```
## usage
generally, wox can be called similarly to make:
```sh
wox [options] [targets...]
```
additionally, to list targets:
```sh
wox -l
```
to build as a dry run:
```sh
wox -n
```
## faq
### can't find a way to build footprint `somefile.ext:V`
wox expects you to refer to local paths with `./somefile.ext` to be explicit about the fact that they are paths and not virtual recipe names. the `:V` indicates that wox is treating that name as a virtual target, and it should instead infer `:F` for a local file if it begins with `./`.