feat(http)!: add --crawl flag to static:generate command (#1656)

Author: brendt

docs/2-features/13-static-pages.md

@@ -111,6 +111,20 @@ The only thing left to do is to generate the static pages:
 <comment>…</comment>
 ```
 
+## Crawling for dead links
+
+Optionally, you can instruct the static generate to crawl your pages to scan for dead links. This is done by passing the `--crawl` option to the `static:generate` command:
+
+```console
+<dim>./tempest static:generate --crawl</dim>
+```
+
+By default, the crawler will only check for internal dead links. If you want to check for external links as well, you can pass the `--external` option:
+
+```console
+<dim>./tempest static:generate --crawl --external</dim>
+```
+
 ## Production
 
 Static pages are generated in the `/public` directory, as `index.html` files. Most web servers will automatically serve these static pages for you without any additional setup.

packages/router/src/Static/StaticGenerateCommand.php

@@ -60,8 +60,10 @@ public function __construct(
     #[ConsoleCommand(name: 'static:generate', description: 'Compiles static pages')]
     public function __invoke(
         ?string $filter = null,
-        bool $allowDeadLinks = false,
-        bool $allowExternalDeadLinks = true,
+        #[ConsoleArgument(description: 'Crawl the site for dead links')]
+        bool $crawl = false,
+        #[ConsoleArgument(description: 'Crawl external links, only works when the --crawl flag is set')]
+        bool $external = false,
         #[ConsoleArgument(aliases: ['v'])]
         bool $verbose = false,
     ): ExitCode {
@@ -150,9 +152,13 @@ public function __invoke(
                         mkdir($directory->toString(), recursive: true);
                     }
 
-                    if (! $allowDeadLinks && count($links = $this->detectDeadLinks($uri, $content, checkExternal: ! $allowExternalDeadLinks)) > 0) {
-                        $deadlinks[$uri] = $links;
-                        throw new DeadLinksDetectedException($uri, $links);
+                    if ($crawl) {
+                        $deadLinks = $this->detectDeadLinks($uri, $content, checkExternal: $external);
+
+                        if ($deadLinks !== []) {
+                            $deadlinks[$uri] = $deadLinks;
+                            throw new DeadLinksDetectedException($uri, $deadLinks);
+                        }
                     }
 
                     Filesystem\write_file($file->toString(), $content);
@@ -184,8 +190,8 @@ public function __invoke(
         if ($deadlinks) {
             $this->console->header('Dead links');
 
-            foreach ($deadlinks as $uri => $links) {
-                foreach ($links as $link) {
+            foreach ($deadlinks as $uri => $deadLinks) {
+                foreach ($deadLinks as $link) {
                     $this->keyValue("<style='fg-gray'>{$uri}</style>", "<style='fg-red'>{$link}</style>");
                 }
             }

tests/Integration/Http/Static/StaticGenerateCommandTest.php

@@ -97,7 +97,7 @@ public function test_dead_link(): void
         $this->container->config(new AppConfig(baseUri: 'https://test.com'));
 
         $this->console
-            ->call(StaticGenerateCommand::class)
+            ->call(StaticGenerateCommand::class, ['--crawl' => true])
             ->assertSee('1 DEAD LINK')
             ->assertSee('https://test.com/404')
             ->assertExitCode(ExitCode::ERROR);
@@ -112,7 +112,7 @@ public function test_dead_link_with_redirect(): void
         $this->container->config(new AppConfig(baseUri: 'https://test.com'));
 
         $this->console
-            ->call(StaticGenerateCommand::class, ['--allow-external-dead-links' => false])
+            ->call(StaticGenerateCommand::class, ['--crawl' => true])
             ->assertExitCode(ExitCode::SUCCESS);
     }
 
@@ -124,7 +124,7 @@ public function test_allow_dead_links(): void
         $this->container->config(new AppConfig(baseUri: 'https://test.com'));
 
         $this->console
-            ->call(StaticGenerateCommand::class, ['--allow-dead-links' => true])
+            ->call(StaticGenerateCommand::class, ['--crawl' => false])
             ->assertExitCode(ExitCode::SUCCESS);
     }
 
@@ -136,7 +136,7 @@ public function test_external_dead_links(): void
         $this->container->config(new AppConfig(baseUri: 'https://test.com'));
 
         $this->console
-            ->call(StaticGenerateCommand::class, ['--allow-external-dead-links' => false])
+            ->call(StaticGenerateCommand::class, ['--crawl' => true, '--external' => true])
             ->assertSee('2 DEAD LINKS')
             ->assertSee('https://test.com/404')
             ->assertSee('https://google.com/404')