Castor 项目使用教程

Castor 项目使用教程

castor 🦫 DX oriented task runner and command launcher built with PHP. 项目地址: https://gitcode.com/gh_mirrors/ca/castor

1. 项目介绍

Castor 是一个面向开发者体验（DX）的任务运行器和命令启动器，使用 PHP 构建。它可以被视为 Makefile、Fabric、Invoke、Shell 脚本等的替代品，但它利用了 PHP 的脚本能力和其丰富的库生态系统。Castor 提供了许多功能来简化任务处理，包括无缝解析参数和选项、自动补全支持、内置的实用函数（如运行外部进程、显示终端输出、文件监控和文件系统操作）等。

2. 项目快速启动

安装

推荐使用安装器在 Linux 和 macOS 上安装 Castor。需要 PHP >= 8.1。

curl "https://castor.jolicode.com/install" | bash

创建第一个任务

在项目根目录下创建一个 castor.php 文件，并添加以下内容：

<?php

namespace greetings;

use Castor\Attribute\AsTask;
use function Castor\io;

#[AsTask()]
function hello(): void {
    io()->writeln('Hello from castor');
}

运行任务

在终端中运行以下命令来执行任务：

castor greetings:hello

输出将会是：

Hello from castor

3. 应用案例和最佳实践

清理基础设施

假设你有一个 Docker 项目，你可以使用 Castor 来清理基础设施，包括删除容器、卷和网络。

#[AsTask(description: 'Clean the infrastructure (remove container, volume, networks)')]
function destroy(bool $force = false) {
    if ($force) {
        io()->warning('This will permanently remove all containers, volumes, networks created for this project.');
        io()->comment('You can use the --force option to avoid this confirmation.');
        if (!io()->confirm('Are you sure?', false)) {
            io()->comment('Aborted.');
            return;
        }
    }
    run('docker-compose down -v --remove-orphans --volumes --rmi=local');
    notify('The infrastructure has been destroyed.');
}

自动补全

Castor 支持自动补全，可以大大提高命令输入的效率和准确性。安装后，你可以通过以下命令启用自动补全：

castor autocomplete

4. 典型生态项目

PHP 生态系统

Castor 是 PHP 生态系统中的一个重要工具，尤其适合那些需要频繁运行任务和命令的 PHP 项目。它可以与 Composer、Docker、PHPUnit 等工具无缝集成，提供了一个统一的接口来管理项目的各种任务。

开源社区

Castor 是一个开源项目，托管在 GitHub 上。它鼓励社区贡献，提供了丰富的文档和示例，帮助开发者快速上手并贡献代码。

通过以上内容，你可以快速了解并开始使用 Castor 项目。希望这个教程对你有所帮助！

castor 🦫 DX oriented task runner and command launcher built with PHP. 项目地址: https://gitcode.com/gh_mirrors/ca/castor