onspli/composer-inject-repositories

Plugin loads repository definitions from external files and injects them to composer.json.

v0.1.0 2024-04-20 10:29 UTC

Requires

• composer-plugin-api: ^2.0

Requires (Dev)

• composer/composer: ^2.0

MIT

• Ondřej Šplíchal

README

This Composer plugin allows loading repository definitions from external files and injecting them to composer.json. Files with additional repositories can be stored locally or fetched from remote locations (http, git).

Usage

You have several composer packages stored in private Github repositories (and thus not available on public packagist.org repository), and you want to use the packages in several composer projects.

Install plugin globally.

composer global require onspli/composer-inject-repositories

Create file repos.json listing all the repositories you want to use (as described on https://getcomposer.org/doc/05-repositories.md)

{
    "repositories": [
        {
            "type": "git",
            "url": "[e-mail]:onspli/private-package-1.git"
        },
        {
            "type": "git",
            "url": "[e-mail]:onspli/private-package-2.git"
        },
        {
            "type": "git",
            "url": "[e-mail]:onspli/private-package-3.git"
        }
    ]
}

Add extra option inject-repositories to composer.json of your project.

{
    "name": "onspli/project-using-private-repos",
    "type": "project",
    "extra": {
        "inject-repositories": [
            {
                "type": "local",
                "path": "/path/to/repos.json"
            },
            {
                "type": "remote",
                "url": "https://my-domain.cz/repos.json"
            },
            {
                "type": "git",
                "url": "[e-mail]:onspli/private-repos.git",
                "file": "repos.json"
            }
        ]
    },
    "require": {
        "onspli/private-package-2": "dev-main"
    }
}

The plugin reads repos.json file and injects repositories to composer.json of the project, so during composer invocations it effectively looks like:

{
    "name": "onspli/project-using-private-repost",
    "type": "project",
    "require": {
        "onspli/private-package-2": "dev-main"
    },
    "repositories": [
        {
            "type": "git",
            "url": "[e-mail]:onspli/private-package-1.git"
        },
        {
            "type": "git",
            "url": "[e-mail]:onspli/private-package-2.git"
        },
        {
            "type": "git",
            "url": "[e-mail]:onspli/private-package-3.git"
        }
    ]
}

Verbose mode

See what files and repositories are injected using composer verbose mode:

composer install --verbose