wip

README.md

@@ -21,6 +21,7 @@ Automatically create GitHub issues from your Laravel exceptions & logs. Perfect
 - 🏷️ Support customizable labels
 - 🎯 Smart deduplication to prevent issue spam
 - ⚡️ Buffered logging for better performance
+- 📝 Customizable issue templates
 
 ## Showcase
 
@@ -103,7 +104,29 @@ Log::stack(['daily', 'github'])->error('Something went wrong!');
 
 ## Advanced Configuration
 
-Deduplication and buffering are enabled by default to enhance logging. Customize these features to suit your needs.
+### Customizing Templates
+
+The package uses Markdown templates to format issues and comments. You can customize these templates by publishing them:
+
+```bash
+php artisan vendor:publish --tag="github-monolog-views"
+```
+
+This will copy the templates to `resources/views/vendor/github-monolog/` where you can modify them:
+
+- `issue.md`: Template for new issues
+- `comment.md`: Template for comments on existing issues
+- `previous_exception.md`: Template for previous exceptions in the chain
+
+Available template variables:
+- `{level}`: Log level (error, warning, etc.)
+- `{message}`: The error message or log content
+- `{simplified_stack_trace}`: A cleaned up stack trace
+- `{full_stack_trace}`: The complete stack trace
+- `{previous_exceptions}`: Details of any previous exceptions
+- `{context}`: Additional context data
+- `{extra}`: Extra log data
+- `{signature}`: Internal signature used for deduplication
 
 ### Deduplication
 

composer.json

@@ -64,6 +64,13 @@
       "phpstan/extension-installer": true
     }
   },
+  "extra": {
+    "laravel": {
+      "providers": [
+        "Naoray\\LaravelGithubMonolog\\GithubMonologServiceProvider"
+      ]
+    }
+  },
   "minimum-stability": "dev",
   "prefer-stable": true
 }

resources/views/comment.md

@@ -0,0 +1,28 @@
+# New Occurrence
+
+**Log Level:** {level}
+
+{message}
+
+**Simplified Stack Trace:**
+```php
+{simplified_stack_trace}
+```
+
+<details>
+<summary>Complete Stack Trace</summary>
+
+```php
+{full_stack_trace}
+```
+</details>
+
+<details>
+<summary>Previous Exceptions</summary>
+
+{previous_exceptions}
+</details>
+
+{context}
+
+{extra}

resources/views/issue.md

@@ -0,0 +1,28 @@
+**Log Level:** {level}
+
+{message}
+
+**Simplified Stack Trace:**
+```php
+{simplified_stack_trace}
+```
+
+<details>
+<summary>Complete Stack Trace</summary>
+
+```php
+{full_stack_trace}
+```
+</details>
+
+<details>
+<summary>Previous Exceptions</summary>
+
+{previous_exceptions}
+</details>
+
+{context}
+
+{extra}
+
+<!-- Signature: {signature} -->

resources/views/previous_exception.md

@@ -0,0 +1,15 @@
+### Previous Exception #{count}
+**Type:** {type}
+
+**Simplified Stack Trace:**
+```php
+{simplified_stack_trace}
+```
+
+<details>
+<summary>Complete Stack Trace</summary>
+
+```php
+{full_stack_trace}
+```
+</details>

src/GithubIssueHandlerFactory.php

@@ -9,11 +9,15 @@
 use Naoray\LaravelGithubMonolog\Deduplication\DeduplicationHandler;
 use Naoray\LaravelGithubMonolog\Deduplication\DefaultSignatureGenerator;
 use Naoray\LaravelGithubMonolog\Deduplication\SignatureGeneratorInterface;
-use Naoray\LaravelGithubMonolog\Issues\Formatter;
+use Naoray\LaravelGithubMonolog\Issues\Formatters\IssueFormatter;
 use Naoray\LaravelGithubMonolog\Issues\Handler;
 
 class GithubIssueHandlerFactory
 {
+    public function __construct(
+        private readonly IssueFormatter $formatter,
+    ) {}
+
     public function __invoke(array $config): Logger
     {
         $this->validateConfig($config);
@@ -45,7 +49,7 @@ protected function createBaseHandler(array $config): Handler
             bubble: Arr::get($config, 'bubble', true)
         );
 
-        $handler->setFormatter(new Formatter);
+        $handler->setFormatter($this->formatter);
 
         return $handler;
     }

src/GithubMonologServiceProvider.php

@@ -0,0 +1,46 @@
+<?php
+
+namespace Naoray\LaravelGithubMonolog;
+
+use Illuminate\Support\ServiceProvider;
+use Naoray\LaravelGithubMonolog\Issues\Formatters\ExceptionFormatter;
+use Naoray\LaravelGithubMonolog\Issues\Formatters\IssueFormatter;
+use Naoray\LaravelGithubMonolog\Issues\Formatters\StackTraceFormatter;
+use Naoray\LaravelGithubMonolog\Issues\StubLoader;
+use Naoray\LaravelGithubMonolog\Issues\TemplateRenderer;
+
+class GithubMonologServiceProvider extends ServiceProvider
+{
+    public function register(): void
+    {
+        $this->app->bind(StackTraceFormatter::class);
+        $this->app->bind(StubLoader::class);
+        $this->app->bind(ExceptionFormatter::class, function ($app) {
+            return new ExceptionFormatter(
+                stackTraceFormatter: $app->make(StackTraceFormatter::class),
+            );
+        });
+
+        $this->app->singleton(TemplateRenderer::class, function ($app) {
+            return new TemplateRenderer(
+                exceptionFormatter: $app->make(ExceptionFormatter::class),
+                stubLoader: $app->make(StubLoader::class),
+            );
+        });
+
+        $this->app->singleton(IssueFormatter::class, function ($app) {
+            return new IssueFormatter(
+                templateRenderer: $app->make(TemplateRenderer::class),
+            );
+        });
+    }
+
+    public function boot(): void
+    {
+        if ($this->app->runningInConsole()) {
+            $this->publishes([
+                __DIR__ . '/../resources/views' => resource_path('views/vendor/github-monolog'),
+            ], 'github-monolog-views');
+        }
+    }
+}