opb/dev-symlinks

Package to change symlink to true or false depending on env

v0.1 2025-03-17 11:42 UTC

Requires

• composer-plugin-api: ^2.0
• composer/composer: ^2.0

MIT

README

Add the following to the extras section of your project's composer.json:

    "extra": {
        "dev-symlink-envs": [
            "dev",
            "development"
        ]
    }

The extras section itself is included for clarity.

This will go through any configured repositories in your composer.json of type path and if the current environment, as defined by the APP_ENV environment variable, is in the list defined, then the composer config will be change to "symlink": true.

For example:

{
    "repositories": [
        {
            "type": "path",
            "url": "../path/to/local/package",
            "options": {
                "symlink": false
            }
        }
    ],
    "require": {
        "vendor/package": "*"
    },
    "extra": {
        "dev-symlink-envs": [
            "dev",
            "development"
        ]
    }
}

In this case, whenever APP_ENV is either dev or development then the symlink option for the local package will be set to true.