Use Laravel Pint for code formatting (#141)

Co-authored-by: jesseleite <[email protected]>

.github/workflows/pint-fix.yml

@@ -0,0 +1,29 @@
+name: Fix PHP code style issues
+
+on:
+  push:
+    paths:
+      - '**.php'
+
+permissions:
+  contents: write
+
+jobs:
+  fix-php-code-styling:
+    runs-on: ubuntu-latest
+    if: github.repository_owner == 'statamic'
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+        with:
+          ref: ${{ github.head_ref }}
+          token: ${{ secrets.PINT }}
+
+      - name: Fix PHP code style issues
+        uses: aglipanci/[email protected]
+
+      - name: Commit changes
+        uses: stefanzweifel/git-auto-commit-action@v4
+        with:
+          commit_message: Fix styling

.github/workflows/pint-lint.yml

@@ -0,0 +1,20 @@
+name: Lint PHP code style issues
+
+on:
+  pull_request:
+    paths:
+      - '**.php'
+
+jobs:
+  lint-php-code-styling:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      - name: Check PHP code style issues
+        uses: aglipanci/[email protected]
+        with:
+          testMode: true
+          verboseMode: true

.gitignore

@@ -1,2 +1,3 @@
+.DS_Store
 /vendor
 /composer.lock

pint.json

@@ -0,0 +1,11 @@
+{
+    "preset": "laravel",
+    "rules": {
+        "class_attributes_separation": {
+            "elements": {
+                "method": "one"
+            }
+        },
+        "psr_autoloading": true
+    }
+}

src/Commands/StaticSiteClear.php

@@ -3,8 +3,8 @@
 namespace Statamic\StaticSite\Commands;
 
 use Illuminate\Console\Command;
-use Statamic\StaticSite\Generator;
 use Statamic\Console\RunsInPlease;
+use Statamic\StaticSite\Generator;
 use Wilderborn\Partyline\Facade as Partyline;
 
 class StaticSiteClear extends Command

src/Commands/StaticSiteGenerate.php

@@ -3,9 +3,9 @@
 namespace Statamic\StaticSite\Commands;
 
 use Illuminate\Console\Command;
-use Statamic\StaticSite\Generator;
 use Statamic\Console\RunsInPlease;
 use Statamic\StaticSite\GenerationFailedException;
+use Statamic\StaticSite\Generator;
 use Wilderborn\Partyline\Facade as Partyline;
 
 class StaticSiteGenerate extends Command
@@ -63,6 +63,7 @@ public function handle()
         } catch (GenerationFailedException $e) {
             $this->line($e->getConsoleMessage());
             $this->error('Static site generation failed.');
+
             return 1;
         }
 

src/Commands/StaticSiteLinks.php

@@ -3,8 +3,8 @@
 namespace Statamic\StaticSite\Commands;
 
 use Illuminate\Console\Command;
-use Statamic\StaticSite\Generator;
 use Statamic\Console\RunsInPlease;
+use Statamic\StaticSite\Generator;
 use Wilderborn\Partyline\Facade as Partyline;
 
 class StaticSiteLinks extends Command

src/GeneratedPage.php

@@ -38,7 +38,7 @@ public function consoleMessage()
         $message = vsprintf('%s%s %s', [
             "\x1B[1A\x1B[2K",
             $this->hasWarning() ? '<comment>[!]</comment>' : '<info>[✔]</info>',
-            $this->url()
+            $this->url(),
         ]);
 
         if ($this->isRedirect()) {

src/Generator.php

@@ -3,27 +3,26 @@
 namespace Statamic\StaticSite;
 
 use Carbon\Carbon;
-use Spatie\Fork\Fork;
-use Statamic\Statamic;
 use Facades\Statamic\View\Cascade;
-use Statamic\Facades\URL;
-use Statamic\Support\Str;
-use Statamic\Facades\Site;
+use Illuminate\Contracts\Foundation\Application;
+use Illuminate\Filesystem\Filesystem;
 use Illuminate\Routing\Router;
 use Illuminate\Support\Arr;
+use League\Flysystem\Filesystem as Flysystem;
+use Spatie\Fork\Fork;
+use Statamic\Contracts\Imaging\UrlBuilder;
 use Statamic\Facades\Collection;
 use Statamic\Facades\Entry;
 use Statamic\Facades\Glide;
+use Statamic\Facades\Site;
 use Statamic\Facades\Term;
-use League\Flysystem\Adapter\Local;
+use Statamic\Facades\URL;
+use Statamic\Http\Controllers\FrontendController;
 use Statamic\Imaging\ImageGenerator;
-use Illuminate\Filesystem\Filesystem;
 use Statamic\Imaging\StaticUrlBuilder;
-use Statamic\Contracts\Imaging\UrlBuilder;
-use League\Flysystem\Filesystem as Flysystem;
+use Statamic\Statamic;
+use Statamic\Support\Str;
 use Wilderborn\Partyline\Facade as Partyline;
-use Illuminate\Contracts\Foundation\Application;
-use Statamic\Http\Controllers\FrontendController;
 
 class Generator
 {
@@ -115,12 +114,12 @@ public function bindGlide()
             : '\League\Flysystem\Local\LocalFilesystemAdapter';
 
         $this->app['League\Glide\Server']->setCache(
-            new Flysystem(new $localAdapter($this->config['destination'] . '/' . $directory))
+            new Flysystem(new $localAdapter($this->config['destination'].'/'.$directory))
         );
 
         $this->app->bind(UrlBuilder::class, function () use ($directory) {
             return new StaticUrlBuilder($this->app[ImageGenerator::class], [
-                'route' => URL::tidy($this->config['base_url'] . '/' . $directory)
+                'route' => URL::tidy($this->config['base_url'].'/'.$directory),
             ]);
         });
 
@@ -137,7 +136,7 @@ public function clearDirectory()
     public function createSymlinks()
     {
         foreach ($this->config['symlinks'] as $source => $dest) {
-            $dest = $this->config['destination'] . '/' . $dest;
+            $dest = $this->config['destination'].'/'.$dest;
 
             if ($this->files->exists($dest)) {
                 Partyline::line("Symlink not created. $dest already exists.");
@@ -153,7 +152,7 @@ public function createSymlinks()
     public function copyFiles()
     {
         foreach ($this->config['copy'] ?? [] as $source => $dest) {
-            $dest = $this->config['destination'] . '/' . $dest;
+            $dest = $this->config['destination'].'/'.$dest;
 
             if (is_file($source)) {
                 $this->files->copy($source, $dest);
@@ -234,7 +233,9 @@ protected function pages()
             ->reject(function ($page) {
                 foreach ($this->config['exclude'] as $url) {
                     if (Str::endsWith($url, '*')) {
-                        if (Str::is($url, $page->url())) return true;
+                        if (Str::is($url, $page->url())) {
+                            return true;
+                        }
                     }
                 }
 
@@ -274,6 +275,7 @@ protected function makeContentGenerationClosures($pages, $request)
                         }
 
                         $errors[] = $e->consoleMessage();
+
                         continue;
                     } finally {
                         Carbon::setToStringFormat($oldCarbonFormat);
@@ -305,7 +307,7 @@ protected function outputTasksResults()
     protected function outputSummary()
     {
         Partyline::info('');
-        Partyline::info('Static site generated into ' . $this->config['destination']);
+        Partyline::info('Static site generated into '.$this->config['destination']);
 
         $total = $this->taskResults['count'];
 
@@ -378,6 +380,7 @@ protected function urls()
 
         return collect($this->config['urls'] ?? [])->merge($extra)->map(function ($url) {
             $url = URL::tidy(Str::start($url, $this->config['base_url'].'/'));
+
             return $this->createPage(new Route($url));
         });
     }
@@ -389,6 +392,7 @@ protected function routes()
                 && ! Str::contains($route->uri(), '{');
         })->map(function ($route) {
             $url = URL::tidy(Str::start($route->uri(), $this->config['base_url'].'/'));
+
             return $this->createPage(new StatamicRoute($url));
         });
     }

src/NotGeneratedException.php

@@ -3,8 +3,8 @@
 namespace Statamic\StaticSite;
 
 use Facade\Ignition\Exceptions\ViewException;
-use Symfony\Component\HttpKernel\Exception\HttpException;
 use Statamic\Exceptions\NotFoundHttpException as StatamicNotFoundHttpException;
+use Symfony\Component\HttpKernel\Exception\HttpException;
 use Symfony\Component\HttpKernel\Exception\NotFoundHttpException as SymfonyNotFoundHttpException;
 
 class NotGeneratedException extends \Exception
@@ -37,12 +37,12 @@ public function consoleMessage()
                 $message = 'Resulted in 404';
                 break;
             case HttpException::class:
-                $message = 'Resulted in ' . $exception->getStatusCode();
+                $message = 'Resulted in '.$exception->getStatusCode();
                 break;
             default:
                 $message = $this->getMessage();
         }
 
-        return sprintf('%s %s (%s)', "<fg=red>[✘]</>", $this->getPage()->url(), $message);
+        return sprintf('%s %s (%s)', '<fg=red>[✘]</>', $this->getPage()->url(), $message);
     }
 }

src/Page.php

@@ -4,8 +4,8 @@
 
 use Exception;
 use Illuminate\Filesystem\Filesystem;
-use Illuminate\Http\RedirectResponse;
 use Illuminate\Http\Exceptions\HttpResponseException;
+use Illuminate\Http\RedirectResponse;
 
 class Page
 {
@@ -67,14 +67,14 @@ public function directory()
     public function path()
     {
         if ($this->is404()) {
-            return $this->config['destination'] . '/404.html';
+            return $this->config['destination'].'/404.html';
         }
 
         $url = $this->url();
 
         $ext = pathinfo($url, PATHINFO_EXTENSION) ?: 'html';
 
-        $url = $this->config['destination'] . $url;
+        $url = $this->config['destination'].$url;
 
         if ($ext === 'html') {
             $url .= '/index.html';

src/ServiceProvider.php

@@ -2,9 +2,8 @@
 
 namespace Statamic\StaticSite;
 
-use Spatie\Fork\Fork;
-use Statamic\StaticSite\Generator;
 use Illuminate\Support\ServiceProvider as LaravelServiceProvider;
+use Spatie\Fork\Fork;
 
 class ServiceProvider extends LaravelServiceProvider
 {

tests/ConsecutiveTasksTest.php

@@ -13,11 +13,13 @@ public function it_runs_callbacks()
 
         $one = function () use (&$callbacksRan) {
             $callbacksRan++;
+
             return 'one';
         };
 
         $two = function () use (&$callbacksRan) {
             $callbacksRan++;
+
             return 'two';
         };
 

tests/PageTest.php

@@ -3,7 +3,6 @@
 namespace Tests;
 
 use Illuminate\Filesystem\Filesystem;
-use Mockery;
 use Statamic\Contracts\Entries\Entry;
 use Statamic\StaticSite\Page;
 

tests/RequestTest.php

@@ -2,11 +2,10 @@
 
 namespace Tests;
 
-use Mockery;
-use Statamic\Facades\Site;
+use Statamic\Entries\Collection;
 use Statamic\Entries\Entry;
+use Statamic\Facades\Site;
 use Statamic\StaticSite\Page;
-use Statamic\Entries\Collection;
 use Statamic\StaticSite\Request;
 
 class RequestTest extends TestCase

tests/TestCase.php

@@ -2,8 +2,8 @@
 
 namespace Tests;
 
-use Statamic\Providers\StatamicServiceProvider;
 use Orchestra\Testbench\TestCase as OrchestraTestCase;
+use Statamic\Providers\StatamicServiceProvider;
 use Statamic\Statamic;
 
 class TestCase extends OrchestraTestCase