Merge pull request #18 from achyutkneupane/feat/debug-mode-in-production

feat: Debug mode indicator if true in production

Author: pxlrbt

readme.md

@@ -106,6 +106,20 @@ $panel->plugins([
 ]);
 ```
 
+### Debug Mode Warning
+
+You can enable a debug mode warning for every environment or just for production by using `->showDebugModeWarning()`/`->showDebugModeWarningInProduction()`
+
+```php
+use pxlrbt\FilamentEnvironmentIndicator\EnvironmentIndicatorPlugin;
+use Filament\Support\Colors\Color;
+
+$panel->plugins([
+    EnvironmentIndicatorPlugin::make()
+        ->showDebugModeWarningInProduction()            
+]);
+```
+
 ## Contributing
 
 If you want to contribute to this packages, you may want to test it in a real Filament project:

resources/css/styles.css

@@ -1,4 +1,4 @@
-.environment-indicator {
+.environment-indicator, .debug-mode-indicator {
     display: none;
     height: 2.25rem;
 

resources/views/debug-mode-warning.blade.php

@@ -0,0 +1,17 @@
+@php
+    use Filament\Support\Colors\Color;
+    use Filament\Support\Icons\Heroicon;
+    use function Filament\Support\get_color_css_variables;
+    use function Filament\Support\generate_icon_html;
+@endphp
+<div
+    class="
+        debug-mode-indicator
+        fi-badge fi-color fi-text-color-600
+        dark:fi-text-color-400
+    "
+    style="{{ get_color_css_variables(Color::Red, [50, 300, 400, 600])  }}"
+>
+    {{ generate_icon_html(Heroicon::OutlinedExclamationTriangle) }}
+    Debug Mode
+</div>

src/EnvironmentIndicatorPlugin.php

@@ -25,6 +25,8 @@ class EnvironmentIndicatorPlugin implements Plugin
 
     public bool|Closure|null $showGitBranch = null;
 
+    public bool|Closure|null $showDebugModeWarning = null;
+
     public static function make(): static
     {
         $plugin = app(static::class);
@@ -75,19 +77,30 @@ public function boot(Panel $panel): void
     public function register(Panel $panel): void
     {
         $panel->renderHook('panels::global-search.before', function () {
+            $html = '';
+
             if (! $this->evaluate($this->visible)) {
-                return '';
+                return $html;
             }
 
-            if (! $this->evaluate($this->showBadge)) {
-                return '';
+
+            if ($this->evaluate($this->showDebugModeWarning) && app()->hasDebugModeEnabled()) {
+                $html .= view('filament-environment-indicator::debug-mode-warning', [
+                    'color' => $this->getColor(),
+                    'environment' => ucfirst(app()->environment()),
+                    'branch' => $this->getGitBranch()
+                ])->render();
             }
 
-            return View::make('filament-environment-indicator::badge', [
-                'color' => $this->getColor(),
-                'environment' => ucfirst(app()->environment()),
-                'branch' => $this->getGitBranch(),
-            ]);
+            if ($this->evaluate($this->showBadge)) {
+                $html .= view('filament-environment-indicator::badge', [
+                    'color' => $this->getColor(),
+                    'environment' => ucfirst(app()->environment()),
+                    'branch' => $this->getGitBranch()
+                ])->render();
+            }
+
+            return $html;
         });
 
         $panel->renderHook('panels::styles.after', function () {
@@ -142,6 +155,20 @@ public function showGitBranch(bool|Closure $showGitBranch = true): static
         return $this;
     }
 
+    public function showDebugModeWarning(bool|Closure $showWarning = true): static
+    {
+        $this->showDebugModeWarning = $showWarning;
+
+        return $this;
+    }
+
+    public function showDebugModeWarningInProduction(): static
+    {
+        $this->showDebugModeWarning(fn () => app()->isProduction());
+
+        return $this;
+    }
+
     public function color(array|Closure $color = Color::Pink): static
     {
         $this->color = $color;