far-blue/dev-linker

There is no license information available for the latest version (1.0) of this package.

A composer plugin to link local working copies of packages

Installs: 26 609

Dependents: 0

Suggesters: 0

Security: 0

Stars: 0

Watchers: 2

Forks: 6

Open Issues: 0

Type:composer-plugin

1.0 2015-08-06 15:14 UTC

This package is auto-updated.

Last update: 2024-10-29 03:48:21 UTC


README

A Composer plugin to link local working copies of packages into a project.

This plugin allows you to override a package definition in composer.json to symlink to a local working copy so you can work on both a project and the packages needed by the project in parallel.

Providence

This plugin was heavily inspired by the piwi/composer-symlinker plugin. Compared to the composer-symlinker plugin, this plugin:

  • Does not try to scan local directories for packages
  • Does not maintain a distinction between symlinks it manages and others you may have created by hand
  • Fixes a number of bugs
  • Handled a number of edge cases the original plugin does not cope with

Usage

To use it, just add it as a dependency in your composer.json:

"require": {
	"far-blue/dev-linker": "dev-master"
}

"extra": {
	"dev-linker": {
		"local-packages": {
			"vendor/package1": "/path/to/working/copy",
			"vendor/package2": "/path/to/working/copy"
		}
	}
}

The packages being overridden must be valid (i.e. they would still work if you didn't override them).

Note that Composer will only recalculate dependencies when a require or require-dev entry changes. If you wish to switch between a normal package and an overridden package or back again you do need to change the require or require-dev entry for the package before Composer will re-calculate details for it.