feat(chore): Adds download-docs command (#697)

Author: silasjoisten

.devcontainer/Dockerfile

@@ -4,8 +4,8 @@ ARG XDEBUG_MODE=coverage
 RUN apt update -y && apt install -y git composer php-cli php-dom php-curl php-xdebug vim
 WORKDIR /app
 RUN git config --global --add safe.directory /app && \
-    git config --global --add safe.directory /app/generator/doc/doc-en/en && \
-    git config --global --add safe.directory /app/generator/doc/doc-en/doc-base
-CMD cd /app/generator/doc && ./update.sh && \
-    cd /app && composer install && \
-    cd /app/generator && composer install && php ./safe.php generate
+    git config --global --add safe.directory /app/generator/docs
+CMD cd /app && composer install && \
+    cd /app/generator && composer install && \
+    php ./safe.php download-docs && \
+    php ./safe.php generate

.github/workflows/auto-regenerate.yml

@@ -22,14 +22,14 @@ jobs:
       - name: "Check out salathe/phpdoc-base"
         uses: "actions/checkout@v4"
         with:
-          path: "generator/doc/doc-en/doc-base"
+          path: "generator/docs/salathe/phpdoc-base"
           repository: "salathe/phpdoc-base"
           fetch-depth: 0
 
       - name: "Check out php/doc-en"
         uses: "actions/checkout@v4"
         with:
-          path: "generator/doc/doc-en/en"
+          path: "generator/docs"
           repository: "php/doc-en"
           fetch-depth: 0
 

.github/workflows/continuous-integration.yml

@@ -18,27 +18,31 @@ jobs:
     steps:
       - name: "Checkout"
         uses: "actions/checkout@v4"
+
       - name: "Get current date for the daily cache"
         id: "date"
         run: echo "date=$(date +'%Y-%m-%d')" >> $GITHUB_OUTPUT
+
       - name: "Cache the php documentation"
-        id: cache-php-doc
+        id: cache-php-docs
         uses: "actions/cache@v4"
         with:
-          path: "generator/doc/doc-en"
-          key: php-doc-${{ steps.date.outputs.date }}
+          path: "generator/docs"
+          key: php-docs-${{ steps.date.outputs.date }}
+
       - name: "Check out salathe/phpdoc-base"
         uses: "actions/checkout@v4"
-        if: steps.cache-php-doc.outputs.cache-hit != 'true'
+        if: steps.cache-php-docs.outputs.cache-hit != 'true'
         with:
-          path: "generator/doc/doc-en/doc-base"
+          path: "generator/docs/salathe/phpdoc-base"
           repository: "salathe/phpdoc-base"
           fetch-depth: 0
+
       - name: "Check out php/doc-en"
         uses: "actions/checkout@v4"
-        if: steps.cache-php-doc.outputs.cache-hit != 'true'
+        if: steps.cache-php-docs.outputs.cache-hit != 'true'
         with:
-          path: "generator/doc/doc-en/en"
+          path: "generator/docs/php/doc-en"
           repository: "php/doc-en"
           fetch-depth: 0
 
@@ -61,11 +65,11 @@ jobs:
           coverage: "pcov"
           php-version: "${{ matrix.php-version }}"
       - name: "Fetch cached docs"
-        id: cache-php-doc
+        id: cache-docs
         uses: "actions/cache@v4"
         with:
-          path: "generator/doc/doc-en"
-          key: php-doc-${{ needs.fetch_defs.outputs.date }}
+          path: "generator/docs"
+          key: php-docs-${{ needs.fetch_defs.outputs.date }}
           fail-on-cache-miss: true
       - name: "Cache dependencies installed with composer"
         uses: "actions/cache@v4"
@@ -140,11 +144,11 @@ jobs:
           coverage: "pcov"
           php-version: "8.4"
       - name: "Fetch cached docs"
-        id: cache-php-doc
+        id: cache-php-docs
         uses: "actions/cache@v4"
         with:
-          path: "generator/doc/doc-en"
-          key: php-doc-${{ needs.fetch_defs.outputs.date }}
+          path: "generator/docs"
+          key: php-docs-${{ needs.fetch_defs.outputs.date }}
           fail-on-cache-miss: true
       - name: "Cache dependencies installed with composer"
         uses: "actions/cache@v4"

.gitignore

@@ -7,3 +7,4 @@ vendor/
 /generator/tests/rector/composer.lock
 .phpunit.result.cache
 .phpunit.cache
+docs/

CONTRIBUTING.md

@@ -91,12 +91,10 @@ generator, as well as some handy shortcut shell scripts. You can use
 The first step is to download the PHP documentation project locally, using git.
 
 ```bash
-$ cd generator/doc
-$ sh update.sh
+$ generator/safe.php download-docs
 ```
 
-The script can be used to both install the doc and to update it.
-All it does is pull from theses mirrors:
+This will download the PHP documentation from the official repository.
 
 https://github.com/salathe/phpdoc-base
 

generator/composer.json

@@ -14,7 +14,8 @@
         "phpstan/phpstan": "^2",
         "symfony/console": "^7",
         "symfony/process": "^7",
-        "symfony/finder": "^7"
+        "symfony/finder": "^7",
+        "symfony/filesystem": "^7.2"
     },
     "require-dev": {
         "phpunit/phpunit": "^12",

generator/composer.lock

@@ -7,11 +7,13 @@
 use Safe\Commands\FunctionInfoCommand;
 use Safe\Commands\GenerateCommand;
 use Safe\Commands\ScanObjectsCommand;
+use Safe\Commands\DownloadDocsCommand;
 use Symfony\Component\Console\Application;
 
 $application = new Application();
 $application->addCommands([new GenerateCommand()]);
 $application->addCommands([new ScanObjectsCommand()]);
 $application->addCommands([new FunctionInfoCommand()]);
+$application->addCommands([new DownloadDocsCommand()]);
 
 $application->run();