From 7a419f27ed89e19dcc2cd3b64cd479dc4252961c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Andreas=20M=C3=B6ller?= Date: Wed, 29 Dec 2021 19:42:23 +0100 Subject: [PATCH] Fix: Update README.md --- README.md | 68 +------------------------------------------------------ 1 file changed, 1 insertion(+), 67 deletions(-) diff --git a/README.md b/README.md index 2bce34fb..efcbd78e 100644 --- a/README.md +++ b/README.md @@ -115,7 +115,7 @@ The `NormalizeCommand` provided by the `NormalizePlugin` within this package wil - determine whether a `composer.json` exists - determine whether a `composer.lock` exists, and if so, whether it is up to date (unless the `--no-check-lock` option is used) -- use [normalizers](https://github.com/ergebnis/composer-normalize#normalizers) to normalize the content of `composer.json` +- use [`Ergebnis\Json\Normalizer\Vendor\Composer\ComposerJsonNormalizer`](https://github.com/ergebnis/json-normalizer#vendorcomposercomposerjsonnormalizer) to normalize the content of `composer.json` - format the normalized content (either as sniffed, or as specified using the `--indent-size` and `--indent-style` options) - write the normalized and formatted content of `composer.json` back to the file - update the hash in `composer.lock` if it exists and if an update is necessary @@ -159,72 +159,6 @@ composer normalize --dry-run In case `composer.json` is not normalized (or `composer.lock` is not up-to-date), the command will fail with an exit code of `1` and show a diff. -## Normalizers - -The `ComposerJsonNormalizer` composes normalizers provided by [`ergebnis/json-normalizer`](https://github.com/ergebnis/json-normalizer): - -- [`Ergebnis\Json\Normalizer\ChainNormalizer`](https://github.com/ergebnis/json-normalizer#chainnormalizer) -- [`Ergebnis\Json\Normalizer\SchemaNormalizer`](https://github.com/ergebnis/json-normalizer#schemanormalizer) - -as well as the following normalizers provided by this package: - -- [`Ergebnis\Composer\Json\Normalizer\BinNormalizer`](https://github.com/ergebnis/composer-normalize/blob/main/README.md#binnormalizer) -- [`Ergebnis\Composer\Json\Normalizer\ConfigHashNormalizer`](https://github.com/ergebnis/composer-normalize/blob/main/README.md#confighashnormalizer) -- [`Ergebnis\Composer\Json\Normalizer\PackageHashNormalizer`](https://github.com/ergebnis/composer-normalize/blob/main/README.md#packagehashnormalizer) -- [`Ergebnis\Composer\Json\Normalizer\VersionConstraintNormalizer`](https://github.com/ergebnis/composer-normalize/blob/main/README.md#versionconstraintnormalizer) - -### `BinNormalizer` - -If `composer.json` contains an array of scripts in the `bin` section, the `BinNormalizer` will sort the elements of the `bin` section by value in ascending order. - -:bulb: Find out more about the `bin` section at https://getcomposer.org/doc/04-schema.md#bin. - -### `ConfigHashNormalizer` - -If `composer.json` contains any configuration in the - -- `config` -- `extra` -- `scripts-descriptions` - -sections, the `ConfigHashNormalizer` will sort the content of these sections by key in ascending order. - -:bulb: Find out more about the `config` section at https://getcomposer.org/doc/06-config.md. - -### `PackageHashNormalizer` - -If `composer.json` contains any configuration in the - -- `conflict` -- `provide` -- `replace` -- `require` -- `require-dev` -- `suggest` - -sections, the `PackageHashNormalizer` will sort the content of these sections. - -:bulb: This transfers the behaviour from using the `--sort-packages` or `sort-packages` configuration flag to other sections. Find out more about the `--sort-packages` flag and configuration at https://getcomposer.org/doc/06-config.md#sort-packages and https://getcomposer.org/doc/03-cli.md#require. - -### `VersionConstraintNormalizer` - -If `composer.json` contains version constraints in the - -- `conflict` -- `provide` -- `replace` -- `require` -- `require-dev` - -sections, the `VersionConstraintNormalizer` will ensure that - -- all constraints are trimmed -- *and- constraints are separated by a single space (` `) or a comma (`,`) -- *or- constraints are separated by double-pipe with a single space before and after (` || `) -- *range- constraints are separated by a single space (` `) - -:bulb: Find out more about version constraints at https://getcomposer.org/doc/articles/versions.md. - ## Examples ### `pestphp/pest`