Migrate lint setup to duster

.github/workflows/duster-lint.yml

@@ -0,0 +1,17 @@
+name: Duster Lint
+
+on:
+ push:
+ branches: [ main ]
+ pull_request:
+
+jobs:
+ duster:
+ runs-on: ubuntu-latest
+
+ steps:
+ - uses: actions/checkout@v3
+ - name: "Duster Lint"
+ uses: tighten/duster-action@v2
+ with:
+ args: lint

composer.json

@@ -1,7 +1,13 @@
 {
  "name": "tightenco/jigsaw",
  "description": "Simple static sites with Laravel's Blade.",
- "keywords": ["blade", "laravel", "static", "site", "generator"],
+ "keywords": [
+ "blade",
+ "laravel",
+ "static",
+ "site",
+ "generator"
+ ],
  "license": "MIT",
  "authors": [
  {
@@ -39,9 +45,9 @@
  "vlucas/phpdotenv": "^5.3.1"
  },
  "require-dev": {
- "friendsofphp/php-cs-fixer": "^3.17",
  "mockery/mockery": "^1.4",
- "phpunit/phpunit": "^9.3.3"
+ "phpunit/phpunit": "^9.3.3",
+ "tightenco/duster": "^2.5"
  },
  "autoload": {
  "psr-4": {
@@ -60,7 +66,7 @@
  "jigsaw"
  ],
  "scripts": {
- "format" : "php-cs-fixer fix --verbose"
+ "format": "./vendor/bin/duster fix"
  },
  "config": {
  "sort-packages": true,

duster.json

@@ -0,0 +1,3 @@
+{
+ "exclude": ["tests/snapshots", "src/**/helpers.php"]
+}

src/Bootstrap/HandleExceptions.php

@@ -43,11 +43,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

@@ -14,7 +14,7 @@ class Collection extends BaseCollection
 
  public static function withSettings(IterableObject $settings, $name)
  {
- $collection = new static();
+ $collection = new static;
  $collection->settings = $settings;
  $collection->name = $name;
 

src/Collection/CollectionItem.php

@@ -58,13 +58,13 @@ public function getContent()
  $this->_content;
  }
 
- public function __toString()
+ protected function missingHelperError($functionName)
  {
- return (string) $this->getContent();
+ return 'No function named "' . $functionName . '" for the collection "' . $this->_meta->collectionName . '" was found in the file "config.php".';
  }
 
- protected function missingHelperError($functionName)
+ public function __toString()
  {
- return 'No function named "' . $functionName . '" for the collection "' . $this->_meta->collectionName . '" was found in the file "config.php".';
+ return (string) $this->getContent();
  }
 }

src/CollectionItemHandlers/BladeCollectionItemHandler.php

@@ -34,6 +34,6 @@ public function getItemVariables($file)
 
  public function getItemContent($file)
  {
- return;
+
  }
 }

src/Console/BuildCommand.php

@@ -44,7 +44,7 @@ protected function fire()
  $cacheExists = $this->app[TemporaryFilesystem::class]->hasTempDirectory();
 
  if ($this->input->getOption('pretty') === 'true' && $this->app->config->get('pretty') !== false) {
- $this->app->instance('outputPathResolver', new PrettyOutputPathResolver());
+ $this->app->instance('outputPathResolver', new PrettyOutputPathResolver);
  }
 
  if ($this->input->getOption('quiet')) {

src/Console/ConsoleOutput.php

@@ -16,37 +16,6 @@ public function setup($verbosity)
  $this->setupProgressBars();
  }
 
- protected function setupSections()
- {
- $this->sections = collect([
- 'footer' => $this->section(),
- 'intro' => $this->section(),
- 'message' => $this->section(),
- 'progress' => $this->section(),
- 'header' => $this->section(),
- ])->map(function ($section) {
- return $this->section();
- });
-
- $this->sections['header']->writeln('');
- $this->sections['footer']->writeln('');
- }
-
- protected function setupProgressBars()
- {
- $this->progressBars = [
- 'collections' => $this->getProgressBar('Loading collections...'),
- 'build' => $this->getProgressBar('Building files from source...'),
- ];
- }
-
- protected function getProgressBar($message = null)
- {
- return $this->isVerbose() ?
- new ProgressBar($this, $message, $this->sections['progress']) :
- new NullProgressBar($this, $message, $this->sections['progress']);
- }
-
  public function progressBar($name)
  {
  return $this->progressBars[$name];
@@ -123,4 +92,35 @@ public function writeConclusion()
 
  return $this;
  }
+
+ protected function setupSections()
+ {
+ $this->sections = collect([
+ 'footer' => $this->section(),
+ 'intro' => $this->section(),
+ 'message' => $this->section(),
+ 'progress' => $this->section(),
+ 'header' => $this->section(),
+ ])->map(function ($section) {
+ return $this->section();
+ });
+
+ $this->sections['header']->writeln('');
+ $this->sections['footer']->writeln('');
+ }
+
+ protected function setupProgressBars()
+ {
+ $this->progressBars = [
+ 'collections' => $this->getProgressBar('Loading collections...'),
+ 'build' => $this->getProgressBar('Building files from source...'),
+ ];
+ }
+
+ protected function getProgressBar($message = null)
+ {
+ return $this->isVerbose() ?
+ new ProgressBar($this, $message, $this->sections['progress']) :
+ new NullProgressBar($this, $message, $this->sections['progress']);
+ }
 }

src/Container.php

@@ -139,15 +139,15 @@ private function boot(): void
  $this->fireAppCallbacks($this->bootedCallbacks);
  }
 
- /** @param callable[] $callbacks */
+ /** @param  callable[]  $callbacks */
  private function fireAppCallbacks(array &$callbacks): void
  {
  $index = 0;
 
  while ($index < count($callbacks)) {
  $callbacks[$index]($this);
 
- ++$index;
+ $index++;
  }
  }
 

src/Events/EventBus.php

@@ -28,21 +28,21 @@ public function __construct()
  $this->afterBuild = collect();
  }
 
- public function __call($event, $arguments)
- {
- if (isset($this->{$event})) {
- $this->{$event} = $this->{$event}->merge(Arr::wrap($arguments[0]));
- }
- }
-
  public function fire($event, Jigsaw $jigsaw)
  {
  $this->{$event}->each(function ($task) use ($jigsaw) {
  if (is_callable($task)) {
  $task($jigsaw);
  } else {
- (new $task())->handle($jigsaw);
+ (new $task)->handle($jigsaw);
  }
  });
  }
+
+ public function __call($event, $arguments)
+ {
+ if (isset($this->{$event})) {
+ $this->{$event} = $this->{$event}->merge(Arr::wrap($arguments[0]));
+ }
+ }
 }

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
  {
@@ -88,7 +88,7 @@ public function renderForConsole($output, Throwable $e): void
  $handler->handle();
  }
 
- public function map(Closure|string $from, Closure|string|null $to = null): static
+ public function map(Closure|string $from, Closure|string $to = null): static
  {
  if (is_string($to)) {
  $to = fn ($exception) => new $to('', 0, $exception);

src/File/TemporaryFilesystem.php

@@ -13,7 +13,7 @@ class TemporaryFilesystem
  public function __construct($tempPath, $filesystem = null)
  {
  $this->tempPath = $tempPath;
- $this->filesystem = $filesystem ?: new Filesystem();
+ $this->filesystem = $filesystem ?: new Filesystem;
  }
 
  public function buildTempPath($filename, $extension)

src/Handlers/CollectionItemHandler.php

@@ -24,23 +24,6 @@ public function shouldHandle($file)
  && ! Str::startsWith($file->getFilename(), ['.', '_']);
  }
 
- private function isInCollectionDirectory($file)
- {
- $base = $file->topLevelDirectory();
-
- return Str::startsWith($base, '_') && $this->hasCollectionNamed($this->getCollectionName($file));
- }
-
- private function hasCollectionNamed($candidate)
- {
- return Arr::get($this->config, 'collections.' . $candidate) !== null;
- }
-
- private function getCollectionName($file)
- {
- return substr($file->topLevelDirectory(), 1);
- }
-
  public function handle($file, $pageData)
  {
  $handler = $this->handlers->first(function ($handler) use ($file) {
@@ -70,4 +53,21 @@ public function handle($file, $pageData)
  ) : null;
  })->filter()->values();
  }
+
+ private function isInCollectionDirectory($file)
+ {
+ $base = $file->topLevelDirectory();
+
+ return Str::startsWith($base, '_') && $this->hasCollectionNamed($this->getCollectionName($file));
+ }
+
+ private function hasCollectionNamed($candidate)
+ {
+ return Arr::get($this->config, 'collections.' . $candidate) !== null;
+ }
+
+ private function getCollectionName($file)
+ {
+ return substr($file->topLevelDirectory(), 1);
+ }
 }