How to use Studio with an existing Git repository?

Use 'studio create --git' to clone the repository or '--submodule' for submodules, which automatically sets up the package and loads it locally, as detailed in the command reference.

Studio vs using Composer path repositories directly?

Studio automates symlinking and tool configuration, saving manual steps, but adds an extra layer; direct path repos offer more control but require editing composer.json and handling setup yourself.

Can Studio handle multiple packages in one command?

Yes, Studio supports wildcard patterns in the load command, such as 'studio load path/to/libraries/*', to manage all packages in a directory at once, making it ideal for library collections.

How to remove a package managed by Studio?

Use 'studio unload' to stop managing a path or 'studio scrap' to delete it entirely, with confirmation prompts to prevent accidental removal, as explained in the command reference.

Does Studio work on Windows?

Studio relies on symlinks, which on Windows may require enabling developer mode or have permission issues, so compatibility can be limited and may need additional setup.

What if I need to configure a tool not listed by Studio?

You must manually configure tools outside Studio's predefined list (e.g., PHPStan or GitHub Actions), as it doesn't provide extensibility for automated setup beyond the mentioned tools.

Open-Awesome

Studio

MITPHP0.16.0

A development workbench that symlinks local Composer packages for seamless library development within applications.

GitHub

1.1k stars73 forks0 contributors

What is Studio?

Studio is a development tool that simplifies working on Composer packages by allowing developers to symlink local copies of their libraries into applications instead of installing them from Packagist. It uses Composer's path repositories to avoid developing inside the vendor directory and automatically configures common development tools like PhpUnit and TravisCI.

Target Audience

PHP developers who create and maintain Composer packages and need to test them in real-time within dependent applications without publishing to Packagist.

Value Proposition

Developers choose Studio because it provides a non-invasive workflow that doesn't require modifying the main application's composer.json, supports wildcard loading for multiple packages, and automates setup for testing and CI tools, reducing manual configuration overhead.

Overview

A workbench for developing Composer packages.

Use Cases

Best For

Developing Composer packages locally while using them in a main application without publishing to Packagist.
Automatically configuring development tools like PhpUnit, PhpSpec, and TravisCI for new or existing packages.
Managing collections of libraries by loading multiple packages at once using wildcard patterns.
Creating new Composer package skeletons with optional components for testing and continuous integration.
Cloning existing Git repositories or using submodules as local packages within a project.
Dogfooding libraries in real-time during development without altering the application's composer.json file.

Not Ideal For

Projects that only consume third-party Composer packages without developing custom ones
Teams already using monorepo tools or manual Composer path repositories without automation
Environments where symlinks are problematic, such as Windows without developer mode or restricted Docker setups

Pros & Cons

Pros

Non-Invasive Workflow

Allows using local packages without modifying the main application's composer.json, enabling real-time dogfooding without configuration changes, as highlighted in the workflow section.

Automated Tool Setup

Automatically configures development tools like PhpUnit, PhpSpec, and TravisCI for packages, reducing manual setup overhead, as stated in the README's feature list.

Wildcard Package Loading

Supports loading multiple packages at once using wildcard patterns (e.g., 'path/to/libraries/*'), making it efficient for managing collections, as described in the usage tips.

Package Creation Generator

Includes a generator to create new Composer package skeletons with optional components like testing config, speeding up initial development, as shown in the create command examples.

Cons

Composer Dependency Limitations

Relies heavily on Composer's path repositories, which can have edge cases with custom installers or plugins, and might not handle all dependency scenarios seamlessly.

Additional Configuration Layer

Introduces a studio.json file and extra CLI commands, adding complexity compared to using Composer's native features directly, which can steepen the learning curve.

Fixed Tool Integration

Only automates setup for a predefined list of tools (PhpUnit, PhpSpec, TravisCI), lacking extensibility for newer or alternative development tools without manual intervention.

Frequently Asked Questions

Related Projects

OctoLinker Browser Extension

OctoLinker — Links together, what belongs together

Stars5,355

Forks283

Last commit2 years ago

Composer/Xdebug-Handler

Restart a CLI process without loading the xdebug extension.

Stars2,562

Forks33

Last commit1 month ago

Composer-Unused

Show unused composer dependencies by scanning your code

Stars1,679

Forks57

Last commit6 days ago

Composer-Normalize

🎵 Provides a composer plugin for normalizing composer.json.

Stars1,107

Forks36

Last commit5 days ago

Community-curated · Updated weekly · 100% open source

Found a gem we're missing?

Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.

Submit a project Star on GitHub