Split dev server to separate package

jaapio · jaapio · commit e12615e9e848 · 2025-09-10T23:23:28.000+02:00
diff --git a/composer.json b/composer.json
@@ -39,6 +39,7 @@
         "ext-mbstring": "*",
         "cboden/ratchet": "0.4.x@dev",
         "doctrine/deprecations": "^1.1",
+        "phpdocumentor/dev-server": "^1.0 || ^1.0@dev",
         "phpdocumentor/filesystem": "^1.0 || ^1.0@dev",
         "phpdocumentor/flyfinder": "^1.1 || ^2.0",
         "phpdocumentor/guides": "^1.0 || ^1.0@dev",
diff --git a/composer.lock b/composer.lock
diff --git a/docs/contributions/monorepository-layout.rst b/docs/contributions/monorepository-layout.rst
@@ -25,3 +25,4 @@ Consequences:
   not in the component repositories.
 
 The components are located under the ``packages`` directory.
+
diff --git a/packages/dev-server/.gitattributes b/packages/dev-server/.gitattributes
@@ -0,0 +1,5 @@
+/.gitattributes export-ignore
+/docs export-ignore
+/tests export-ignore
+/.gitignore export-ignore
+.github export-ignore
diff --git a/packages/dev-server/.gitignore b/packages/dev-server/.gitignore
@@ -0,0 +1 @@
+vendor/*
diff --git a/packages/dev-server/CONTRIBUTING.rst b/packages/dev-server/CONTRIBUTING.rst
@@ -0,0 +1,23 @@
+======================================
+Contribute to the phpDocumentor Guides
+======================================
+
+Go to the mono-repository
+=========================
+
+This project is developed in the mono-repository `phpDocumentor Guides <https://github.com/phpDocumentor/guides>`__.
+The repository you are currently in gets auto-created by splitting the mono-repository. You **must not** contribute
+to this repository directly but always to the mono-repository linked above.
+
+Create Issues
+=============
+
+*   If you find something missing or something is wrong in this library, you are welcome to write an issue
+    describing the problem: `Issues on GitHub <https://github.com/phpDocumentor/guides/issues>`__.
+*   If you can, please try to fix the problem yourself.
+
+Make changes (create pull requests)
+===================================
+
+See the `Contribution chapter <https://docs.phpdoc.org/components/guides/guides/contributions/index.html>`__ in the
+`Documentation` <https://docs.phpdoc.org/components/guides/guides/index.html>`__.
diff --git a/packages/dev-server/LICENSE b/packages/dev-server/LICENSE
@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Jaap van Otterdijk
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
diff --git a/packages/dev-server/README.rst b/packages/dev-server/README.rst
@@ -0,0 +1,36 @@
+
+..  image:: https://poser.pugx.org/phpdocumentor/dev-server/require/php
+    :alt: PHP Version Require
+    :target: https://packagist.org/packages/phpdocumentor/dev-server
+
+..  image:: https://poser.pugx.org/phpdocumentor/dev-server/v/stable
+    :alt: Latest Stable Version
+    :target: https://packagist.org/packages/phpdocumentor/dev-server
+
+..  image:: https://poser.pugx.org/phpdocumentor/dev-server/v/unstable
+    :alt: Latest Unstable Version
+    :target: https://packagist.org/packages/phpdocumentor/dev-server
+
+..  image:: https://poser.pugx.org/phpdocumentor/dev-server/d/total
+    :alt: Total Downloads
+    :target: https://packagist.org/packages/phpdocumentor/dev-server
+
+..  image:: https://poser.pugx.org/phpdocumentor/dev-server/d/monthly
+    :alt: Monthly Downloads
+    :target: https://packagist.org/packages/phpdocumentor/dev-server
+
+====================
+phpDocumentor Guides
+====================
+
+This repository is part of `phpDocumentor's Guides library <https://github.com/phpDocumentor/guides>`__, a framework
+designed to take hand-written documentation in code repositories and create an AST (abstract syntax tree) from it.
+This AST is then fed to a renderer, which produces the desired output, such as HTML.
+
+The package `phpdocumentor/dev-server <https://packagist.org/packages/phpdocumentor/dev-server>`__ contains the
+application and Symfony Console Command used for standalone processing of documentation files.
+
+:Mono-Repository:   https://github.com/phpDocumentor/guides
+:Documentation:     https://docs.phpdoc.org/components/guides/guides/index.html
+:Packagist:         https://packagist.org/packages/phpdocumentor/dev-server
+:Contribution:      https://github.com/phpDocumentor/guides/tree/main/CONTRIBUTING.rst
diff --git a/packages/dev-server/composer.json b/packages/dev-server/composer.json
@@ -0,0 +1,47 @@
+{
+    "name": "phpdocumentor/dev-server",
+    "description": "A php development server with live reloading to preview your documentation",
+    "type": "project",
+    "license": "MIT",
+    "config": {
+        "sort-packages": true
+    },
+    "autoload": {
+        "psr-4": {
+            "phpDocumentor\\DevServer\\": "src/"
+        }
+    },
+    "autoload-dev": {
+        "psr-4": {
+            "phpDocumentor\\DevServer\\": [
+                "tests/unit/"
+            ]
+        }
+    },
+    "authors": [
+        {
+            "name": "jaapio",
+            "email": "jaap@phpdoc.org"
+        }
+    ],
+    "require": {
+        "php": "^8.1",
+        "ext-inotify": "*",
+        "ext-pcntl": "*",
+        "monolog/monolog": "^3.0",
+        "phpdocumentor/guides": "^1.0",
+        "symfony/config": "^5.4 || ^6.3 || ^7.0",
+        "symfony/console": "^5.4 || ^6.3 || ^7.0",
+        "symfony/dependency-injection": "^5.4 || ^6.3 || ^7.0",
+        "symfony/event-dispatcher": "^5.4 || ^6.3 || ^7.0",
+        "cboden/ratchet": "0.4.x@dev",
+        "react/http": "^v1.11",
+        "react/socket": "^v1.16",
+        "league/mime-type-detection": "^1.16"
+    },
+    "extra": {
+        "branch-alias": {
+            "dev-main": "1.x-dev"
+        }
+    }
+}
diff --git a/packages/dev-server/src/Internal/HttpHandler.php b/packages/dev-server/src/Internal/HttpHandler.php
@@ -11,7 +11,7 @@
  * @link https://phpdoc.org
  */
 
-namespace phpDocumentor\Guides\Cli\Internal;
+namespace phpDocumentor\DevServer\Internal;
 
 use GuzzleHttp\Psr7\Message;
 use GuzzleHttp\Psr7\Response;
diff --git a/packages/dev-server/src/Internal/WebSocketHandler.php b/packages/dev-server/src/Internal/WebSocketHandler.php
@@ -11,7 +11,7 @@
  * @link https://phpdoc.org
  */
 
-namespace phpDocumentor\Guides\Cli\Internal;
+namespace phpDocumentor\DevServer\Internal;
 
 use Psr\Log\LoggerInterface;
 use Ratchet\ConnectionInterface;
diff --git a/packages/dev-server/src/Server.php b/packages/dev-server/src/Server.php
@@ -11,10 +11,11 @@
  * @link https://phpdoc.org
  */
 
-namespace phpDocumentor\Guides\Cli\Internal;
+namespace phpDocumentor\DevServer;
 
 use Closure;
-use phpDocumentor\Guides\Cli\Internal\Watcher\INotifyWatcher;
+use phpDocumentor\DevServer\Internal\WebSocketHandler;
+use phpDocumentor\DevServer\Watcher\INotifyWatcher;
 use Psr\Log\LoggerInterface;
 use Ratchet\App;
 use React\EventLoop\Loop;
diff --git a/packages/dev-server/src/ServerFactory.php b/packages/dev-server/src/ServerFactory.php
@@ -11,19 +11,21 @@
  * @link https://phpdoc.org
  */
 
-namespace phpDocumentor\Guides\Cli\Internal;
+namespace phpDocumentor\DevServer;
 
+use phpDocumentor\DevServer\Internal\HttpHandler;
+use phpDocumentor\DevServer\Internal\WebSocketHandler;
 use phpDocumentor\FileSystem\FlySystemAdapter;
 use Psr\Log\LoggerInterface;
 use Ratchet\App;
+use Symfony\Component\EventDispatcher\EventDispatcher;
 use Symfony\Component\Routing\Route;
-use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;
 
 final class ServerFactory
 {
     public function __construct(
         private LoggerInterface $logger,
-        private EventDispatcherInterface $eventDispatcher,
+        private readonly EventDispatcher $eventDispatcher,
     ) {
     }
 
diff --git a/packages/dev-server/src/Watcher/FileModifiedEvent.php b/packages/dev-server/src/Watcher/FileModifiedEvent.php
@@ -11,7 +11,7 @@
  * @link https://phpdoc.org
  */
 
-namespace phpDocumentor\Guides\Cli\Internal\Watcher;
+namespace phpDocumentor\DevServer\Watcher;
 
 final class FileModifiedEvent
 {
diff --git a/packages/dev-server/src/Watcher/INotifyWatcher.php b/packages/dev-server/src/Watcher/INotifyWatcher.php
@@ -11,7 +11,7 @@
  * @link https://phpdoc.org
  */
 
-namespace phpDocumentor\Guides\Cli\Internal\Watcher;
+namespace phpDocumentor\DevServer\Watcher;
 
 use Psr\EventDispatcher\EventDispatcherInterface;
 use React\EventLoop\LoopInterface;
diff --git a/packages/guides-cli/composer.json b/packages/guides-cli/composer.json
@@ -32,11 +32,10 @@
         "symfony/config": "^5.4 || ^6.3 || ^7.0",
         "symfony/console": "^5.4 || ^6.3 || ^7.0",
         "symfony/dependency-injection": "^5.4 || ^6.3 || ^7.0",
-        "symfony/event-dispatcher": "^5.4 || ^6.3 || ^7.0",
-        "cboden/ratchet": "0.4.x@dev",
-        "react/http": "^v1.11",
-        "react/socket": "^v1.16",
-        "league/mime-type-detection": "^1.16"
+        "symfony/event-dispatcher": "^5.4 || ^6.3 || ^7.0"
+    },
+    "suggest": {
+        "phpdocumentor/dev-server": "Allows you to run a development server with live reloading to preview your documentation"
     },
     "bin": [
         "bin/guides"
diff --git a/packages/guides-cli/resources/config/services.php b/packages/guides-cli/resources/config/services.php
@@ -3,6 +3,7 @@
 declare(strict_types=1);
 
 use Monolog\Logger;
+use phpDocumentor\DevServer\ServerFactory;
 use phpDocumentor\Guides\Cli\Application;
 use phpDocumentor\Guides\Cli\Command\ProgressBarSubscriber;
 use phpDocumentor\Guides\Cli\Command\Run;
@@ -11,7 +12,6 @@
 use phpDocumentor\Guides\Cli\Command\WorkingDirectorySwitcher;
 use phpDocumentor\Guides\Cli\Internal\RunCommand;
 use phpDocumentor\Guides\Cli\Internal\RunCommandHandler;
-use phpDocumentor\Guides\Cli\Internal\ServerFactory;
 use Psr\Clock\ClockInterface;
 use Psr\EventDispatcher\EventDispatcherInterface;
 use Psr\Log\LoggerInterface;
@@ -31,10 +31,6 @@
         ->public()
         ->tag('phpdoc.guides.cli.command')
 
-        ->set(Serve::class)
-        ->public()
-        ->tag('phpdoc.guides.cli.command')
-
         ->set(NativeClock::class)
         ->alias(ClockInterface::class, NativeClock::class)
 
@@ -56,6 +52,12 @@
         ->set(ProgressBarSubscriber::class)
         ->set(SettingsBuilder::class)
         ->set(RunCommandHandler::class)
-        ->tag('phpdoc.guides.command', ['command' => RunCommand::class])
-        ->set(ServerFactory::class);
+        ->tag('phpdoc.guides.command', ['command' => RunCommand::class]);
+
+    if (class_exists(ServerFactory::class)) {
+        $container->services()->defaults()->autowire()->set(ServerFactory::class)
+            ->set(Serve::class)
+            ->public()
+            ->tag('phpdoc.guides.cli.command');
+    }
 };
diff --git a/packages/guides-cli/src/Command/Serve.php b/packages/guides-cli/src/Command/Serve.php

Original file line number	Diff line number	Diff line change
`@@ -25,3 +25,4 @@ Consequences:`
`25`	`25`	`not in the component repositories.`
`26`	`26`
`27`	`27`	The components are located under the ``packages`` directory.
	`28`	`+`