Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/koodimonni/composer-dropin-installer
Use composer for installing dropin dependencies
https://github.com/koodimonni/composer-dropin-installer
composer composer-plugin php
Last synced: about 7 hours ago
JSON representation
Use composer for installing dropin dependencies
- Host: GitHub
- URL: https://github.com/koodimonni/composer-dropin-installer
- Owner: Koodimonni
- License: wtfpl
- Created: 2014-12-19T22:29:32.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2022-06-06T20:38:07.000Z (over 2 years ago)
- Last Synced: 2024-05-17T09:42:18.537Z (6 months ago)
- Topics: composer, composer-plugin, php
- Language: PHP
- Size: 66.4 KB
- Stars: 43
- Watchers: 6
- Forks: 12
- Open Issues: 8
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
Awesome Lists containing this project
README
# Composer Dropin installer
[](https://travis-ci.org/Koodimonni/Composer-Dropin-Installer)
[](https://packagist.org/packages/koodimonni/composer-dropin-installer)
[](https://packagist.org/packages/koodimonni/composer-dropin-installer)
[](https://packagist.org/packages/koodimonni/composer-dropin-installer)
[](https://packagist.org/packages/koodimonni/composer-dropin-installer)
This composer plugin helps you to move or copy your composer packaged files where you want them to be.
Composer only allows you to install full directories into their own directories. There's really useful [composer/installers](https://github.com/composer/installers) for custom installation paths but it overwrites everything in folder and doesn't allow coexist of two or more projects. We just let composer install things and take it from there.
I created this originally for installing multiple languages for WordPress with composer. I needed to have multiple packages living in same directory ```htdocs/wp-content/languages```. See how you can [update WordPress languages with composer](https://wp-languages.github.io).
## How to use it
### Follow the baby steps
1.Require "koodimonni/composer-dropin-installer": "*" or "dev-master"
```json
"require": {
"koodimonni/composer-dropin-installer": "dev-master"
}
```
2.Add custom paths into your composer.json -> extra -> dropin-paths.
```json
"extra": {
"dropin-paths": {
"htdocs/wp-content/languages/": ["type:wordpress-language"]
}
}
```
3.Enjoy nice dependency management by composer and install things where the fuck you want them to be.
### End result looks something like this
```json
{
"name": "koodimonni/wordpress",
"type": "project",
"description": "WordPress with composer languages using Koodimonni dropin installer",
"homepage": "http://github.com/koodimonni/composer-dropin-installer",
"authors": [
{
"name": "Onni Hakala",
"email": "[email protected]",
"homepage": "https://github.com/onnimonni"
}
],
"keywords": [
"wordpress", "composer", "wp", "languages"
],
"config": {
"preferred-install": "dist"
},
"repositories": [
{
"type": "composer",
"url": "https://wpackagist.org"
},
{
"type": "composer",
"url": "https://wp-languages.github.io"
}
],
"require": {
"php": ">=5.3.2",
"koodimonni/composer-dropin-installer": "*",
"johnpbloch/wordpress": "*",
"composer/installers": "~1.0",
"vlucas/phpdotenv": "~1.0.6",
"koodimonni-language/fi": "*",
"koodimonni-language/et": "*",
"koodimonni-language/ru_ru": "*",
"wpackagist-plugin/akismet": "*",
"wpackagist-plugin/wp-redis": "*",
"wpackagist-plugin/woocommerce": "*",
"wpackagist-plugin/wordpress-mu-domain-mapping": "*"
},
"extra": {
"installer-paths": {
"htdocs/wp-content/plugins/{$name}/": ["type:wordpress-plugin"],
"htdocs/wp-content/themes/{$name}": ["type:wordpress-theme"]
},
"dropin-paths": {
"htdocs/wp-content/mu-plugins/": ["type:wordpress-muplugin"],
"htdocs/wp-content/languages/": ["type:wordpress-language"],
"htdocs/wp-content/languages/plugins/": ["vendor:wordpress-plugin-language"],
"htdocs/wp-content/languages/themes/": ["vendor:wordpress-theme-language"],
"htdocs/wp-content/": [
"package:wpackagist-plugin/wp-redis:object-cache.php",
"package:wpackagist-plugin/wordpress-mu-domain-mapping:sunrise.php",
"type:wordpress-dropin"]
},
"wordpress-install-dir": "htdocs/wordpress"
}
}
```
## Moving vs. copying files
By default this dropin installer moves files from the source to the destination,
which means the files disappear from the source.
If you would prefer copying instead (which keeps the files at the source after
installation) insert the following configuration to your `composer.json` `config`
declarations:
```json
"config": {
"dropin-installer": "copy"
}
```
## But how about the impossible looking syntax?
Dropin syntax consists from four parts: `"{path}": "{directive}:{target}:{files}"`
**Path** is relative path to destination folder.
**Directive** is one of:
* package - e.g. `package:koodimonni-language/fi`
* vendor - e.g. `vendor:koodimonni-language`
* type - e.g. `type:wordpress-language`
**Files** is optional and by default it will move all files.
In some cases it would be nice to move just one file from the package.
I found out that *WordPress dropins* needed just that. Good example is this one: [Domain Mapping](https://wordpress.org/plugins/wordpress-mu-domain-mapping/) or object-cache.php.
## Some Notices
* Script works nicely together with composer/installers
* I'm ignoring these files automatically:
```
.DS_store
.git
.gitignore
composer.json
composer.lock
readme
readme.md
readme.txt
changelog.txt
license
license.md
license.txt
phpunit.xml
```
* Script requires unix filesystem (OS X,Linux)
## Testing
Run PHPUnit tests with
```
composer test
```
Tests are run inside the `tests/` directory where two dummy Composer projects are used to test dropin
installation methods.
## Todo
* Handle deletions on removal and on update. This could be easily done with json-database in [vendor-dir]
## Changelog
* 1.4 Ignore `readme` `readme.txt` `changelog.txt` & `license.txt` files automatically too. Thanks [@ocean90](https://github.com/ocean90)!
* 1.3 Support for composer 2.0
* 1.2 Added ability to copy files instead of moving them. Thanks [@rask](https://github.com/rask) for contributing!
* 1.1.0 Replaced `Composer\Script\PackageEvent` with `Composer\Installer\PackageEvent`
* 1.0.1 Updated tests to new repository https://wp-languages.github.io
* 1.0 Stable release, updated to newer composer-plugin-api
* 0.2.4 Fixes crashing when 'dropin-paths' is not defined in extra section.
* 0.2.3 Bug fixes and added small notice to user when dropins are runned
* 0.2.2 Bug fixes
* 0.2.1 Bug fixes
* 0.2 Change from custom composer script to composer plugin
* 0.1 Initial release
## Finally
Thanks to [@Seldaek](https://github.com/Seldaek) for all of this hard work with packagist.org!