Merge pull request #709 from tighten/fix-format-action

Fix format action

.github/workflows/format.yml

@@ -3,33 +3,32 @@ on:
   pull_request:
     paths: ['**.php']
 jobs:
-  php-cs-fixer:
+  pint:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
           fetch-depth: 0
           ref: ${{ github.event.pull_request.head.ref }}
           repository: ${{ github.event.pull_request.head.repo.full_name }}
       - uses: shivammathur/setup-php@v2
         with:
-          php-version: 8.1
+          php-version: 8.3
       - uses: ramsey/composer-install@v2
-      - name: Run PHP-CS-Fixer
+      - name: Run Pint
         id: format
-        # https://docs.github.com/en/actions/using-workflows/workflow-commands-for-github-actions#multiline-strings
         run: |
           delimiter=$RANDOM
           echo "summary<<${delimiter}" >> $GITHUB_OUTPUT
-          composer format >> $GITHUB_OUTPUT
+          vendor/bin/pint >> $GITHUB_OUTPUT
           echo $delimiter >> $GITHUB_OUTPUT
-      - name: Check for fixed files
+      - name: Check for changed files
         run: echo "changed=$(git diff --quiet && echo false || echo true)" >> $GITHUB_ENV
       - name: Commit changes
-        if: ${{ env.changed == 'true' }}
+        if: env.changed == 'true'
         run: |
           git config --global user.name github-actions
           git config --global user.email github-actions[bot]@users.noreply.github.com
-          # awk trims leading and trailing whitespace from each line, sed removes the last two lines
-          git commit -a -m "Format" -m "$(echo '${{ steps.format.outputs.summary }})' | awk '{$1=$1};1' | sed '$d' | sed '$d')"
+          # Trim leading and trailing whitespace from each line
+          git commit -a -m "Format" -m "$(echo '${{ steps.format.outputs.summary }})' | awk '{$1=$1};1')"
           git push

composer.json

@@ -39,7 +39,7 @@
         "vlucas/phpdotenv": "^5.6"
     },
     "require-dev": {
-        "friendsofphp/php-cs-fixer": "^3.51",
+        "laravel/pint": "^1.16",
         "mockery/mockery": "^1.6",
         "phpunit/phpunit": "^11.0.6"
     },
@@ -59,9 +59,6 @@
     "bin": [
         "jigsaw"
     ],
-    "scripts": {
-        "format": "php-cs-fixer fix --verbose"
-    },
     "config": {
         "sort-packages": true,
         "optimize-autoloader": true

pint.json

@@ -0,0 +1,9 @@
+{
+    "preset": "laravel",
+    "rules": {
+        "concat_space": {
+            "spacing": "one"
+        },
+        "single_line_empty_body": true
+    }
+}

src/Bootstrap/HandleExceptions.php

@@ -84,11 +84,11 @@ public function bootstrap(Container $app): void
     /**
      * Report PHP deprecations, or convert PHP errors to ErrorException instances.
      *
-     * @param int    $level
-     * @param string $message
-     * @param string $file
-     * @param int    $line
-     * @param array  $context
+     * @param  int  $level
+     * @param  string  $message
+     * @param  string  $file
+     * @param  int  $line
+     * @param  array  $context
      *
      * @throws ErrorException
      */

src/Collection/Collection.php

@@ -10,6 +10,7 @@
 class Collection extends BaseCollection
 {
     public $settings;
+
     public $name;
 
     public static function withSettings(IterableObject $settings, $name)

src/Collection/CollectionPaginator.php

@@ -7,6 +7,7 @@
 class CollectionPaginator
 {
     private $outputPathResolver;
+
     private $prefix;
 
     public function __construct($outputPathResolver)

src/Collection/CollectionRemoteItem.php

@@ -8,7 +8,9 @@
 class CollectionRemoteItem
 {
     private $item;
+
     private $index;
+
     private $collectionName;
 
     public function __construct($item, $index = 0, $collectionName = null)

src/CollectionItemHandlers/BladeCollectionItemHandler.php

@@ -32,8 +32,5 @@ public function getItemVariables($file)
         );
     }
 
-    public function getItemContent($file)
-    {
-        return;
-    }
+    public function getItemContent($file) {}
 }

src/Console/BuildCommand.php

@@ -17,6 +17,7 @@
 class BuildCommand extends Command
 {
     private $app;
+
     private $consoleOutput;
 
     public function __construct(Container $app)

src/Console/Command.php

@@ -8,8 +8,10 @@
 
 abstract class Command extends SymfonyCommand
 {
-    protected InputInterface  $input;
+    protected InputInterface $input;
+
     protected OutputInterface $output;
+
     protected $console;
 
     public function execute(InputInterface $input, OutputInterface $output): int

src/Console/ConsoleOutput.php

@@ -7,6 +7,7 @@
 class ConsoleOutput extends SymfonyConsoleOutput
 {
     protected $progressBars;
+
     protected $sections;
 
     public function setup($verbosity)

src/Console/ConsoleSession.php

@@ -12,7 +12,9 @@
 class ConsoleSession
 {
     protected $input;
+
     protected $output;
+
     protected $question;
 
     public function __construct(InputInterface $input, OutputInterface $output, QuestionHelper $question)

src/Console/InitCommand.php

@@ -12,8 +12,11 @@
 class InitCommand extends Command
 {
     private $base;
+
     private $basicScaffold;
+
     private $files;
+
     private $presetScaffold;
 
     public function __construct(Filesystem $files, BasicScaffoldBuilder $basicScaffold, PresetScaffoldBuilder $presetScaffold)

src/Console/NullProgressBar.php

@@ -5,6 +5,7 @@
 class NullProgressBar
 {
     protected $consoleOutput;
+
     protected $message;
 
     public function __construct(ConsoleOutput $consoleOutput, $message = null, $section = null)

src/Console/ProgressBar.php

@@ -7,7 +7,9 @@
 class ProgressBar
 {
     protected $consoleOutput;
+
     protected $progressBar;
+
     protected $message;
 
     public function __construct(ConsoleOutput $consoleOutput, $message = null, $section = null)

src/Container.php

@@ -147,7 +147,7 @@ private function fireAppCallbacks(array &$callbacks): void
         while ($index < count($callbacks)) {
             $callbacks[$index]($this);
 
-            ++$index;
+            $index++;
         }
     }
 

src/Exceptions/Handler.php

@@ -40,7 +40,7 @@ public function render($request, Throwable $e): void
     }
 
     /**
-     * @param \Symfony\Component\Console\Output\OutputInterface $output
+     * @param  \Symfony\Component\Console\Output\OutputInterface  $output
      */
     public function renderForConsole($output, Throwable $e): void
     {

src/File/BladeDirectivesFile.php

@@ -7,6 +7,7 @@
 class BladeDirectivesFile
 {
     protected $bladeCompiler;
+
     protected $directives;
 
     public function __construct($file_path, BladeCompiler $bladeCompiler)

src/File/InputFile.php

@@ -8,9 +8,11 @@
 class InputFile
 {
     protected $file;
+
     protected $extraBladeExtensions = [
         'js', 'json', 'xml', 'yaml', 'yml', 'rss', 'atom', 'txt', 'text', 'html',
     ];
+
     protected $pageData;
 
     public function __construct($file)

src/File/OutputFile.php

@@ -7,12 +7,19 @@
 class OutputFile
 {
     private $inputFile;
+
     private $path;
+
     private $name;
+
     private $extension;
+
     private $contents;
+
     private $data;
+
     private $page;
+
     private $prefix;
 
     public function __construct(InputFile $inputFile, $path, $name, $extension, $contents, $data, $page = 1, $prefix = '')

src/File/TemporaryFilesystem.php

@@ -8,6 +8,7 @@
 class TemporaryFilesystem
 {
     private $tempPath;
+
     private $filesystem;
 
     public function __construct($tempPath, $filesystem = null)

src/Handlers/BladeHandler.php

@@ -12,8 +12,11 @@
 class BladeHandler
 {
     private $temporaryFilesystem;
+
     private $parser;
+
     private $view;
+
     private $hasFrontMatter;
 
     public function __construct(TemporaryFilesystem $temporaryFilesystem, FrontMatterParser $parser, ViewRenderer $viewRenderer)

src/Handlers/CollectionItemHandler.php

@@ -10,6 +10,7 @@
 class CollectionItemHandler
 {
     private $config;
+
     private $handlers;
 
     public function __construct(Collection $config, $handlers)

src/Handlers/MarkdownHandler.php

@@ -11,7 +11,9 @@
 class MarkdownHandler
 {
     private $temporaryFilesystem;
+
     private $parser;
+
     private $view;
 
     public function __construct(TemporaryFilesystem $temporaryFilesystem, FrontMatterParser $parser, ViewRenderer $viewRenderer)

src/Handlers/PaginatedPageHandler.php

@@ -13,8 +13,11 @@
 class PaginatedPageHandler
 {
     private $paginator;
+
     private $parser;
+
     private $temporaryFilesystem;
+
     private $view;
 
     public function __construct(

src/Jigsaw.php

@@ -13,14 +13,23 @@ class Jigsaw
     use Macroable;
 
     public $app;
+
     protected $env;
+
     protected $pageInfo;
+
     protected $outputPaths;
+
     protected $siteData;
+
     protected $dataLoader;
+
     protected $remoteItemLoader;
+
     protected $siteBuilder;
+
     protected $verbose;
+
     protected static $commands = [];
 
     public function __construct(

src/Loaders/CollectionDataLoader.php

@@ -16,11 +16,17 @@
 class CollectionDataLoader
 {
     private $filesystem;
+
     private $consoleOutput;
+
     private $pathResolver;
+
     private $handlers;
+
     private $source;
+
     private $pageSettings;
+
     private $collectionSettings;
 
     public function __construct(Filesystem $filesystem, ConsoleOutput $consoleOutput, $pathResolver, $handlers = [])