Hotkeys and Screen Emulator

.github/workflows/tests.yml

@@ -19,10 +19,7 @@ jobs:
         dependency-version: [ prefer-lowest, prefer-stable ]
         include:
           - laravel: 10.*
-            testbench: 8.*
           - laravel: 11.*
-            testbench: 9.*
-
 
     name: P${{ matrix.php }} / L${{ matrix.laravel }} / ${{ matrix.dependency-version }}
 
@@ -47,7 +44,7 @@ jobs:
       - name: Install dependencies
         run: |
           composer self-update ${{ matrix.composer-version }}
-          composer require "laravel/framework:${{ matrix.laravel }}" "orchestra/testbench:${{ matrix.testbench }}" --no-interaction --no-update
+          composer require "laravel/framework:${{ matrix.laravel }}" --no-interaction --no-update
           composer update --${{ matrix.dependency-version }} --prefer-dist --no-interaction
 
       - name: Execute tests

.gitignore

@@ -1,3 +1,4 @@
+artisan
 .idea
 .phpunit.result.cache
 build

README.md

@@ -86,6 +86,7 @@ class SoloServiceProvider extends ServiceProvider
                 EnhancedTailCommand::make('Logs', 'tail -f -n 100 ' . storage_path('logs/laravel.log')),
                 'Vite' => 'npm run dev',
                 // 'HTTP' => 'php artisan serve',
+                new Command(name: 'Foo', command: 'pwd"', autostart: false, customHotKeys: []),
                 'About' => 'php artisan solo:about'
             ])
             // Not auto-started
@@ -126,6 +127,7 @@ Solo::useTheme('dark')
         EnhancedTailCommand::make('Logs', 'tail -f -n 100 ' . storage_path('logs/laravel.log')),
         'Vite' => 'npm run dev',
         // 'HTTP' => 'php artisan serve',
+        new Command(name: 'Foo', command: 'pwd"', autostart: false, customHotKeys: []),
         'About' => 'php artisan solo:about'
     ])
 ```
@@ -134,6 +136,31 @@ Solo::useTheme('dark')
 
 To remove a command, simply delete the command. No need to create a PR to fix the stub. We've provided a reasonable set of starting commands, but the `SoloServiceProvider` lives in your application, so you have full control of it.
 
+## Adding custom hotkeys to commands
+
+To add custom hot keys for a command, you can pass an array of `AaronFrancis\Solo\Console\CustomHotKey` instances to the `customHotKeys` parameter of the `Command` constructor.
+
+For example, notice the `CustomHotKey` array here:
+
+```php
+Solo::useTheme('dark')
+    // Commands that auto start.
+    ->addCommands([
+        // ...
+        new Command(name: 'Foo', command: 'echo "See hotkeys below"', autostart: true, customHotKeys: [
+            new CustomHotKey(
+                key: 'e',
+                name: 'echoE',
+                callback: fn() => Log::info('pressed "e"...'),
+                when: fn(Command $command) => $command->processRunning()
+            ),
+            new CustomHotKey(key: 'f', name: 'echoF', callback: fn() => Log::info('pressed "f"...')),
+        ]),
+    ])
+```
+
+The `when` parameter is optional. If provided, the hot key will only be active when the `when` callback returns `true`. This can be useful for hot keys that only make sense when a process is running.
+
 ## Usage
 
 To use Solo, you simply need to run `php artisan solo`.
@@ -209,22 +236,19 @@ If you want to support me you can either buy one of my courses or tell your frie
 - High Performance SQLite: https://highperformancesqlite.com
 - Screencasting: https://screencasting.com
 
-
 ## FAQ
 
-<dl>
-    <dt>My command isn't working</dt>
-    <dd>(That's not really a question, but I'll allow it.) Does it work outside of Solo? Does it have an `--ansi`
-        option? Is it writing to somewhere besides `STDOUT`? Is there an option to force it to write to `STDOUT`? If
-        you've tried all that, feel free to open an issue.
-    </dd>
-    <dt>Can I run Sail commands?</dt>
-    <dd>Yes! This seems to be the way to do it: `vendor/bin/sail artisan schedule:work --ansi` (Read more at #29.)
-    </dd>
-    <dt>Does Solo support Windows?</dt>
-    <dd>It does not, sorry. Solo relies on `ext-pcntl` and a few other Linux-y things, so Windows support is not on the
-        roadmap.
-    </dd>
-    <dt>Can I use this in production?</dt>
-    <dd>I wouldn't. I'd use something more robust, like supervisor or something.</dd>
-</dl>
+#### My command isn't working
+(That's not really a question, but I'll allow it.) Does it work outside of Solo? Does it have an `--ansi`
+option? Is it writing to somewhere besides `STDOUT`? Is there an option to force it to write to `STDOUT`? If
+you've tried all that, feel free to open an issue.
+
+#### Can I run Sail commands?
+Yes! This seems to be the way to do it: `vendor/bin/sail artisan schedule:work --ansi` (Read more at #29.)
+
+#### Does Solo support Windows?
+It does not, sorry. Solo relies on `ext-pcntl` and a few other Linux-y things, so Windows support is not on the
+roadmap.
+
+#### Can I use this in production?
+I wouldn't. I'd use something more robust, like supervisor or something.

composer.json

@@ -21,14 +21,18 @@
     "require-dev": {
         "illuminate/database": "^10|^11",
         "phpunit/phpunit": "^10.5|^11",
-        "orchestra/testbench": "^8|^9"
+        "orchestra/testbench": "^8.29|^9.5",
+        "laravel/serializable-closure": "^1.3"
     },
     "autoload": {
         "psr-4": {
             "AaronFrancis\\Solo\\": "src/"
         }
     },
     "autoload-dev": {
+        "files": [
+            "tests/Support/helpers.php"
+        ],
         "psr-4": {
             "AaronFrancis\\Solo\\Tests\\": "tests/",
             "App\\": "workbench/app/"

config/solo.php

@@ -0,0 +1,17 @@
+<?php
+
+return [
+    /*
+    |--------------------------------------------------------------------------
+    | Themes
+    |--------------------------------------------------------------------------
+    |
+    | We have provided 'light' and 'dark' themes. If you prefer to
+    | register your own theme, you are free to do that via the
+    | Facade: Solo::registerTheme('name', MyAwesomeTheme::class);
+    |
+    */
+    'theme' => env('SOLO_THEME', 'dark'),
+
+    'hotkeys' => env('SOLO_KEYBINDINGS', 'default')
+];