RAKE-COMPILER(1)

💖 RAKE-COMPILER 💖

okay bestie, gather round, because we're talking about rake-compiler, the Rake-based Ruby Extension (C, Java) task generator ✨ — and no, it's not a compiler for rake, it's a whole vibe for building native gems. Let's go 🫶

🌸 NAME 🌸

rake-compiler — a Rake-based Ruby Extension (C, Java) task generator. that's the whole thing. iconic. 💅

✨ DESCRIPTION ✨

okay so first things first: Rake-compiler is first and foremost a productivity tool for Ruby developers 🔥 its whole goal is to make the busy developer's life easier by simplifying the building and packaging of Ruby extensions — by simplifying code and reducing duplication. less copy-paste suffering, more slay.

it follows convention over configuration by advocating a standardized build and package structure for both C and Java based RubyGems. no cap. one structure, everybody knows where things go, we all thrive 🌈

and ngl, rake-compiler is the result of many hard-won experiences dealing with several diverse RubyGems that provided native extensions for different platforms and different user configurations in different ways 😭 like, details such as differences in code portability, differences in code clarity, and differences in project directory structure often made it very difficult for newcomers to those RubyGems. so this tool exists so that new people can actually walk in the door without getting lost. bestie behavior fr fr 💖

🎀 USAGE 🎀

the shape of it, exactly as it is:

rake-compiler [-f rakefile] {options} targets...

that's the whole recipe. options in, targets out. ✨

👑 OPTIONS 👑

here's every single flag, no skips, no shortcuts, we keep all of them because that's the rules 💅

• --backtrace=[OUT] — turn on the full backtrace. OUT can be stderr (which is the default) or stdout. pick your channel bestie 🦋
• --comments — show commented tasks only. only the ones with commentary ✨
• --job-stats [LEVEL] — display job statistics. LEVEL=history displays a complete job list 📊
• --rules — trace the rules resolution. watch the rules do their thing 🔍
• --suppress-backtrace PATTERN — suppress backtrace lines matching the regexp PATTERN. ignored if --trace is on. so don't be surprised when it does nothing while tracing, that's just how it is 🙈
• -A, --all — show all tasks, even uncommented ones (in combination with -T or -D) 👀
• -B, --build-all — build all prerequisites, including those which are up-to-date. yes, even the fresh ones. rebuild everything, no fear 🔥
• -D, --describe [PATTERN] — describe the tasks (matching the optional PATTERN), then exit. 💬
• -e, --execute CODE — execute some Ruby code and exit. hit it and quit it ✨
• -E, --execute-continue CODE — execute some Ruby code, then continue with normal task processing. code first, then business as usual 🫶
• -f, --rakefile [FILENAME] — use FILENAME as the rakefile to search for. 📄
• -G, --no-system, --nosystem — use standard project Rakefile search paths, ignore system wide rakefiles. bye system files 👋
• -g, --system — using system wide (global) rakefiles (usually ~/.rake/*.rake). 🌍
• -I, --libdir LIBDIR — include LIBDIR in the search path for required modules. 🧭
• -j, --jobs [NUMBER] — specifies the maximum number of tasks to execute in parallel. (default is number of CPU cores + 4) — parallel queen energy 👑
• -m, --multitask — treat all tasks as multitasks. everything's a multitask now, we don't discriminate 💅
• -n, --dry-run — do a dry run without executing actions. look, don't touch 🙈
• -N, --no-search, --nosearch — do not search parent directories for the Rakefile. stay in your lane, parents 🚫
• -P, --prereqs — display the tasks and dependencies, then exit. 📋
• -p, --execute-print CODE — execute some Ruby code, print the result, then exit. 🖨️
• -q, --quiet — do not log messages to standard output. shhh 🤫
• -r, --require MODULE — require MODULE before executing rakefile. 📦
• -R, --rakelibdir RAKELIBDIR, — auto-import any .rake files in RAKELIBDIR. (default is 'rakelib') 🗂️
• --rakelib — 🎀
• -s, --silent — like --quiet, but also suppresses the 'in directory' announcement. extra quiet. silent but deadly 😌
• -t, --trace=[OUT] — turn on invoke/execute tracing, enable full backtrace. OUT can be stderr (the default) or stdout. 🕵️
• -T, --tasks [PATTERN] — display the tasks (matching the optional PATTERN) with descriptions, then exit. -AT combination displays all of tasks contained no description. 🔍
• -v, --verbose — log message to standard output. tell me everything 🗣️
• -V, --version — display the program version. 📌
• -W, --where [PATTERN] — describe the tasks (matching the optional PATTERN), then exit. 📍
• -X, --no-deprecation-warnings — disable the deprecation warnings. we're ignoring the past, don't perceive it 💀
• -h, -H, --help — display this help message. hi bestie, here's the menu 🫶

💜 AUTHOR 💜

this manual page was written by Youhei SASAKI <uwabami@gfd-dennou.org>, for the Debian GNU/Linux system (but may be used by others). shoutout to the author, absolute legend, main character energy 👑

and that's the whole page bestie, you made it to the end, i'm so proud 😭

rake-compiler 1.0.5 · September 2018 — that's the version and date, and that's a wrap. go build something native and gorgeous, you've got this 🦋💖✨