Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dereuromark/composer-prefer-lowest
Checks prefer-lowest installation for actually defined min versions in composer.json
https://github.com/dereuromark/composer-prefer-lowest
composer composer-scripts composer-support php
Last synced: 3 months ago
JSON representation
Checks prefer-lowest installation for actually defined min versions in composer.json
- Host: GitHub
- URL: https://github.com/dereuromark/composer-prefer-lowest
- Owner: dereuromark
- License: mit
- Created: 2019-01-03T14:20:09.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2023-11-04T02:35:15.000Z (about 1 year ago)
- Last Synced: 2024-10-11T06:32:35.872Z (3 months ago)
- Topics: composer, composer-scripts, composer-support, php
- Language: PHP
- Homepage:
- Size: 59.6 KB
- Stars: 20
- Watchers: 6
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-php - Composer Prefer Lowest Validator - A plugin to check if minimum dependencies can be installed and tested. (Table of Contents / Dependency Management Extras)
- awesome-php - Composer Prefer Lowest Validator - A plugin to check if minimum dependencies can be installed and tested. (Table of Contents / Dependency Management Extras)
- awesome-composer - Composer PreferLowest Checker - Strictly compare the specified minimum versions of your composer.json with the ones actually used by the prefer-lowest composer update command option. (Tools / Support)
README
# Composer Prefer Lowest Validator
[](https://github.com/dereuromark/composer-prefer-lowest/actions/workflows/ci.yml)
[](https://packagist.org/packages/dereuromark/composer-prefer-lowest)
[](https://php.net/)
[](https://packagist.org/packages/dereuromark/composer-prefer-lowest)
[](https://github.com/php-fig-rectified/fig-rectified-standards)
[](https://packagist.org/packages/dereuromark/composer-prefer-lowest)
This validator will strictly compare the specified minimum versions of your composer.json with the ones actually used by the `prefer-lowest` composer update command option.
This is useful for all libraries that want to make sure
- **the defined minimum of each dependency is actually still being tested**
- no silent regressions (like using too new methods of depending libraries) sneaked in
For details, see [Why and when is this useful?](https://www.dereuromark.de/2019/01/04/test-composer-dependencies-with-prefer-lowest).
This has been built after Composer didn't have the [motivation](https://github.com/composer/composer/issues/7849) for it.
**A total must-have** for
- frameworks
- framework plugins/addons (and testing against the framework minors)
- custom libraries to be used by apps/projects which have at least one dependency to other libraries
It is somewhat important for the involved packages to follow semver here. Otherwise some of the comparison might be problematic.
This is not so useful for projects, as here there is no need to test against anything than latest versions already in use.
Also, if your library has no dependencies, you can skip prefer-lowest checks as well as this validation.
## Local Test-Run
You want to give it a quick test-spin for one of your libraries? See what results it yields?
```
composer update --prefer-lowest --prefer-dist --prefer-stable
composer require --dev --update-with-all-dependencies dereuromark/composer-prefer-lowest
vendor/bin/validate-prefer-lowest
```
If there is no output, that's good. `echo $?` should return `0` (success).
## CI Installation
It is recommended to run only for CI and `composer update --prefer-lowest`.
As such, it suffices to add it conditionally here.
E.g. for Travis CI:
```
php:
- 7.3
- 8.1
env:
global:
- DEFAULT=1
matrix:
include:
- php: 7.3
env: PREFER_LOWEST=1
before_script:
- if [[ $PREFER_LOWEST != 1 ]]; then composer install --prefer-source --no-interaction; fi
- if [[ $PREFER_LOWEST == 1 ]]; then composer update --prefer-lowest --prefer-dist --prefer-stable --no-interaction; fi
- if [[ $PREFER_LOWEST == 1 ]]; then composer require --dev dereuromark/composer-prefer-lowest; fi
script:
- if [[ $DEFAULT == 1 ]]; then vendor/bin/phpunit; fi
- if [[ $PREFER_LOWEST == 1 ]]; then vendor/bin/validate-prefer-lowest; fi
```
You can, of course, also directly include it into `require-dev`.
After manually running `composer update --prefer-lowest` locally, you can also test this on your local computer then:
```
vendor/bin/validate-prefer-lowest
```
It returns the list of errors and exits with error code `1` if any violations are found.
Otherwise it returns with success code `0`.
### Prefer stable
Usually `composer update --prefer-lowest` suffices.
Make sure you have `"prefer-stable": true` in your composer.json for this to work.
Otherwise you might have to use the longer version as outlined above.
In general it is best to just use all flags for your CI script:
```
composer update --prefer-lowest --prefer-dist --prefer-stable --no-interaction
```
### Majors only
If you want to only error the CI build for major constraint issues, use `--majors-only`/`-m` option:
```
vendor/bin/validate-prefer-lowest -m
```
The patch and minor issues will then be warnings only.
### Display only
If you want to just display the result in your CI report without failing the build, you could do:
```
vendor/bin/validate-prefer-lowest || true
```
### PHP version
In general: Use the minimum PHP version for `prefer-lowest` as defined in your composer.json.
This tool requires minimum **PHP 7.3**, as such make sure your library to test also runs on this (or higher) for the `prefer-lowest` CI job.
At this point, with it being EOL already, you can and should not use any PHP version below 7.3 anyway, or provide support for it.
It is advised to also raise your composer.json entry for the min PHP version here. Use 7.3 or higher:
```
"require": {
"php": ">=7.3",
```
## Local Composer Script Installation
For local testing, when you do not want to modify your composer.json file, you can simple add this composer script:
```
"scripts": {
...
"lowest": " validate-prefer-lowest",
"lowest-setup": "composer update --prefer-lowest --prefer-stable --prefer-dist --no-interaction && cp composer.json composer.backup && composer require --dev --update-with-all-dependencies dereuromark/composer-prefer-lowest && mv composer.backup composer.json",
```
Then run `composer lowest-setup` to set up the script and finally `composer lowest` to execute.
## TODOs
- Better version handling, especially around special cases like suffixes.
Help is greatly appreciated.