fix(docs): clarify in the CLI help that argument values must be specified with =
#1052
Conversation
This file contains 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
…fied with `=` Unlike many CLIs, the `plasmo` CLI requires argument values to be provided with `=` notation (e.g. `--target=chrome-mv3`). This requirement comes from the `getFlag` method in the `@plasmo/utils` package. https://github.com/PlasmoHQ/plasmo-utils/blob/2838ca6214117bfd93b566b4b75586f6a9bd89f7/flags.ts#L8-L16 This expectation isn't clear in the documentation in the CLI, which is quite misleading. This fixes that, updating all of the examples to clearly show setting a value with `=`.
Signed-off-by: L <[email protected]>
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.
Details
Unlike many CLIs, the
plasmoCLI requires argument values to be provided with=notation (e.g.--target=chrome-mv3).This requirement comes from the
getFlagmethod in the@plasmo/utilspackage.https://github.com/PlasmoHQ/plasmo-utils/blob/2838ca6214117bfd93b566b4b75586f6a9bd89f7/flags.ts#L8-L16
This expectation isn't clear in the documentation in the CLI, which is quite misleading. This fixes that, updating all of the examples to clearly show setting a value with
=.Code of Conduct
Contacts
If your PR is accepted, we will award you with the
Contributorrole on Discord server.To join the server, visit: https://www.plasmo.com/s/d