Updating help message to include variations of the flags #2287
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
@akirk Should we include both variations of the flag, or stick with the |
|
@akirk, I have included the new text based on your suggestion |
adamziel
reviewed
Jun 20, 2025
| type: 'array', | ||
| string: true, | ||
| coerce: parseMountWithDelimiterArguments, | ||
| }) | ||
| .option('mountDir', { | ||
| describe: | ||
| 'Mount a directory to the PHP runtime. You can provide --mount-dir multiple times. Format: "/host/path" "/vfs/path"', | ||
| 'Mount a directory to the PHP runtime (can be used multiple times). Format: "/host/path" "/vfs/path"', | ||
| type: 'array', | ||
| nargs: 2, | ||
| array: true, | ||
| // coerce: parseMountDirArguments, |
There was a problem hiding this comment.
@bgrgicak should this be commented out?
|
Can we find a way to print the --kebab-case version? Blueprints V2 will use that convention. If not, no big deal, we can still merge it as it's an improvement. |
adamziel
approved these changes
Jun 20, 2025
|
@adamziel what about this one: Options:
--help Show help [boolean]
--version Show version number [boolean]
--outfile When building, write to this output file. [string] [default: "wordpress.zip"]
--port Port to listen on when serving. [number] [default: 9400]
--php PHP version to use. [string] [choices: "8.4", "8.3", "8.2", "8.1", "8.0", "7.4", "7.3", "7.2"] [default: "8.0"]
--wp WordPress version to use. [string] [default: "latest"]
--mount Mount a directory to the PHP runtime. You can provide --mount multiple times. Format: /host/path:/vfs/path [array]
--mount-before-install Mount a directory to the PHP runtime before WordPress installation (can be used multiple times). Format: /host/path:
/vfs/path [array]
--mount-dir Mount a directory to the PHP runtime (can be used multiple times). Format: "/host/path" "/vfs/path" [array]
--mount-dir-before-install Mount a directory before WordPress installation (can be used multiple times). Format: "/host/path" "/vfs/path"
[array]
--login Should log the user in [boolean] [default: false]
--blueprint Blueprint to execute. [string]
--blueprint-may-read-adjacent-files Consent flag: Allow "bundled" resources in a local blueprint to read files in the same directory as the blueprint fi
le. [boolean] [default: false]
--skip-wordpress-setup Do not download, unzip, and install WordPress. Useful for mounting a pre-configured WordPress directory at /wordpres
s. [boolean] [default: false]
--skip-sqlite-setup Skip the SQLite integration plugin setup to allow the WordPress site to use MySQL. [boolean] [default: false]
--quiet Do not output logs and progress messages. [boolean] [default: false]
--debug Print PHP error log content if an error occurs during Playground boot. [boolean] [default: false]
--auto-mount Automatically mount the current working directory. You can mount a WordPress directory, a plugin directory, a theme
directory, a wp-content directory, or any directory containing PHP and HTML files. [boolean] [default: false]
--follow-symlinks Allow Playground to follow symlinks by automatically mounting symlinked directories and files encountered in mounted
directories.
Warning: Following symlinks will expose files outside mounted directories to Playground and could be
a security risk. [boolean] [default: false |
|
Perfection |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation for the change, related issues
The help message from the playground CLI returns the following message for the flags
--mountDir,--mountDirBeforeInstall, and--mountBeforeInstall. The flags used in the description are not using camelCase; both options are valid, but I can confuse the users. Also, the snake version of--mountDirBeforeInstallshould be--mount-dir-before-installinstead of--mount-before-install.--mountBeforeInstall Mount a directory to the PHP runtime before installing WordPress. You can provide --mount-before-install multiple times. Format: /host/path:/ vfs/path [array] --mountDir Mount a directory to the PHP runtime. You can provide --mount-dir multiple times. Format: "/host/path" "/vfs/path" [array] --mountDirBeforeInstall Mount a directory to the PHP runtime before installing WordPress. You can provide --mount-before-install multiple times. Format: "/host/path" "/vfs/path" [array]Implementation details
I have updated the descriptions at the
cli.tsTesting Instructions (or ideally a Blueprint)
--help--mountBeforeInstall Mount a directory to the PHP runtime before installing WordPress. You can provide --mountBeforeInstall or --mount-before-install multiple times. Format: /host/path:/vfs/path [array] --mountDir Mount a directory to the PHP runtime. You can provide --mountDir or --mount-dir multiple times. Format: "/host/path" "/vfs/path" [array] --mountDirBeforeInstall Mount a directory to the PHP runtime before installing WordPress. You can provide --mountDirBeforeInstall or --mount-dir-before-install multiple times. Format: "/host/path" "/vfs/path" [array]