neunerlei/dbg-global

Companion plugin to install the neunerlei/dbg module globally in any composer project

1.2.2 2024-11-18 12:53 UTC

Requires

• composer-plugin-api: ^1.0 || ^2.0
• neunerlei/filesystem: ^5.3

Requires (Dev)

• composer/composer: ^1.3

Apache-2.0

• Martin Neundorfer

README

This is a companion plugin to neunerlei/dbg which allows it to be installed globally, without actually adding it to your composer.json file. This is an edge case scenario for your work environment in bigger teams.

Installation

Install the plugin globally with:

composer global require neunerlei/dbg-global

After you did that you can simply run composer install in the actual project you want to use dbg in. This will not modify your composer.json or composer.lock but you will have all the helper functions accessible in your code.

Happy debugging.

Shims and disabling them

The plugin will create a shim of the neunerlei/dbg methods in the vendor directory of your local project, so that your IDE can find them for its autocompletion.

If you don't want that to happen you can either disable the shim generation globally: composer global config extra.neunerleiDevGlobal.noShim true

Alternatively you can disable the shim generation for specific directories as well: composer global config extra.neunerleiDevGlobal.noShimDirs.0 /work/project For multiple directories, raise the number after "noShimDirs" for each new directory.

Use: composer global config extra.neunerleiDevGlobal to see the current configuration

Hard copying files

If you don't want to rely on the globally installed plugin, for example in a docker context, you can create hard copies of the installed files in your "vendor" directory as well.

You can either enable them globally: composer global config extra.neunerleiDevGlobal.hardCopy true

Alternatively you can create the hard copies with a per-directory configuration composer global config extra.neunerleiDevGlobal.hardCopyDirs.0 /work/project For multiple directories, raise the number after "hardCopyDirs" for each new directory.

Postcardware

You're free to use this package, but if it makes it to your production environment I highly appreciate you sending me a postcard from your hometown, mentioning which of our package(s) you are using.

You can find my address here.

Thank you :D