public-mirrors
/
composer
mirror of https://github.com/composer/composer
1
0
Fork 0
Code

Update documentation for validate command (#12137)

pull/12143/head
PrinsFrank 2024-10-02 11:09:23 +02:00 committed by GitHub
parent 95b9b54f0c
commit 3a503d1805
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 6 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
doc/03-cli.md
View File

@ -729,8 +729,10 @@ packages depending on the packages that cause the conflict.
## validate
You should always run the `validate` command before you commit your
`composer.json` file, and before you tag a release. It will check if your
`composer.json` is valid.
`composer.json` file (and `composer.lock` [if applicable](01-basic-usage.md#commit-your-composer-lock-file-to-version-control)), and before you tag a release.
It will check if your
`composer.json` is valid. If a `composer.lock` exists, it will also check if it is up to date with the `composer.json`.
```shell
php composer.phar validate
@ -740,7 +742,9 @@ php composer.phar validate
* **--no-check-all:** Do not emit a warning if requirements in `composer.json` use unbound or overly strict version constraints.
* **--no-check-lock:** Do not emit an error if `composer.lock` exists and is not up to date.
* **--check-lock** Check if lock file is up to date (even when [config.lock](06-config.md#lock) is false)
* **--no-check-publish:** Do not emit an error if `composer.json` is unsuitable for publishing as a package on Packagist but is otherwise valid.
* **--no-check-version:** Do not emit an error if the version field is present.
* **--with-dependencies:** Also validate the composer.json of all installed dependencies.
* **--strict:** Return a non-zero exit code for warnings as well as errors.