https://github.com/alejandrogallo/rooki
A stupid simple script runner supporting c, c++, rust, haskell and virtually anything
https://github.com/alejandrogallo/rooki
c clang compiler cpp fortran gcc rust scripting tcc
Last synced: about 1 month ago
JSON representation
A stupid simple script runner supporting c, c++, rust, haskell and virtually anything
- Host: GitHub
- URL: https://github.com/alejandrogallo/rooki
- Owner: alejandrogallo
- License: gpl-3.0
- Created: 2019-08-05T16:10:29.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2020-01-07T13:23:11.000Z (over 5 years ago)
- Last Synced: 2025-03-27T07:35:52.509Z (about 2 months ago)
- Topics: c, clang, compiler, cpp, fortran, gcc, rust, scripting, tcc
- Language: Shell
- Size: 201 KB
- Stars: 27
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# rooki
A stupid simple script runner supporting c, c++, rust, haskell and virtually anything
`Rooki` is written in 20 lines of `bash`, and has a very flexible
functionality.
# How does it work?
You just write comments as `rooki` instructions, the only instruction that
you have to define is the `rooki:spell`, which will be run in the shell.
Otherwise you can define any flag you want with the name you want for instance
in a `c` file, the following
```c
// rooki:someflag -I$(pwd)
// rooki:someflag -I$HOME
```
will define a shell variable `someflag` with the value
```
someflag="-I$(pwd) -I$HOME"
```
which later can be used in the `rooki:spell` section as
```c
// rooki:someflag -I$(pwd)
// rooki:someflag -I$HOME
// rooki:spell cc $someflag $f -o $bin
```
There are some general variables already defined:
| Variable | Explanation | Example |
| --- | --- | :---: |
| `bin` | Path to the created binary | `rooki:spell gcc $f -o $bin` |
| `f` | Path to the temporary source file that will be compiled | `// rooki:spell gcc $f -o $bin` |
| `src` | Path to the source file, the caller | `rooki:include -I$(dirname $src)/include`|
| `config_folder` | Path to rooki config folder ||
What `rooki` does when you do `rooki yourscript` is the following
- Create a temporal file and save the path in the variable `f`.
- Create a `bin` path out of the `md5` hash of the source script, the bin
will be stored in `$XDG_CONFIG_HOME/rooki/`. In the case that your
`XDG_CONFIG_HOME` is not defined, it will be stored in
`~/.config/rooki/`.
- Remove the shbang (`#!/usr/bin/env rooki`) on top of your script (if there is
any) and copy the script to `$f` without the shbang.
- Read the `rooki:` flags stored in text in your script.
- Expand shell constructs within these flags, environment variables and
general shell commands within.
- Run the `rooki:spell` construct, which should be creating a binary
in the path `$bin`.
# Quick start
For instance to write a `c++` script called `hello.cxx`
just create an executable file `hello.cxx` and write
```c++
#!/usr/bin/env rooki
// rooki:flags -pedantic -std=c++11
// rooki:flags -x c++
// rooki:include -I/usr/include
// rooki:include -I$HOME/.local/include
// rooki:spell g++ $flags $include $f -o $bin
#include
int main(int argc, char *argv[])
{
std::cout << "Hello world" << std::endl;
return 0;
}
```
then do
```
./test.cxx
# or
rooki test.cxx
```
if you want to see exactly what rooki is doing then set the environment variable
`ROOKI_DEBUG` like this
```
ROOKI_DEBUG=1 ./test.cxx
```