kporras07 / composer-symlinks

Create symlinks using composer. Strongly inspired by https://github.com/vaniocz/symlink-handler

Symlink Handler

Composer script handling creation of symlinks inside your composer project.

Note: Symlinks will become files copy when composer is run with --no-dev

Installation

Installation can be done as usually using composer. composer require kporras07/composer-symlinks

Usage

Add the following in your root composer.json file:

"require": {
    "kporras07/composer-symlinks": "dev-master"
},
"scripts": {
    "post-install-cmd": [
        "Kporras07\\ComposerSymlinks\\ScriptHandler::createSymlinks"
    ],
    "post-update-cmd": [
        "Kporras07\\ComposerSymlinks\\ScriptHandler::createSymlinks"
    ]
},
"extra": {
    "symlinks": {
        "components": "web/components"
    }
}

After running either composer install or composer update, components folder will be accessible from your web folder web/components/.

But of course, you have to be careful when making symlinks to a folder which is publicly accessible.

composer-symlinks's Issues

Could not find a version of package

after composer require kporras07/composer-symlinks
[InvalidArgumentException]
Could not find a version of package kporras07/composer-symlinks matching your minimum-stability (stable). Require it with an explicit version constraint allowing its desired stability.

Use filesystem symlink method

In order to support cross-compatibility, replace exec of ln with https://symfony.com/doc/current/components/filesystem.html#symlink.

Does not always copy files when using --no-dev

When doing a composer install --no-dev it properly creates the destination directory and copies the files the FIRST time. But once the destination already existss it does not perform the copy again, so any new files added to the source never appear in the destination.

Allow multiple symlinks to same source

In order to support creation of multiple symlinks pointing to the same source, add an option to supply an array as destination.