Wrapping all composer vendor packages inside your own namespace. Intended for WordPress plugins.
- Why?
- Install
- Config
- Usage
- Frequently Asked Questions
- How can I integrate imposter with composer?
- Does imposter support
PSR4,PSR0,ClassmapandFiles? - Can I exclude some of the packages from imposter?
- Does imposter support
exclude-from-classmap? - How about
require-devpackages? - How about PHP built-in classes?
- How about packages that don't use namespaces?
- How about packages that use fully qualified name?
- Will you add support for older PHP versions?
- It looks awesome. Where can I find some more goodies like this?
- This package isn't on wp.org. Where can I give a ⭐⭐⭐⭐⭐ review?
- Alternatives
- Support
- Running the Tests
- Feedback
- Change log
- Security
- Credits
- License
Because of the lack of dependency management in WordPress, if two plugins bundled conflicting versions of the same package, hard-to-reproduce bugs arise. Monkey patching composer vendor packages, wrapping them inside your own namespace is a less-than-ideal solution to avoid such conflicts.
See:
If you want to hook Imposter into composer command events, install imposter-plugin instead. See: How can I integrate Imposter with composer?
Installation should be done via composer, details of how to install composer can be found at https://getcomposer.org/.
$ composer require typisttech/imposterIn your composer.json:
"extra": {
"imposter": {
"namespace": "My\\App\\Vendor",
"excludes": [
"dummy/dummy-excluded"
]
}
}Required String
This is the namespace prefix to be added to vendor packages.
Optional Array of strings
Vendor packages which needs to be excluded from namespace prefixing.
All composer-made packages are excluded by default.
Besides, anything under the Composer namespace will be excluded.
After every $ composer install and $ composer update:
<?php
use TypistTech\Imposter\ImposterFactory;
$imposter = ImposterFactory::forProject('/path/to/project/root');
$imposter->run();The above snippet:
- Look for
/path/to/project/root/composer.json - Find out vendor-dir
- Find out all required packages, including those required by dependencies
- Find out all autoload paths for all required packages
- Prefix all namespaces with the imposter namespace defined in your
composer.json
Before:
<?php
namespace Dummy\File;
use AnotherDummy\{
SubAnotherDummy, SubOtherDummy
};
use Composer;
use Composer\Plugin\PluginInterface;
use Dummy\SubOtherDummy;
use OtherDummy\SubOtherDummy;
use RuntimeException;
use \UnexpectedValueException;
use function OtherVendor\myFunc;
use const OtherVendor\MY_MAGIC_NUMBER;
class DummyClass
{
}After:
<?php
namespace MyPlugin\Vendor\Dummy\File;
use MyPlugin\Vendor\AnotherDummy\{
SubAnotherDummy, SubOtherDummy
};
use Composer;
use Composer\Plugin\PluginInterface;
use MyPlugin\Vendor\Dummy\SubOtherDummy;
use MyPlugin\Vendor\OtherDummy\SubOtherDummy;
use RuntimeException;
use \UnexpectedValueException;
use function MyPlugin\Vendor\OtherVendor\myFunc;
use const MyPlugin\Vendor\OtherVendor\MY_MAGIC_NUMBER;
class DummyClass
{
}Use imposter-plugin instead. It hooks imposter into composer command events.
Yes for all. PSR-4 and PSR-0 autoloading, classmap generation and files includes are supported.
Yes, see extra.imposter.excludes.
All composer made packages are excluded by default.
Not for now. Pull requests are welcome.
Imposter do nothing on require-dev packages because imposter is intended for avoiding production environment., not for development environment.
Imposter skips classes that on global namespace, for example: \ArrayObject, \RuntimeException
Not for now. Tell me your idea by opening an issue
Not for now. We need a better regex(or something better than regex) in the Transformer class. Tell me your idea by opening an issue
Never! This package will only works on actively supported PHP versions. Don't use it on end of life or security fixes only PHP versions.
- Articles on Typist Tech's blog
- Tang Rufus' WordPress plugins on wp.org
- More projects on Typist Tech's GitHub profile
- Stay tuned on Typist Tech's newsletter
- Follow Tang Rufus' Twitter account
- Hire Tang Rufus to build your next awesome site
Thanks!
Consider writing a blog post, submitting pull requests, donating or hiring me instead.
Here is a list of alternatives that I found. But none satisfied my requirements.
If you know other similar projects, feel free to edit this section!
-
Mozart by Coen Jacobs
- Works with PSR0 and PSR4
- Dependency packages store in a different directory
-
- Prefixes all PHP namespaces in a file/directory to isolate the code bundled in PHARs
Love imposter? Help me maintain it, a donation here can help with it.
Ready to take freelance WordPress jobs. Contact me via the contact form here or, via email info@typist.tech
Contact: Tang Rufus
Run the tests:
$ composer test
$ composer check-stylePlease provide feedback! We want to make this library useful in as many projects as possible. Please submit an issue and point out what you do and don't like, or fork the project and make suggestions. No issue is too small.
Please see CHANGELOG for more information on what has changed recently.
If you discover any security related issues, please email imposter@typist.tech instead of using the issue tracker.
imposter is a Typist Tech project and maintained by Tang Rufus, freelance developer for hire.
Full list of contributors can be found here.
The MIT License (MIT). Please see License File for more information.