Bob 项目技术文档

1. 安装指南

前提条件

Bob 需要至少 PHP 5.3.2 才能运行。如果你计划对 Bob 进行开发，请确保在 php.ini 中将 phar.readonly 设置为 Off。否则，你将无法创建 Bob 的 PHAR 包。

安装方式

推荐方式：使用 Composer 安装

1. 在你的 composer.json 文件中，将 chh/bob 包添加到 require-dev 部分：

   {
       "require-dev": {
           "chh/bob": "1.0.*@dev"
       }
   }
   

2. 运行 composer install --dev 安装 Bob。
3. 你可以通过以下命令调用 Bob：

   php vendor/bin/bob
   

   或者：

   ./vendor/bin/bob
   

系统级安装（仅适用于类 Unix 系统）

1. 下载 Bob 的 [Release][tags] 或通过以下命令克隆仓库：

   git clone git://github.com/CHH/bob.git
   cd Bob
   

2. 下载 Composer 并运行 composer install 安装 Bob 的依赖：

   wget http://getcomposer.org/composer.phar
   php composer.phar install
   

3. 运行 php bin/bob install 完成安装。默认情况下，bob 命令会安装在 /usr/local/bin 目录下。你可以通过设置 PREFIX 环境变量来更改安装路径，命令将安装在 $PREFIX/bin 目录下。

2. 项目使用说明

初始化项目

1. 在你的项目根目录下运行以下命令，生成一个空的 bob_config.php 文件：

   php vendor/bin/bob --init
   

2. Bob 会从项目根目录下的 bob_config.php 文件中加载任务。你还可以在 bob_tasks 目录中添加其他任务文件，Bob 会自动加载这些文件。

定义任务

1. 在 bob_config.php 文件中定义任务。例如，定义一个输出 "Hello World" 的任务：

   task('hello', function() {
       println('Hello World');
   });
   

2. 通过命令行运行任务：

   php vendor/bin/bob hello
   

3. 如果没有指定任务，Bob 会尝试运行 default 任务。你可以通过以下方式将任务设置为默认任务：

   task('default', array('hello'));
   

文件任务

文件任务是一种特殊的任务，只有在目标文件不存在或依赖文件比目标文件更新时才会运行。例如，定义一个将多个文件合并为一个文件的任务：

fileTask('concat.txt', array('file1.txt', 'file2.txt', 'file3.txt'), function($task) {
    println("Concatenating");
    $concat = '';

    foreach ($task->prerequisites as $file) {
        $concat .= file_get_contents($file);
    }

    @file_put_contents($task->name, $concat);
});

任务库

你可以将一组任务打包成任务库，以便在多个项目中复用。任务库需要实现 \Bob\TaskLibraryInterface 接口，并在 register 函数中注册任务。

3. 项目 API 使用文档

任务定义

• task(string $name, callable $body): 定义一个任务。
• fileTask(string $name, array $prerequisites, callable $body): 定义一个文件任务。
• desc(string $description): 为任务添加描述。
• register(TaskLibraryInterface $library): 注册任务库。

任务执行

• 通过命令行运行任务：php vendor/bin/bob <task_name>。
• 查看所有任务及其描述：php vendor/bin/bob --tasks。

4. 项目安装方式

使用 Composer 安装

1. 在 composer.json 中添加 chh/bob 包。
2. 运行 composer install --dev。
3. 通过 php vendor/bin/bob 调用 Bob。

系统级安装

1. 克隆仓库或下载 Release。
2. 安装依赖并运行 php bin/bob install。
3. 通过 bob 命令调用 Bob。