#35 - streamline package config

composer.json

@@ -12,6 +12,7 @@
   "require": {
     "php": "^8.3",
     "behat/behat": "^3.14",
+    "illuminate/console": "^10.0|^11.0",
     "phpunit/phpunit": "^10.1|^11.0.1",
     "symfony/css-selector": "^6.2|^7.1",
     "symfony/dom-crawler": "^6.2|^7.1"

readme.md

@@ -6,14 +6,15 @@ BLT for PHP developers: Behat+Laravel toolbox
 > Package is still under development.
 
 ### Usage
-Use Composer to get package from the Packagist repository:
+To start using package if you don't already have Behat initialized in your project:
 ```
 composer require blumilksfotware/blt --dev
+php artisan blt:init
 ```
-
-To use the package you need to have behat installed in your project:
+### Or if you want to do that manually:
+Use Composer to get package from the Packagist repository:
 ```
-php composer.phar require --dev behat/behat
+composer require blumilksfotware/blt --dev
 ```
 Create .env.behat file in your project root directory and set up your environment variables for Behat.
 ```
@@ -24,7 +25,7 @@ Initialize Behat in your project:
 php vendor/bin/behat --init
 ```
 To learn more about Behat visit [Behat documentation](https://docs.behat.org/en/latest/).
-
+### To use in your tests:
 Bootstrap BLT in your FeatureContext file:
 ```
  public function __construct()
@@ -33,6 +34,22 @@ Bootstrap BLT in your FeatureContext file:
         $bootstrapper->boot();
     }
 ```
+If you want to include all suite of features, you can use:
+```
+use Blumilk\BLT\Features\Toolbox;
+class FeatureContext extends Toolbox implements Context
+{...}
+```
+Or to use selected traits:
+```
+use Blumilk\BLT\Features\Traits\Eloquent;
+class FeatureContext implements Context
+{
+    use Eloquent;
+    ...
+}
+```
+
 Example usage in tests is available in the [docs](docs).
 ### Development
 There are scripts available for package codestyle checking and testing:

src/BLTServiceProvider.php

@@ -4,12 +4,16 @@
 
 namespace Blumilk\BLT;
 
+use Blumilk\BLT\Console\Commands\BLTInit;
 use Illuminate\Support\ServiceProvider;
 
 class BLTServiceProvider extends ServiceProvider
 {
     public function boot(): void
     {
+        $this->commands([
+            BLTInit::class,
+        ]);
         $this->publishes([
             __DIR__ . "/../config/blt.php" => config_path("blt.php"),
         ], "config");

src/Console/Commands/BLTInit.php

@@ -0,0 +1,49 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Blumilk\BLT\Console\Commands;
+
+use Illuminate\Console\Command;
+use Symfony\Component\Process\Exception\ProcessFailedException;
+use Symfony\Component\Process\Process;
+
+class BLTInit extends Command
+{
+    protected $signature = "blt:init";
+    protected $description = "Initialize BLT in your project";
+
+    public function handle(): void
+    {
+        $this->info("Configuring BLT package...");
+
+        if (!is_dir("features")) {
+            $this->initializeBehat();
+        }
+
+        if (!file_exists(".env.behat")) {
+            $this->copyEnvFile();
+        }
+
+        $this->info("Behat configured successfully with BLT");
+    }
+
+    protected function initializeBehat(): void
+    {
+        $process = new Process(["vendor/bin/behat", "--init"]);
+        $process->run();
+
+        if (!$process->isSuccessful()) {
+            throw new ProcessFailedException($process);
+        }
+
+        $this->info($process->getOutput());
+    }
+
+    protected function copyEnvFile(): void
+    {
+        if (!copy(".env.example", ".env.behat")) {
+            $this->error("Failed to copy .env.example to .env.behat");
+        }
+    }
+}