Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sweetchuck/composer-suite
Generates Composer JSON files with different set of dependencies
https://github.com/sweetchuck/composer-suite
composer-plugin scenarios suites
Last synced: about 2 months ago
JSON representation
Generates Composer JSON files with different set of dependencies
- Host: GitHub
- URL: https://github.com/sweetchuck/composer-suite
- Owner: Sweetchuck
- Created: 2021-01-17T16:21:33.000Z (almost 4 years ago)
- Default Branch: 1.x
- Last Pushed: 2024-08-20T09:09:57.000Z (4 months ago)
- Last Synced: 2024-10-26T14:34:34.313Z (2 months ago)
- Topics: composer-plugin, scenarios, suites
- Language: PHP
- Homepage:
- Size: 260 KB
- Stars: 2
- Watchers: 4
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Composer Suites
[](https://circleci.com/gh/Sweetchuck/composer-suite/?branch=1.x)
[](https://app.codecov.io/gh/Sweetchuck/composer-suite/branch/1.x)
Generates multiple variations of the original `composer.json`
1. You have to define the differences in the
composer.json#/extra/composer-suite, see the examples below.
2. Next step is to generate the alternative composer.json files by running the
following command: \
`composer -vv suite:generate`
3. Activate one of the alternative composer.json file by setting the
[COMPOSER environment variable].
1. `export COMPOSER='composer.my-suite-01.json'`
2. `composer update --lock`
Other benefit is that, if there is any relative path in the `composer.json` –
for example under the `#/repositories/FOO/url` or anywhere under the `#/extra` –
then those paths will work with the alternative composer.*.json files as well.
## Example composer.json - multi-version dependency
```json
{
"require": {
"symfony/console": "^4.0 || ^5.0",
"symfony/process": "^4.0 || ^5.0"
},
"require-dev": {
"phpunit/phpunit": "^8.0"
},
"scripts": {
"test": "phpunit"
},
"extra": {
"composer-suite": {
"symfony4": {
"description": "Make sure Symfony 4.x will be used.",
"actions": [
{
"type": "replaceRecursive",
"config": {
"items": {
"require": {
"symfony/console": "^4.0",
"symfony/process": "^4.0"
}
}
}
}
]
},
"symfony5": {
"description": "Make sure Symfony 5.x will be used.",
"actions": [
{
"type": "replaceRecursive",
"config": {
"items": {
"require": {
"symfony/console": "^5.0",
"symfony/process": "^5.0"
}
}
}
}
]
}
}
}
}
```
Run: `composer suite:generate` \
The generated files: \
**composer.symfony4.json**
```json
{
"require": {
"symfony/console": "^4.0",
"symfony/process": "^4.0"
},
"require-dev": {
"phpunit/phpunit": "^8.0"
},
"scripts": {
"test": "phpunit"
},
"extra": {}
}
```
**composer.symfony5.json**
```json
{
"require": {
"symfony/console": "^5.0",
"symfony/process": "^5.0"
},
"require-dev": {
"phpunit/phpunit": "^8.0"
},
"scripts": {
"test": "phpunit"
},
"extra": {}
}
```
**Then**
```bash
unset COMPOSER
composer update --lock
composer suite:generate
export COMPOSER='composer.symfony4.json'
composer update
composer run test
export COMPOSER='composer.symfony5.json'
composer update
composer run test
# Back to normal.
unset COMPOSER
composer update --lock
```
## Example composer.json - local development
**Use case**
A certain third-party service has to be integrated into a framework.
Composer packages:
* RestAPI client (type: library)
* module/plugin for the framework (type: library)
* the framework (type: project)
```json
{
"type": "project",
"repositories": {},
"require": {
"my/module_01": "^1.0"
},
"require-dev": {
"sweetchuck/composer-suite": "^1.0"
},
"extra": {
"composer-suite": {
"local": {
"description": "Local development",
"actions": [
{
"type": "prepend",
"config": {
"parents": ["repositories"],
"items": {
"my/module_01": {
"type": "path",
"url": "../../my/module_01-1.x",
"options": {
"repo-path": {
"url": "https://github.com/my/module_01.git",
"branch": "1.x"
}
}
},
"my/restapi_client_01": {
"type": "path",
"url": "../../my/restapi_client_01-1.x",
"options": {
"repo-path": {
"url": "https://github.com/my/restapi_client_01.git",
"branch": "1.x"
}
}
}
}
}
},
{
"type": "replaceRecursive",
"config": {
"parents": ["require"],
"items": {
"my/module_01": "1.x-dev",
"my/restapi_client_01": "1.x-dev"
}
}
}
]
}
}
}
}
```
Run: `composer suite:generate` \
The generated file: \
**composer.local.json**
```json
{
"type": "project",
"repositories": {
"my/module_01": {
"type": "path",
"url": "../../my/module_01-1.x",
"options": {
"repo-path": {
"url": "https://github.com/my/module_01.git",
"branch": "1.x"
}
}
},
"my/restapi_client_01": {
"type": "path",
"url": "../../my/restapi_client_01-1.x",
"options": {
"repo-path": {
"url": "https://github.com/my/restapi_client_01.git",
"branch": "1.x"
}
}
}
},
"require": {
"my/module_01": "1.x-dev",
"my/restapi_client_01": "1.x-dev"
},
"require-dev": {
"sweetchuck/composer-suite": "^1.0"
},
"extra": {}
}
```
**Then**
```bash
unset COMPOSER
composer update --lock
composer suite:generate
cp ./composer.lock ./composer.local.lock
export COMPOSER='composer.local.json'
composer update --lock
# You can work on both libraries (restapi_client_01 and module_01) on-the-fly.
# Back to normal.
unset COMPOSER
composer update --lock
```
## Suites
You can have as many suites as many you want.
As the examples above show that, suites can be defined in the
`composer.json#/extra/composer-suite`, but suite definitions can be stored in
external files as well. \
`./.composer-suite/composer-suite.*.json`.
Then it is up to you if these files will be tracked by the VCS or not.
**Example `./.composer-suite/composer-suite.foo.json`:**
```json
{
"name": "foo",
"description": "My foo suite.",
"actions": []
}
```
The `name` key is optional. If it is omitted then, the suite name will be parsed
from the file name.
If two suites have the same name, then the one which comes from external file,
has the highest priority.
## Actions
You can define different array manipulation actions under the
`extra/composer-suite/` keys.
An action has two main properties:
* type (string) Identifier of the action.
* config (mixed) The data type is usually array, but it depends on the `type`.
### Action - replaceRecursive
Official PHP documentation: [array_replace_recursive()]
* parents: array
* items: array
```json
{
"require": {
"a/b": "^1.0",
"symfony/console": "^4.0",
"symfony/process": "^4.0"
},
"extra": {
"composer-suite": {
"my-suite-01": {
"actions": {
"type": " replaceRecursive",
"config": {
"parents": [],
"items": {
"require": {
"symfony/console": "^5.0",
"symfony/process": "^5.0"
}
}
}
}
}
}
}
}
```
Result:
```json
{
"require": {
"a/b": "^1.0",
"symfony/console": "^5.0",
"symfony/process": "^5.0"
},
"extra": {}
}
```
### Action - unset
Removes the specified elements.
* parents: array
```json
{
"name": "a/b",
"foo": {
"bar": "delete me"
},
"extra": {
"composer-suite": {
"my-suite-01": {
"actions": {
"type": "unset",
"config": {
"parents": [
"foo",
"bar"
]
}
}
}
}
}
}
```
Result:
```json
{
"name": "a/b",
"foo": {},
"extra": {}
}
```
In the "config.parents" array the last item can be an array:
```json
{
"name": "a/b",
"foo": {
"a": "delete me 1",
"b": "keep me",
"c": "delete me 2"
},
"extra": {
"composer-suite": {
"my-suite-01": {
"actions": {
"type": "unset",
"config": {
"parents": [
"foo",
[
"a",
"c"
]
]
}
}
}
}
}
}
```
Result:
```json
{
"name": "a/b",
"foo": {
"b": "keep me"
},
"extra": {}
}
```
### Action - prepend
Adds new elements at the beginning of an array.
* parents: array
* items: array
```json
{
"repositories": {
"old/p1": {}
},
"extra": {
"composer-suite": {
"local": {
"actions": [
{
"type": "prepend",
"config": {
"parents": [
"repositories"
],
"items": {
"new/p1": {},
"new/p2": {}
}
}
}
]
}
}
}
}
```
Result:
```json
{
"repositories": {
"new/p1": {},
"new/p2": {},
"old/p1": {}
},
"extra": {}
}
```
### Action - append
Adds new elements at the end of an array.
* parents: array
* items: array
### Action - insertBefore
Insert one or more "items". The last item in the "parents" is the reference
point.
* parents: array
* items: array
### Action - insertAfter
Insert one or more "items". The last item in the "parents" is the reference
point.
* parents: array
* items: array
## Commands
This Composer plugin defines the following commands:
* `composer suite:list`
* `composer suite:generate`
## Validate
You can check the status of the autogenerated files by running the official
`COMPOSER='composer.json' composer validate` command. \
If one of the autogenerated file **is exists AND out-of-date**, then the exit
code will be other than `0`. \
This command does not report any problem about the missing composer.*.json files.
## Links
1. [COMPOSER environment variable]
## Other
1. `"$(composer config bin-dir)/codecept" _completion --generate-hook --program codecept | source /dev/stdin`
---
[COMPOSER environment variable]: https://getcomposer.org/doc/03-cli.md#composer
[array_replace_recursive()]: https://php.net/manual/en/function.array-replace-recursive.php