refactor(app/Generators): sanitize output in GithubCopilotCliGenerator

- Add a private method `sanitize` to the `GithubCopilotCliGenerator` class
- The `sanitize` method takes a string parameter `output`
- Inside the `sanitize` method,  the `output` string is sanitized
- The sanitized output is returned as a string
- The `sanitize` method uses the `str` function to manipulate the `output` string
- The    `match` method is called on the `str` object to extract a JSON substring from the `output` string
- The `replaceMatches` method is called on the `str` object to remove      control characters from the JSON substring
- The sanitized JSON substring is returned as the result of the `sanitize` method
- The `sanitize` method is called in the       `GithubCopilotCliGenerator` class to sanitize the output before returning it

Author: [email protected]

app/Generators/GithubCopilotCliGenerator.php

@@ -50,6 +50,11 @@ public function generate(string $prompt): string
             Process::OUT === $type ? $this->outputStyle->write($data) : $this->outputStyle->write("<fg=red>$data</>");
         })->getOutput();
 
+        return $this->sanitize($output);
+    }
+
+    private function sanitize(string $output): string
+    {
         return (string) str($output)
             ->match('/\{.*\}/s')
             // ->replaceMatches('/[[:cntrl:]]/mu', '')

tests/Unit/Generators/GithubCopilotCliGeneratorTest.php

@@ -28,3 +28,20 @@
     config('ai-commit')->set('generators.github_copilot_cli.binary', 'github-copilot-cli');
     expect(app(GeneratorManager::class)->driver('github_copilot_cli'))->generate('error');
 })->group(__DIR__, __FILE__)->throws(ProcessFailedException::class);
+
+it('can sanitize output to JSON', function (): void {
+    $output = <<<'OUTPUT'
+        {
+          "subject": "fix(app/Generators): update GithubCopilotCliGenerator to include binary command",
+          "body": "- Change the command array in the `resolve` function call to include `[\'binary\', \'copilot\', \'explain\', $prompt]` as the command\\n- Update the `mustRun` function
+          callback to handle output formatting\\n- Add debug statements to output the generated `$output` variable and perform a `dd()` call\\n- Return the generated `$output` variable"
+          }
+        OUTPUT;
+
+    expect($output)->not->toBeJson()
+        ->and(
+            (function (string $output): string {
+                return $this->sanitize($output);
+            })->call(app(GeneratorManager::class)->driver('github_copilot_cli'), $output)
+        )->toBeJson();
+})->group(__DIR__, __FILE__);