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

Merge pull request #6913 from mbrodala/scripts-description-toplevel 

Move "scripts-description" to toplevel
pull/6574/merge
Jordi Boggiano 2017-12-18 13:39:46 +01:00 committed by GitHub
parent f1cf41e051 b32c7b3d16
commit 847ebed6e6
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 22 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
doc/articles/scripts.md
View File

@ -278,16 +278,14 @@ JSON array of commands.
## Custom descriptions. ## Custom descriptions.
You can set custom script descriptions with the following extra in your composer.json: You can set custom script descriptions with the following in your `composer.json`:
```json ```json
{ {
"extra": { "scripts-descriptions": {
"scripts-description": {
"test": "Run all tests!" "test": "Run all tests!"
} }
} }
} ```
```
> **Note:** You can only set custom descriptions of custom commands. > **Note:** You can only set custom descriptions of custom commands.

9
res/composer-schema.json
View File

@ -379,7 +379,7 @@
}, },
"scripts": { "scripts": {
"type": ["object"], "type": ["object"],
"description": "Scripts listeners that will be executed before/after some events.", "description": "Script listeners that will be executed before/after some events.",
"properties": { "properties": {
"pre-install-cmd": { "pre-install-cmd": {
"type": ["array", "string"], "type": ["array", "string"],
@ -447,6 +447,13 @@
} }
} }
}, },
"scripts-descriptions": {
"type": ["object"],
"description": "Descriptions for custom commands, shown in console help.",
"additionalProperties": {
"type": "string"
}
},
"support": { "support": {
"type": "object", "type": "object",
"properties": { "properties": {

7
src/Composer/Console/Application.php
View File

@ -228,7 +228,12 @@ class Application extends BaseApplication
if ($this->has($script)) { if ($this->has($script)) {
$io->writeError('<warning>A script named '.$script.' would override a Composer command and has been skipped</warning>'); $io->writeError('<warning>A script named '.$script.' would override a Composer command and has been skipped</warning>');
} else { } else {
$description = isset($composer['extra']['scripts-description'][$script]) ? $composer['extra']['scripts-description'][$script] : null; $description = null;
if (isset($composer['scripts-descriptions'][$script])) {
$description = $composer['scripts-descriptions'][$script];
}
$this->add(new Command\ScriptAliasCommand($script, $description)); $this->add(new Command\ScriptAliasCommand($script, $description));
} }
} }