Fix output render, make sure it can be run on Windows (#10)

dinhquochan · web-flow · commit 723162c05bc4 · 2023-01-06T14:14:44.000+07:00
resolved #9
diff --git a/.gitattributes b/.gitattributes
@@ -1,7 +1,16 @@
-/.gitattributes     export-ignore
-/.gitignore         export-ignore
-/phpunit.xml.dist   export-ignore
-/tests              export-ignore
-/.github            export-ignore
-/.editorconfig      export-ignore
-/pint.json          export-ignore
+* text=auto
+
+*.blade.php diff=html
+*.css diff=css
+*.html diff=html
+*.md diff=markdown
+*.php diff=php
+
+/.gitattributes export-ignore
+/.gitignore export-ignore
+/.github export-ignore
+/.editorconfig export-ignore
+/art export-ignore
+/phpunit.xml.dist export-ignore
+/pint.json export-ignore
+/tests export-ignore
diff --git a/README.md b/README.md
@@ -1,9 +1,15 @@
 # Laravel GIT Commit Checker
 
-[![Latest Version](https://img.shields.io/packagist/v/botble/git-commit-checker.svg?style=flat-square)](https://github.com/botble/git-commit-checker/releases)
-[![Software License](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square)](LICENSE)
-[![Total Downloads](https://img.shields.io/packagist/dt/botble/git-commit-checker.svg?style=flat-square)](https://packagist.org/packages/botble/git-commit-checker)
-[![Maintainability](https://api.codeclimate.com/v1/badges/a6e4612307e3b3bf8252/maintainability)](https://codeclimate.com/github/botble/git-commit-checker/maintainability)
+<p align="center">
+    <img src="/art/overview.png" alt="Overview Git Commit Checker" style="width:70%;">
+</p>
+
+<p align="center">
+    <a href="https://packagist.org/packages/botble/git-commit-checker"><img src="https://img.shields.io/packagist/v/botble/git-commit-checker.svg?style=flat-square" alt="Latest Version"></a>
+    <a href="/LICENSE"><img src="https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square" alt="Software License"></a>
+    <a href="https://packagist.org/packages/botble/git-commit-checker"><img src="https://img.shields.io/packagist/dt/botble/git-commit-checker.svg?style=flat-square" alt="Total Downloads"></a>
+    <a href="https://codeclimate.com/github/botble/git-commit-checker/maintainability"><img src="https://api.codeclimate.com/v1/badges/a6e4612307e3b3bf8252/maintainability" alt="Maintainability"></a>
+</p>
 
 ## Requirement
 
diff --git a/art/overview.png b/art/overview.png
diff --git a/resources/views/summary.blade.php b/resources/views/summary.blade.php
@@ -0,0 +1,53 @@
+<div class="mx-2">
+    @if(! $isSuccessful)
+        @foreach($result['files'] as $file)
+            <div class="mb-1 mt-2">
+                <span class="px-1 bg-red text-white uppercase">File</span>
+                <span class="ml-1">{{ ltrim(str_replace(base_path(), '', $file['name']), '/') }}</span>
+            </div>
+
+            <div class="flex max-w-150">
+                <span>Rules</span>
+                <span class="flex-1 content-repeat-[.] text-gray ml-1"></span>
+                <span class="ml-1">
+                    @foreach($file['appliedFixers'] as $fixer)
+                        <span class="text-red ml-1">{{ $fixer . ($loop->last ? '' : ', ') }}</span>
+                    @endforeach
+                </span>
+            </div>
+
+            <div class="flex space-x-1 mt-1">
+                <span class="flex-1 content-repeat-[─] text-gray"></span>
+            </div>
+        @endforeach
+
+        <div class="mb-2"></div>
+    @endif
+
+    <div class="flex space-x-1 mb-2">
+        <span class="font-bold">
+            Checked <span class="text-yellow">{{ count($result['files']) }}</span> files in <span class="text-yellow">{{ $result['time']['total'] ?? 0 }}</span> seconds.
+            Using memory <span class="text-yellow">{{ $result['memory'] }}</span> MB.
+        </span>
+    </div>
+
+    @if(! $isSuccessful)
+        <div class="mb-1">
+            <span class="px-1 bg-yellow text-white uppercase">Warn</span>
+            <span class="ml-1">
+                Run <span class="text-yellow">./vendor/bin/pint --dirty --test -v</span> to see coding standard detail issues.
+            </span>
+        </div>
+        <div class="mb-1">
+            <span class="px-1 bg-yellow text-white uppercase">Warn</span>
+            <span class="ml-1">
+                Run <span class="text-yellow">./vendor/bin/pint --dirty</span> to fix coding standard issues.
+            </span>
+        </div>
+    @else
+        <div class="mb-1">
+            <span class="px-1 bg-green text-white uppercase">Success</span>
+            <span class="ml-1">Your code is perfect, no syntax error found!</span>
+        </div>
+    @endif
+</div>
diff --git a/src/Commands/InstallCommand.php b/src/Commands/InstallCommand.php
@@ -2,6 +2,7 @@
 
 namespace Botble\GitCommitChecker\Commands;
 
+use Illuminate\Console\Application;
 use Illuminate\Console\Command;
 use Illuminate\Console\ConfirmableTrait;
 use Symfony\Component\Console\Attribute\AsCommand;
@@ -35,14 +36,14 @@ public function handle(): int
         $pintConfigFilePath = $this->laravel->basePath('pint.json');
 
         if ($this->laravel['files']->exists($pintConfigFilePath)) {
-            if ($this->components->confirm('A pint.json exists. Do you want to overwrite this file?')) {
+            if ($this->components->confirm('A <comment>pint.json</comment> exists. Do you want to overwrite this file?')) {
                 $this->generatePintConfiguration($pintConfigFilePath);
             }
 
             return self::SUCCESS;
         }
 
-        if ($this->components->confirm('A pint.json does not exists. Do you want to create this file?')) {
+        if ($this->components->confirm('A <comment>pint.json</comment> does not exists. Do you want to create this file?')) {
             $this->generatePintConfiguration($pintConfigFilePath);
         }
 
@@ -79,9 +80,7 @@ protected function install(string $hook, string $class): bool
 
     protected function generateHookScript(string $signature): string
     {
-        $artisan = addslashes($this->laravel->basePath('artisan'));
-
-        return "#!/bin/sh\n\nphp $artisan $signature\n";
+        return sprintf("#!/bin/sh\n\n%s\n", Application::formatCommandString($signature));
     }
 
     protected function generatePintConfiguration(string $path): void
@@ -110,7 +109,9 @@ protected function generatePintConfiguration(string $path): void
             abort(1);
         }
 
-        $this->components->info("Created [$path] using $presets[$preset] preset successfully");
+        $this->components->info(
+            "Created <comment>$path</comment> using <comment>$presets[$preset]</comment> preset successfully"
+        );
     }
 
     protected function writeHookScript(string $path, string $script): bool
diff --git a/src/Commands/PreCommitHookCommand.php b/src/Commands/PreCommitHookCommand.php
@@ -7,6 +7,8 @@
 use Symfony\Component\Console\Attribute\AsCommand;
 use Symfony\Component\Process\Process;
 
+use function Termwind\render;
+
 #[AsCommand('git-commit-checker:pre-commit-hook', 'Git hook before commit')]
 class PreCommitHookCommand extends Command
 {
@@ -31,20 +33,26 @@ public function handle(): int
         $command = [
             $this->laravel->basePath('vendor/bin/pint'),
             '--test',
+            '--format=json',
+            '-v',
         ];
 
         $command = array_merge($command, $uncommittedFiles);
 
         $process = $this->getProcess($command);
 
-        $process->setTty(true);
-
         $process->run();
 
-        if (! $process->isSuccessful()) {
-            $this->components->warn('Run <comment>./vendor/bin/pint --dirty --test -v</comment> to see coding standard detail issues');
-            $this->components->warn('Run <comment>./vendor/bin/pint --dirty</comment> to fix coding standard issues');
+        $result = json_decode($process->getOutput(), true);
+
+        render(
+            view('git-commit-checker::summary', [
+                'result' => $result,
+                'isSuccessful' => $process->isSuccessful(),
+            ])
+        );
 
+        if ($process->isSuccessful()) {
             return self::FAILURE;
         }
 
diff --git a/src/Providers/GitCommitCheckerServiceProvider.php b/src/Providers/GitCommitCheckerServiceProvider.php
@@ -17,6 +17,8 @@ public function boot()
     {
         $this->app->register(CommandServiceProvider::class);
 
+        $this->loadViewsFrom(__DIR__ . '/../../resources/views', 'git-commit-checker');
+
         if ($this->app->runningInConsole()) {
             $this->publishes([
                 __DIR__ . '/../../config/git-commit-checker.php' => config_path('git-commit-checker.php'),

Original file line number	Diff line number	Diff line change
`@@ -2,6 +2,7 @@`
`2`	`2`
`3`	`3`	`namespace Botble\GitCommitChecker\Commands;`
`4`	`4`
	`5`	`+use Illuminate\Console\Application;`
`5`	`6`	`use Illuminate\Console\Command;`
`6`	`7`	`use Illuminate\Console\ConfirmableTrait;`
`7`	`8`	`use Symfony\Component\Console\Attribute\AsCommand;`
`@@ -35,14 +36,14 @@ public function handle(): int`
`35`	`36`	`$pintConfigFilePath = $this->laravel->basePath('pint.json');`
`36`	`37`
`37`	`38`	`if ($this->laravel['files']->exists($pintConfigFilePath)) {`
`38`		`- if ($this->components->confirm('A pint.json exists. Do you want to overwrite this file?')) {`
	`39`	`+ if ($this->components->confirm('A <comment>pint.json</comment> exists. Do you want to overwrite this file?')) {`
`39`	`40`	`$this->generatePintConfiguration($pintConfigFilePath);`
`40`	`41`	`}`
`41`	`42`
`42`	`43`	`return self::SUCCESS;`
`43`	`44`	`}`
`44`	`45`
`45`		`- if ($this->components->confirm('A pint.json does not exists. Do you want to create this file?')) {`
	`46`	`+ if ($this->components->confirm('A <comment>pint.json</comment> does not exists. Do you want to create this file?')) {`
`46`	`47`	`$this->generatePintConfiguration($pintConfigFilePath);`
`47`	`48`	`}`
`48`	`49`
`@@ -79,9 +80,7 @@ protected function install(string $hook, string $class): bool`
`79`	`80`
`80`	`81`	`protected function generateHookScript(string $signature): string`
`81`	`82`	`{`
`82`		`- $artisan = addslashes($this->laravel->basePath('artisan'));`
`83`		`-`
`84`		`- return "#!/bin/sh\n\nphp $artisan $signature\n";`
	`83`	`+ return sprintf("#!/bin/sh\n\n%s\n", Application::formatCommandString($signature));`
`85`	`84`	`}`
`86`	`85`
`87`	`86`	`protected function generatePintConfiguration(string $path): void`
`@@ -110,7 +109,9 @@ protected function generatePintConfiguration(string $path): void`
`110`	`109`	`abort(1);`
`111`	`110`	`}`
`112`	`111`
`113`		`- $this->components->info("Created [$path] using $presets[$preset] preset successfully");`
	`112`	`+ $this->components->info(`
	`113`	`+ "Created <comment>$path</comment> using <comment>$presets[$preset]</comment> preset successfully"`
	`114`	`+ );`
`114`	`115`	`}`
`115`	`116`
`116`	`117`	`protected function writeHookScript(string $path, string $script): bool`
Original file line number	Diff line number	Diff line change
`@@ -17,6 +17,8 @@ public function boot()`
`17`	`17`	`{`
`18`	`18`	`$this->app->register(CommandServiceProvider::class);`
`19`	`19`
	`20`	`+ $this->loadViewsFrom(__DIR__ . '/../../resources/views', 'git-commit-checker');`
	`21`	`+`
`20`	`22`	`if ($this->app->runningInConsole()) {`
`21`	`23`	`$this->publishes([`
`22`	`24`	`__DIR__ . '/../../config/git-commit-checker.php' => config_path('git-commit-checker.php'),`