somework/composer-symlinks

Create relative symlinks based on getcwd() and relative data

ComposerSymlinks

Its provide a simple Composer script to symlink paths. Compatible with Composer v2., _(*1)

Installation

To install the latest stable version of this component, open a console and execute the following command:, _(*2)

$ composer require somework/composer-symlinks

Usage

1. Define symlinks

Create the symlinks definition adding a somework/composer-symlinks section inside the extra section of the composer.json file., _(*3)

The behaviour of the plugin can be tuned via the following configuration keys:, _(*4)

You can set personal configs for any symlink.
For personal configs link must be defined, _(*5)

{
    "extra": {
        "somework/composer-symlinks": {
            "symlinks": {
                "common/upload": "web/upload",
                "common/static/dest": {
                    "link": "web/dest",
                    "skip-missing-target": false,
                    "absolute-path": true,
                    "throw-exception": false
                }
            },
            "force-create": false,
            "skip-missing-target": false,
            "absolute-path": false,
            "throw-exception": true
        }
    }
}

3. Execute composer

DO NOT use --no-plugins for composer install or update, _(*6)

Dry run

Set environment variable SYMLINKS_DRY_RUN=1 to preview created links without modifying the filesystem., _(*7)

Example output:, _(*8)

$ SYMLINKS_DRY_RUN=1 composer install --no-interaction
  [DRY RUN] Symlinking /tmp/sample/linked.txt to /tmp/sample/source/file.txt

Typical error messages

Windows compatibility

On Windows, creating symlinks requires either Administrator privileges or that the system is running in Developer Mode. The plugin itself works, but the underlying operating system may refuse to create a link if permissions are insufficient. Additionally, relative symlinks use Unix-style / separators internally which Windows resolves correctly., _(*9)

License

This component is under the MIT license. See the complete license in the LICENSE file., _(*10)

Reporting an issue or a feature request

Issues and feature requests are tracked in the Github issue tracker., _(*11)