Confy is a buildsystem for compiling code with ZigCC.
Inspired by SCons, without the issues of a typeless language.
You can expect:
- Ergonomic, readable and minimal/simple syntax.
- Behaves like a library. Build your own binary that compiles your app.
- Imperative, not declarative. You own the control flow.
- Sane project and configuration defaults.
- Auto-downloads the latest compiler for the host.
- Cross-compilation as a first class citizen, not an afterthought.
Minimal build file:
import confy
Program.new("hello.c").build.runTODO:
Full how-to guide @doc/howto
See the examples folder in the meantime
Warning for Nim:
The compiler is set in the strictest mode possible by default.
Your code might not compile because of these flags.
You can deactivate or modify this behavior by changing theConfig().nim.unsafeoptions
See the Configuration section below for more details.
import confy
cfg.dirs.src = "./code" # Changes the source code folder from its default `dirs.root/"src"`.
cfg.dirs.bin = "./build" # Changes the binaries output folder from its default `dirs.root/"bin"`.
cfg.verbose = on # Makes the cli output information completely verbose. (for debugging)
cfg.quiet = on # Makes the cli output information to be as minimal as possible. (for cleaner cli output) (default: on)
# Note: verbose = on will ignore quiet being active. (default: off) Every build Target has its own separate configuration options, decided when first creating that target.
When omitted, Confy uses a global configuration variable that you can modify.
To change its values, add cfg.theVariable = value anywhere in your build.nim file.
You can also create your own confy.Config() object and pass it as the cfg = ... argument to each confy.Target you create.
Confy does this automatically, but it uses the global config state/variable for ergonomics when omitted.
In practice, this means that if you pass your own Config object to a target,
confy will ignore the global variable and only use your config instead.
You can find the complete list of default options at @confy/types/config.nim
All the comptime configuration variables are stored @confy/cfg.nim.
Without changing anything else, you can override these options by compiling your builder with a different value.
For example, this will compile and run your builder, and change the default to use system/PATH binaries for everything
nim c -r -d:confy.all_systemBin=off build.nimSummary of: doc/design.md
Please read the @how to doc before reading this section:
When most people think of a build tool, they think of declarativeness.
This is not what Confy is.
Confy is completely imperative.
This is by design.
What you tell Confy to do, it will do immediately.
The core idea driving Confy is to let you fully own your buildsystem.
Its your project, and only you can know what your project/tooling needs,
and in which exact order.
Confy is a buildsystem library.
The premade caller provides you with an easy way to run it as if it was a binary,
but confy is, by design, not a binary app.
Your build file (not confy, big difference) will be a full systems binary application,
that you compile with nim's compiler (or automated with confy's premade caller) to build your project.
ZigCC comes with all of these features builtin, out of the box. No extra setup:
- Automatic Caching
- Cross-platform Cross-compilation (from any system to any system, not just some to some)
- Auto-dependency resolution
- Preconfigured Sanitization
- Sane and Modern optimization defaults
- Pre-packed libc
... and all of that fits in a self-contained 50mb download.... !!
Compare that to setting up gcc/mingw/msys/msvc/clang/osxcross ... etc, etc, etc
There is a clear winner here.