composer-plugin imposter-plugin

typisttech/imposter-plugin

Composer plugin that wraps all composer vendor packages inside your own namespace. Intended for WordPress plugins

Composer plugin that wraps all composer vendor packages inside your own namespace. Intended for WordPress plugins.

Built with ♥ by Typist Tech , _(*1)

Imposter Plugin is an open source project and completely free to use., _(*2)

However, the amount of effort needed to maintain and develop new features is not sustainable without proper financial backing. If you have the capability, please consider donating using the links below:, _(*3)

Wrapping all composer vendor packages inside your own namespace. Intended for WordPress plugins. Imposter Plugin is a composer plugin wrapper for Imposter., _(*4)

Why?

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., _(*5)

See: - A Narrative of Using Composer in a WordPress Plugin - A Warning About Using Composer With WordPress - Plugin Dependencies (Yet Another Plugin Dependencies Ticket), _(*6)

Install

Installation should be done via composer, details of how to install composer can be found at https://getcomposer.org/., _(*7)

First, add Imposter configuration in your composer.json, _(*8)

"extra": {
    "imposter": {
        "namespace": "My\\App\\Vendor",
        "excludes": [
            "dummy/dummy-excluded"
        ]
    }
}

Then, install via composer cli, _(*9)

composer require typisttech/imposter-plugin

See: Imposter readme for details., _(*10)

Typist Tech is ready to build your next awesome WordPress site. Hire us! , _(*11)

Usage

Sit Back and Relax

Once installed, this plugin hooks into composer install, composer update and composer dump-autoload, automatically run imposter for you. Besides, imposter plugin autoloads all modified files as classmap., _(*12)

When those events triggered, this plugin: 1. looks for /path/to/project/root/composer.json 2. finds out vendor-dir 3. finds out all required packages, including those required by dependencies 4. finds out all autoload paths for all required packages 5. prefixes all namespaces with the imposter-plugin namespace defined in your composer.json, _(*13)

Learn more on imposter's readme., _(*14)

Known Issues

Help wanted. Pull requests are welcomed., _(*15)

1. Imposter run twice when composer install and composer update
2. Traits are not transformed
3. Virtual packages are not supported

Frequently Asked Questions

What can I find more information?

Learn more on imposter's readme for more details., _(*16)

How about not hooking into composer commands?

Use imposter directly., _(*17)

How to distrube impostified plugins?

1. Switch to the lowest PHP version you support
2. Install dependencies
   • $ composer install --no-dev --classmap-authoritative --prefer-dist
3. Clean up the source code, e.g: remove test files
4. Zip the source code. Tips: Use $ composer archive
5. Send the zip to others / Commit to wp.org SVN. Tips:
   • How to Deploy a WordPress Plugin From TravisCI to WordPress.org
   • WordPress.org Plugin Deploy (GitHub action by 10up)

How to install impostified plugins via composer?

Impostified plugins are meant to be commited to wp.org svn., _(*18)

Using imposter means you forgo the ability to install the plugins with composer directly via packagist.org or VCS (even with type: wordpress-plugin in composer.json)., _(*19)

To composer require impostified plugins, use wpackagist.org., _(*20)

The whole imposter situation is horrible. What can we do about it?

Until WordPress core comes up with a solution on dependency managment, keep clam and carry on., _(*21)

In the meantime, checkout these tools ~~to make WordPress suck less~~ modernizing WordPress development:, _(*22)

• bring OOP into WordPress
• leveraging development practices from other languages and ecosystems, and applying them to WordPress

Do you have real life examples that use this composer plugin?

Here you go:, _(*23)

• Spatie Ray
• Notification

Add your own here, _(*24)

Which composer versions are supported?

Both v1 and v2., _(*25)

Will you add support for older PHP versions?

Never! This plugin will only work on actively supported PHP versions., _(*26)

Don't use it on end of life or security fixes only PHP versions., _(*27)

It looks awesome. Where can I find some more goodies like this

• 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

Where can I give 5-star reviews?

Thanks! Glad you like it. It's important to let me knows somebody is using this project. Please consider:, _(*28)

• tweet something good with mentioning @TangRufus
• ★ star the Github repo
• 👀 watch the Github repo
• write tutorials and blog posts
• hire Typist Tech

Testing

composer test
composer style:check

Alternatives

Here is a list of alternatives that I found. However, none of these satisfied my requirements., _(*29)

If you know other similar projects, feel free to edit this section!, _(*30)

• Mozart by Coen Jacobs, _(*31)

  • Works with PSR0 and PSR4
  • Dependency packages store in a different directory

• PHP Scoper, _(*32)

  • Prefixes all PHP namespaces in a file/directory to isolate the code bundled in PHARs

Feedback

Please provide feedback! We want to make this project as useful as possible. Please submit an issue and point out what you do and don't like, or fork the project and send pull requests. No issue is too small., _(*33)

Security Vulnerabilities

If you discover a security vulnerability within this project, please email us at imposter-plugin@typist.tech. All security vulnerabilities will be promptly addressed., _(*34)

Credits

Imposter Plugin is a Typist Tech project and maintained by Tang Rufus, freelance developer for hire., _(*35)

Full list of contributors can be found here., _(*36)

License

Imposter Plugin is released under the MIT License., _(*37)