如何在常规脚本中读取Composer的extra配置？

Great question! Yes, Composer absolutely supports reading the extra configuration from a vendor binary script without having to manually locate and parse composer.json yourself. You can leverage Composer's own internal API to access the project's configuration, just like you would in a Composer script.

Using Composer's API to Read Extra Config #

This is the recommended approach since it uses Composer's built-in logic to handle edge cases (like non-standard project root locations or merged configurations). Here's how to implement it:

First, ensure your script includes Composer's autoloader (since your binary is installed via Composer, this will be available relative to your script's location). Then use Composer's Factory class to create a Composer instance, which gives you access to the project's package and its extra data.

Example code:

<?php

// Adjust the path to autoload.php based on your binary's location (e.g., vendor/bin/your-script)
require __DIR__ . '/../vendor/autoload.php';

use Composer\Factory;
use Composer\IO\NullIO;

try {
    // Create a Composer instance using the current working directory
    $composer = Factory::create(new NullIO(), null, false);
    
    // Get the project's root package
    $rootPackage = $composer->getPackage();
    
    // Retrieve the full extra configuration array
    $extraConfig = $rootPackage->getExtra();
    
    // Access your custom config value (e.g., extra.config for a config file path)
    $userConfigPath = $extraConfig['config'] ?? null;
    
    if ($userConfigPath) {
        echo "Using config file: $userConfigPath\n";
    } else {
        echo "No config path specified in composer.json's extra section.\n";
    }
} catch (\Exception $e) {
    echo "Error accessing Composer configuration: " . $e->getMessage() . "\n";
}

Key Details: #

• Autoloader Path: If your binary lives in vendor/bin/, the autoloader will be at ../vendor/autoload.php. Adjust this path if your binary is placed elsewhere.
• NullIO: This class suppresses Composer's default output. If you want to handle user input/output (like asking for confirmation), use ConsoleIO instead (it relies on Symfony Console, which is already a Composer dependency).
• Error Handling: Factory::create() throws exceptions if it can't find a valid composer.json (e.g., if the script is run outside a Composer project). Catch these to handle such cases gracefully.

Alternative: Manually Locate and Parse composer.json #

If for some reason you want to avoid relying on Composer's internal classes (not recommended, as it's more error-prone), you can manually traverse up the directory tree to find composer.json and parse it:

<?php

function findComposerJson($startDir) {
    $currentDir = realpath($startDir);
    while ($currentDir !== '/' && !file_exists($currentDir . '/composer.json')) {
        $currentDir = dirname($currentDir);
    }
    return file_exists($currentDir . '/composer.json') ? $currentDir . '/composer.json' : null;
}

$composerJsonPath = findComposerJson(getcwd());

if ($composerJsonPath) {
    $composerConfig = json_decode(file_get_contents($composerJsonPath), true);
    $extraConfig = $composerConfig['extra'] ?? [];
    $userConfigPath = $extraConfig['config'] ?? null;
    
    // Use the config path as needed
} else {
    echo "Could not find composer.json in any parent directory.\n";
}

This method works but misses out on Composer's built-in logic for handling things like custom composer.json locations or merged configurations from other sources.

Best Practice #

Stick to using Composer's API for this task. It's maintained, handles edge cases automatically, and aligns with how Composer itself interacts with project configurations.

内容的提问来源于stack exchange，提问作者ext