Add function to keep the stub files for the console

Author: ahamed

.github/workflows/tests.yml

@@ -70,3 +70,8 @@ jobs:
           grep -rq 'function Themeum\\Framework\\app' libraries/themeum/framework/Facade.php
           grep -q 'use Carbon\\Carbon as BaseCarbon' libraries/themeum/framework/Supports/Carbon.php
           ! grep -rq 'Themeum\\Carbon\\' libraries/themeum/framework/
+
+      - name: Verify console stubs are present and prefixed
+        run: |
+          test -f libraries/themeum/framework/Console/stubs/provider.stub
+          grep -q 'use Themeum\\Framework\\ServiceProvider' libraries/themeum/framework/Console/stubs/provider.stub

README.md

@@ -75,7 +75,7 @@ return [
             ->files()
             ->in(__DIR__ . '/vendor/themeum/framework/src')
             ->exclude(['test', 'tests', 'Tests'])
-            ->name('*.php'),
+            ->name(['*.php', '*.stub']),
     ],
     'exclude-files' => [],
     'exclude-namespaces' => [
@@ -90,6 +90,8 @@ return [
 
 PHP-Scoper rewrites `Framework\` to `Kirki\Framework\` and writes the result to `libraries/kirki/framework/`. The `exclude-namespaces` regex keeps every namespace except `Framework\` unprefixed (Composer vendor code stays on its original PSR-4 paths).
 
+WP-CLI generator stubs live under `src/Console/stubs/` as `*.stub` files. Include them in the finder (`->name(['*.php', '*.stub'])`) so they are copied into the scoped tree. Stub templates use placeholders such as `{{namespace}}`, which PHP-Scoper cannot parse; after scoping, run `scripts/prefix-scoped-console-stubs.php` on `libraries/<vendor>/framework/Console/stubs` with your prefix (the example plugin does this via `scripts/post-scope-console-stubs.php` in its `scope` Composer script).
+
 ### 3. Autoload the scoped copy only
 
 ```json

example/composer.json

@@ -37,7 +37,8 @@
     },
     "scripts": {
         "scope": [
-            "@php vendor/bin/php-scoper add-prefix --config=scoper.config.php --force"
+            "@php vendor/bin/php-scoper add-prefix --config=scoper.config.php --force",
+            "@php scripts/post-scope-console-stubs.php"
         ]
     },
     "minimum-stability": "dev",

example/scoper.config.php

@@ -12,7 +12,7 @@
             ->files()
             ->in(__DIR__ . '/vendor/themeum/framework/src')
             ->exclude(['test', 'tests', 'Tests'])
-            ->name('*.php')
+            ->name(['*.php', '*.stub'])
     ],
     'exclude-files' => [],
 

example/scripts/post-scope-console-stubs.php

@@ -0,0 +1,36 @@
+<?php
+
+declare(strict_types=1);
+
+$plugin_root = dirname(__DIR__);
+$stubs_dir = $plugin_root . '/libraries/themeum/framework/Console/stubs';
+$prefix = $argv[1] ?? 'Themeum';
+
+$candidates = [
+    '/var/www/html/framework-library/scripts/prefix-scoped-console-stubs.php',
+    dirname(__DIR__, 2) . '/scripts/prefix-scoped-console-stubs.php',
+];
+
+$prefix_script = null;
+
+foreach ($candidates as $candidate) {
+    if (is_file($candidate)) {
+        $prefix_script = $candidate;
+        break;
+    }
+}
+
+if ($prefix_script === null) {
+    fwrite(STDERR, "Could not find prefix-scoped-console-stubs.php.\n");
+    exit(1);
+}
+
+$command = sprintf(
+    'php %s %s %s',
+    escapeshellarg($prefix_script),
+    escapeshellarg($stubs_dir),
+    escapeshellarg($prefix)
+);
+
+passthru($command, $exit_code);
+exit((int) $exit_code);

scripts/prefix-scoped-console-stubs.php

@@ -0,0 +1,43 @@
+<?php
+
+declare(strict_types=1);
+
+$stubs_dir = $argv[1] ?? null;
+$prefix = $argv[2] ?? 'Themeum';
+
+if ($stubs_dir === null || $stubs_dir === '') {
+    fwrite(STDERR, "Usage: php prefix-scoped-console-stubs.php <stubs-dir> [prefix]\n");
+    exit(1);
+}
+
+if (!is_dir($stubs_dir)) {
+    exit(0);
+}
+
+$prefixed_framework = $prefix . '\\Framework\\';
+$pattern = '/(?<!' . preg_quote($prefix, '/') . '\\\\)Framework\\\\/';
+
+$iterator = new RecursiveIteratorIterator(
+    new RecursiveDirectoryIterator($stubs_dir, FilesystemIterator::SKIP_DOTS)
+);
+
+foreach ($iterator as $file) {
+    if (!$file->isFile() || $file->getExtension() !== 'stub') {
+        continue;
+    }
+
+    $path = $file->getPathname();
+    $contents = file_get_contents($path);
+
+    if ($contents === false) {
+        continue;
+    }
+
+    $updated = preg_replace($pattern, $prefixed_framework, $contents);
+
+    if (!is_string($updated) || $updated === $contents) {
+        continue;
+    }
+
+    file_put_contents($path, $updated);
+}