Skip to content

Commit

Permalink
Composer: add script descriptions
Browse files Browse the repository at this point in the history
These descriptions will be used when a list of the available scripts is requested on the command-line using the `composer list` or `composer run -l` commands.

These descriptions also help document the different scripts for the maintainers of the `composer.json` file.

Ref: https://getcomposer.org/doc/articles/scripts.md#custom-descriptions-
  • Loading branch information
jrfnl committed Oct 6, 2023
1 parent 5ea2ecc commit 31db713
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -76,5 +76,16 @@
"integration-coverage": [
"@coverage-wp"
]
},
"scripts-descriptions": {
"lint": "Check the PHP files for parse errors.",
"check-cs": "Check the PHP files for code style violations and best practices.",
"fix-cs": "Auto-fix code style violations in the PHP files.",
"test": "Run the unit tests without code coverage.",
"coverage": "Run the unit tests with code coverage.",
"test-wp": "Run the WP unit tests without code coverage.",
"coverage-wp": "Run the WP unit tests with code coverage.",
"integration-test": "Deprecated. Alias for the \"test-wp\" script.",
"integration-coverage": "Deprecated. Alias for the \"coverage-wp\" script."
}
}

0 comments on commit 31db713

Please sign in to comment.