castor

castor adalah pelari tugas berorientasi DX yang dibangun di PHP yang menampilkan berbagai fungsi untuk pemrosesan tugas umum.

Ini dapat dilihat sebagai alternatif untuk skrip Makefile, Fabric, Invoke, Shell, dll., tetapi ini memanfaatkan kemampuan skrip PHP dan ekosistem perpustakaan yang luas.

Muncul dengan banyak fitur untuk membuat hidup Anda lebih mudah:

• Penguraian argumen dan opsi yang mulus, menyederhanakan penanganan masukan
• Dukungan pelengkapan otomatis untuk pengetikan yang lebih cepat dan bebas kesalahan
• Daftar fungsi berguna yang ada di dalamnya:
  • run() : Jalankan proses eksternal, memungkinkan integrasi tanpa batas dengan alat eksternal
  • io() : Menampilkan keluaran yang indah dan berinteraksi dengan terminal
  • watch() : Menonton file dan secara otomatis memicu tindakan pada modifikasi file
  • fs() : Membuat, menghapus, dan memanipulasi file dan direktori
  • Dan fungsi yang lebih canggih lagi

Catatan

castor masih dalam pengembangan awal, dan API belum stabil. Meski kecil kemungkinannya, namun ada kemungkinan hal itu akan berubah di masa depan.

Penggunaan

Di castor , tugas diatur sebagai fungsi khas PHP yang ditandai dengan atribut #[AsTask()] di file castor .php .

Tugas-tugas ini dapat menjalankan kode PHP apa pun tetapi juga memanfaatkan berbagai fungsi untuk operasi standar yang sudah dikemas sebelumnya dengan castor .

Misalnya:

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

 <?php

namespace greetings ;

use castor  Attribute  AsTask ;
use function castor  io ;

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

Akan memaparkan tugas greetings:hello yang dapat Anda jalankan dengan castor greetings:hello :

castor greetings:hello Hello from castor ">

$ castor greetings:hello
Hello from castor

Kemudian, Anda dapat menjadi lebih liar dan membuat tugas yang lebih kompleks:

#[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. ' )
}

Jika Anda ingin membaca lebih lanjut tentang penggunaan, Anda dapat membaca dokumentasi penggunaan dasar, atau melihat beberapa contoh.

Instalasi

Dengan penginstal

Tip

Ini adalah cara yang disarankan untuk menginstal castor di Linux dan macOS. Ini membutuhkan PHP >= 8.1.

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

Ada cara lain untuk menginstal castor , silakan merujuk ke dokumentasi.

Dokumentasi lebih lanjut

Temukan lebih lanjut dengan membaca dokumen:

• Memulai dengan castor
  • Instalasi dan Pelengkapan Otomatis
  • Penggunaan Dasar
  • Menjalankan Proses dengan run()
  • Argumen Tugas
  • Menggunakan Konteks
• Melangkah lebih jauh dengan castor
• referensi castor
• Contoh
• Pertanyaan yang sering diajukan