Customize the run script descriptions in composer.json

by | Apr 28, 2025 | IT Tips | 0 comments

https://github.com/toggenation/IPv6

By default the description for a run script is

Runs the <script_slug> script as defined in composer.json

e.g.

1
2
3
4
5
6
$ composer  run
Script to run:
  [expand] Runs the expand script as defined in composer.json
  [ip    ] Runs the ip script as defined in composer.json
  [mac   ] Runs the mac script as defined in composer.json
 >

To modify the description add the "scripts-descriptions" key

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
"scripts-descriptions": {
    "expand": "Expand IPv6 (fe80::1) to full form (fe80:0000:0000:0000:0000:0000:0000:0001)",
    "ip": "Convert IPv6 address to binary and show bit where subnet ends",
    "mac": "Convert a MAC address (00:ff:7a:8d:b2:4e) to an IPv6 address (fe80::2ff7:afff:e8db:24e)"
},
"scripts": {
    "expand": [
        "Toggen\\Ipv6\\Runner::expand"
    ],
    "ip": [
        "Toggen\\Ipv6\\Runner::run"
    ],
    "mac": [
        "Toggen\\Ipv6\\Runner::mac"
    ]
}

The descriptions are no longer generic

0 Comments

Submit a Comment

Your email address will not be published. Required fields are marked *

This site is protected by reCAPTCHA and the Google Privacy Policy and Terms of Service apply.

The reCAPTCHA verification period has expired. Please reload the page.