Helpers for a composer package.
Install Zerotoprod\PackageHelper
via Composer:
composer require zero-to-prod/package-helper
This will add the package to your project’s dependencies and create an autoloader entry for it.
You can publish this README to your local documentation directory.
This can be useful for providing documentation for AI agents.
This can be done using the included script:
# Publish to default location (./docs/zero-to-prod/package-helper/)
vendor/bin/zero-to-prod-package-helper
# Publish to custom directory
vendor/bin/zero-to-prod-package-helper /path/to/your/docs
You can automatically publish documentation by adding the following to your composer.json
:
{
"scripts": {
"post-install-cmd": [
"zero-to-prod-package-helper"
],
"post-update-cmd": [
"zero-to-prod-package-helper"
]
}
}
Publish files in your package directory (recursively) while rewriting namespaces.
use Zerotoprod\PackageHelper\PackageHelper;
PackageHelper::publish(
$from,
$to,
PackageHelper::determineNamespace($psr_4, $to),
static function (string $from, string $to) {
echo "Copied: $from to $to" . PHP_EOL;
}
);
Copy a single file and get the destination path:
use Zerotoprod\PackageHelper\PackageHelper;
$copied = PackageHelper::copy(__DIR__.'/stubs/example.txt');
echo $copied; // e.g., getcwd().'/example.txt'
// Or copy into a specific directory and observe the callback
$copied = PackageHelper::copy(
__DIR__.'/stubs/example.txt',
getcwd().'/output',
static function (string $from, string $to) {
echo "Copied $from -> $to" . PHP_EOL;
}
);
Integrate this into a composer package.
Update composer.json
:
{
"bin": [
"bin/package-file"
]
}
Create a new file: bin/package-file
#!/usr/bin/env php
<?php
require getcwd() . '/vendor/autoload.php';
use Zerotoprod\PackageHelper\PackageHelper;
if ($argc !== 2) {
die("Usage: <targetDir>\n");
}
$from = __DIR__ . '/../src';
if (!is_dir($from)) {
throw new RuntimeException("Source directory '$from' not found.");
}
$composer_json_file_path = getcwd() . '/composer.json';
if (!is_file($composer_json_file_path)) {
throw new RuntimeException("composer.json not found.");
}
$composer_json_data = json_decode(file_get_contents($composer_json_file_path), true);
$psr_4 = $composer_json_data['autoload']['psr-4'] ?? null;
if (!$psr_4) {
throw new RuntimeException('PSR-4 autoload section missing in composer.json.');
}
$to = rtrim($argv[1], '/');
PackageHelper::publish(
$from,
$to,
PackageHelper::determineNamespace($psr_4, $to),
static function(string $from, string $to){
echo "Copied: $from to $to" . PHP_EOL;
}
);
Contributions, issues, and feature requests are welcome! Feel free to check the issues page if you want to contribute.
git checkout -b feature-branch
).git commit -m 'Add some feature'
).git push origin feature-branch
).