Ruby Rake 命令行使用完全指南

Ruby Rake 命令行使用完全指南

rake A make-like build utility for Ruby. 项目地址: https://gitcode.com/gh_mirrors/ra/rake

什么是 Rake

Rake 是 Ruby 的构建工具，类似于 Unix 中的 make 工具。它允许开发者定义任务(task)和依赖关系，并通过简单的命令行界面执行这些任务。Rake 使用 Ruby 语法定义任务，因此比传统的 make 工具更灵活强大。

基本命令格式

Rake 的基本调用格式如下：

rake [选项...] [变量=值...] [目标...]

其中：

• 选项：控制 Rake 行为的各种参数
• 变量=值：设置环境变量，可在 Rakefile 中通过 ENV['变量名'] 访问
• 目标：要执行的任务名称

常用选项详解

任务查看相关

1. 列出任务 (-T 或 --tasks)

   rake -T
   

   显示所有主要任务及其描述。可以配合模式(pattern)使用：

   rake -T test
   

   只显示名称中包含"test"的任务。

2. 显示任务详情 (-D 或 --describe)

   rake -D
   

   显示任务及其完整描述。同样支持模式匹配。

3. 显示任务定义位置 (-W 或 --where)

   rake -W
   

   显示任务定义的文件和行号信息。

执行控制相关

1. 模拟执行 (-n 或 --dry-run)

   rake -n
   

   显示将要执行的任务但不实际执行，用于测试任务依赖关系。

2. 并发执行 (-j 或 --jobs)

   rake -j 4
   

   指定最大并发线程数，特别适用于多任务(multitask)执行。

3. 全局模式 (-g 或 --system)

   rake -g
   

   使用系统全局的 Rakefile 而非项目本地文件。

调试相关

1. 跟踪执行 (-t 或 --trace)

   rake -t
   

   开启完整的执行跟踪，包括任务调用和执行过程。

2. 显示调用栈 (-n 或 --backtrace)

   rake -n
   

   只显示错误调用栈而不显示任务执行细节。

3. 过滤调用栈 (--suppress-backtrace)

   rake --suppress-backtrace 'pattern'
   

   从调用栈中过滤掉匹配指定模式的行。

其他实用选项

1. 静默模式 (-s 或 --silent)

   rake -s
   

   不显示任何非必要输出。

2. 版本信息 (-V 或 --version)

   rake -V
   

   显示 Rake 版本信息。

3. 帮助信息 (-H 或 --help)

   rake -H
   

   显示帮助文档。

环境变量设置

1. 命令行设置

   rake VAR=value
   

   可以在 Rakefile 中通过 ENV['VAR'] 访问。

2. RAKEOPT 环境变量

   export RAKEOPT="-s --trace"
   

   设置默认 Rake 选项，这些选项会在每次执行时自动应用。

实用技巧

1. 组合使用选项

   rake -T -A
   

   显示所有任务，包括没有描述的任务。

2. 并发执行优化

   rake -j $(nproc)
   

   根据 CPU 核心数设置最佳并发数。

3. 快速执行 Ruby 代码

   rake -e 'puts "Hello Rake"'
   

   不加载 Rakefile 直接执行 Ruby 代码。

总结

Rake 提供了丰富的命令行选项，可以满足从简单任务执行到复杂构建流程的各种需求。掌握这些选项能够显著提高 Ruby 项目的构建效率。建议新手从 -T 和 -D 选项开始，逐步熟悉任务结构，再根据需要学习其他高级选项。

rake A make-like build utility for Ruby. 项目地址: https://gitcode.com/gh_mirrors/ra/rake