albet/scli

A Simple CLI Framework for you PHP Projects

1.0.1 2023-01-05 09:13 UTC

Requires

• php: ^8.0
• nunomaduro/termwind: ^1.15
• php-di/php-di: ^6.4
• symfony/console: ^6.2
• vlucas/phpdotenv: ^5.4

Requires (Dev)

• nunomaduro/collision: ^6.3
• phpunit/phpunit: ^9.5
• psy/psysh: @stable
• symfony/var-dumper: ^6.2

MIT

• albetnovendo

README

Slimmed CLI Framework, based from ASMVC CLI Interface + Symfony Console with bare minimum files required to parse and run the CLI. Allows you to create a command with fluency while keeping the framework as slim as possible.

Installation

Installation of this SCliPHP relatively simple.

All you need to do is run: `composer create-project albet/scli' and you're set!

Usage

Simply run php scli setup and follow the guide. Then have fun with make:command or create:command.

Examples

Note: you can view some examples by yourself in Core/Console/Commands folder which contain bundled command.

Example of Setup command:

<?php

namespace App\Core\Console\Commands;

use App\Core\Console\Command;
use App\Core\Console\Contracts\PromptableValue;
use App\Core\Console\FluentCommandBuilder;
use App\Core\Console\FluentOptionalParamBuilder;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;

class Setup extends Command
{
    protected function setup(FluentCommandBuilder $builder): FluentCommandBuilder
    {
        return $builder->setName("setup")
            ->setDesc("Setting up your cli project's environment in matter of seconds.")
            ->addOptionalParam(fn (FluentOptionalParamBuilder $opb) => $opb->setName('ignore')
                ->setDesc('Ignore env file checking')
                ->setInputTypeNone()
                ->setShortcut('ig'));
    }

    public function handler(InputInterface $inputInterface, OutputInterface $outputInterface): int
    {
        if (file_exists(base_path(".env")) && !$inputInterface->getOption('ignore')) {
            $this->error(".env File already exist. Aborting.");
            return Command::FAILURE;
        }

        $lookForCli = env("APP_NAME", "scli");

        $wantSetup = $this->prompt("Would you like to setting up SCli PHP? ");

        if (!($wantSetup instanceof PromptableValue)) {
            return Command::FAILURE;
        }

        if ($wantSetup === PromptableValue::NO) {
            $this->info("Aborting...");
            return Command::INVALID;
        }

        $appName = $this->ask("What is your app name?", ["scli"], "scli");
        $appVer = $this->ask("What is your current app version", ["1.0-dev"], "1.0-dev");

        $data = <<<data
        APP_NAME=$appName
        APP_VERSION=$appVer
        data;

        file_put_contents(base_path('.env'), $data);

        rename(base_path($lookForCli), base_path(strtolower(trim($appName))));

        $this->success(".env Generated.");

        return Command::SUCCESS;
    }
}