Merge pull request #1242 from phpDocumentor/feature/change-serve

Initial setup for file serve

Author: jaapio

.github/workflows/documentation.yml

@@ -30,6 +30,7 @@ jobs:
         with:
           coverage: "none"
           php-version: "8.2"
+          extensions: "inotify, pcntl"
 
       - name: "Set COMPOSER_ROOT_VERSION"
         run: |

.github/workflows/integrate.yaml

@@ -17,7 +17,7 @@ jobs:
     uses: "phpDocumentor/.github/.github/workflows/code-coverage.yml@v0.8"
     with:
       php-version: "8.2"
-      php-extensions: "none, ctype, dom, json, mbstring, phar, simplexml, tokenizer, xml, xmlwriter, fileinfo, iconv"
+      php-extensions: "none, ctype, dom, json, mbstring, phar, simplexml, tokenizer, xml, xmlwriter, fileinfo, iconv, inotify"
 
   coding-standards:
     name: "Coding Standards"
@@ -30,7 +30,7 @@ jobs:
         uses: "shivammathur/setup-php@v2"
         with:
           coverage: "none"
-          extensions: "none, ctype, dom, json, mbstring, phar, simplexml, tokenizer, xml, xmlwriter, fileinfo, iconv"
+          extensions: "none, ctype, dom, json, mbstring, phar, simplexml, tokenizer, xml, xmlwriter, fileinfo, iconv, inotify"
           php-version: "8.2"
           tools: "cs2pr"
 
@@ -47,15 +47,15 @@ jobs:
     uses: "phpDocumentor/.github/.github/workflows/lint.yml@main"
     with:
       composer-options: "--no-check-publish --ansi"
-      php-extensions: "none, ctype, dom, json, mbstring, phar, simplexml, tokenizer, xml, xmlwriter, fileinfo, iconv"
+      php-extensions: "none, ctype, dom, json, mbstring, phar, simplexml, tokenizer, xml, xmlwriter, fileinfo, iconv, inotify"
       php-version: "8.2"
 
   static-analysis:
     name: "Static analysis"
     uses: "phpDocumentor/.github/.github/workflows/static-analysis.yml@v0.8"
     with:
       php-version: "8.2"
-      php-extensions: "none, ctype, dom, json, mbstring, phar, simplexml, tokenizer, xml, xmlwriter, fileinfo, iconv"
+      php-extensions: "none, ctype, dom, json, mbstring, phar, simplexml, tokenizer, xml, xmlwriter, fileinfo, iconv, inotify"
       composer-root-version: "1.x-dev"
 
   architecture:
@@ -68,7 +68,7 @@ jobs:
         with:
           coverage: "none"
           php-version: "8.2"
-          extensions: "none, ctype, dom, json, mbstring, phar, simplexml, tokenizer, xml, xmlwriter, fileinfo, iconv"
+          extensions: "none, ctype, dom, json, mbstring, phar, simplexml, tokenizer, xml, xmlwriter, fileinfo, iconv, inotify"
 
       - name: "Install dependencies with Composer"
         uses: "ramsey/composer-install@v3"
@@ -84,15 +84,15 @@ jobs:
     uses: "phpDocumentor/.github/.github/workflows/continuous-integration.yml@v0.8"
     with:
       composer-root-version: "1.x-dev"
-      php-extensions: "none, ctype, dom, json, mbstring, phar, simplexml, tokenizer, xml, xmlwriter, fileinfo, iconv"
+      php-extensions: "none, ctype, dom, json, mbstring, phar, simplexml, tokenizer, xml, xmlwriter, fileinfo, iconv, inotify"
 
   functional-tests:
     name: "Functional test"
     uses: "phpDocumentor/.github/.github/workflows/continuous-integration.yml@v0.8"
     needs: "unit-tests"
     with:
       test-suite: "functional"
-      php-extensions: "none, ctype, dom, json, mbstring, phar, simplexml, tokenizer, xml, xmlwriter, fileinfo, iconv"
+      php-extensions: "none, ctype, dom, json, mbstring, phar, simplexml, tokenizer, xml, xmlwriter, fileinfo, iconv, inotify"
       composer-root-version: "1.x-dev"
 
   integration-tests:
@@ -101,7 +101,7 @@ jobs:
     needs: "unit-tests"
     with:
       test-suite: "integration"
-      php-extensions: "none, ctype, dom, json, mbstring, phar, simplexml, tokenizer, xml, xmlwriter, fileinfo, iconv"
+      php-extensions: "none, ctype, dom, json, mbstring, phar, simplexml, tokenizer, xml, xmlwriter, fileinfo, iconv, inotify"
       composer-root-version: "1.x-dev"
 
   xml-lint:

Makefile

@@ -1,4 +1,4 @@
-PHP_BIN = docker run -it --rm --user $$(id -u):$$(id -g) -v${PWD}:/opt/project -w /opt/project php:8.2-cli php -d memory_limit=1024M
+PHP_BIN = docker run -it --rm --user $$(id -u):$$(id -g) -v${PWD}:/opt/project -w /opt/project php:8.4-cli php -d memory_limit=1024M
 PHP_DOC = docker run --rm -v ${PWD}:/data -w /data phpdoc/phpdoc:3-unstable
 
 .PHONY: help

app/Dockerfile

@@ -0,0 +1,10 @@
+FROM php:8.4-cli
+
+COPY --from=ghcr.io/php/pie:bin /pie /usr/bin/pie
+
+RUN apt update && apt install -y git
+
+RUN docker-php-ext-configure pcntl --enable-pcntl \
+  && docker-php-ext-install pcntl \
+  && pie install arnaud-lb/inotify
+

composer.json

@@ -21,6 +21,7 @@
     },
     "autoload-dev": {
         "psr-4": {
+            "phpDocumentor\\DevServer\\": ["packages/dev-server/tests/unit/"],
             "phpDocumentor\\Guides\\": ["packages/guides/tests/unit/", "tests/"],
             "phpDocumentor\\Guides\\Cli\\": "packages/guides-cli/tests/unit",
             "phpDocumentor\\Guides\\Code\\": "packages/guides-code/tests/unit",
@@ -37,7 +38,9 @@
         "ext-iconv": "*",
         "ext-json": "*",
         "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",
@@ -64,6 +67,7 @@
         "phpstan/extension-installer": "^1.4",
         "phpstan/phpstan": "^1.12",
         "phpstan/phpstan-strict-rules": "^1.6",
+        "phpstan/phpstan-symfony": "^1.4",
         "phpstan/phpstan-webmozart-assert": "^1.2",
         "phpunit/phpunit": "^10.5",
         "qossmic/deptrac-shim": "^1.0.2",