techcoil/composer-plugin-local-repo

A composer plugin to install packages from a local directory with ease

0.0.2 2023-01-10 16:37 UTC

Requires

• php: ^7.4|^8.0
• composer-plugin-api: ^2.0

Requires (Dev)

• composer/composer: ^2.0
• phpunit/phpunit: ^9.5

MIT

• plugin
• composer
• repository
• local

README

Composer plugin to help treating local repositories as packages.
Make use of composer's path repository behind the scenes.

Installation

Add the following to your composer.json file:

Install the plugin with

$ composer require techcoil/composer-plugin-local-repo

{
    "require": {
        "techcoil/composer-plugin-local-repo": "*"
    },
    ...
    "config": {
      ...
      "allow-plugins": {
        "techcoil/composer-plugin-local-repo": true
      }
    }
}

Config

Config overrides should be placed inside extra.local-repo in your composer.json file.

Key	Description	Default
paths	An array of paths to search for packages.	["src"]
depth	The depth of folders to search for packages.	1
symlink	Whether to symlink the packages or copy them. See https://getcomposer.org/doc/05-repositories.md#path	true
ignore	An array of folder patterns to ignore.	[]

Example

// composer.json
{
     ...
     "extra": {
          "local-repo": {
                "paths": ["src", "packages"],
                "depth": 2,
                "symlink": false,
                "ignore": ["*_test", "**/test/*"]
          }
     }
}