Create Plugin: Improve cli args and add docs #1030
Merged
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
jackw
added
type/docs
sympatheticmoose
approved these changes
Aug 2, 2024
There was a problem hiding this comment.
Nice! No blockers from me other than the bit about gh workflows being added in. Would be good to have a style review from @josmperez
sympatheticmoose
requested review from
josmperez
and removed request for
Ukochka
jackw
changed the title
… passed by cli arg
…is passed via cli
…ed together via cli
jackw
force-pushed
the
jackw/create-plugin-cli-args
branch
from
a7befb1 to
f3736ae
Compare
jackw
requested review from
a team and
leventebalogh
and removed request for
a team
josmperez
approved these changes
Aug 2, 2024
docusaurus/docs/reference/prompts.md
Outdated
| @@ -13,7 +13,7 @@ sidebar_position: 40 | |||
|
|
|||
| # Prompts | |||
|
|
|||
| When running the `create-plugin` command, the following prompts appear: | |||
| When running the `create-plugin` command, the following prompts will appear. | |||
There was a problem hiding this comment.
preferred style is present indicative tense
| @@ -118,7 +118,8 @@ export function getTemplateData(cliArgs?: GenerateCliArgs): TemplateData { | |||
| ...EXTRA_TEMPLATE_VARIABLES, | |||
| pluginId: normalizeId(cliArgs.pluginName, cliArgs.orgName, cliArgs.pluginType), | |||
| pluginName: cliArgs.pluginName, | |||
| hasBackend: cliArgs.hasBackend, | |||
| // check plugintype and hasBackend as they can both be passed via user input (cli args). | |||
There was a problem hiding this comment.
Suggested change
| // check plugintype and hasBackend as they can both be passed via user input (cli args). | |
| // check plugintype and hasBackend as they can both be passed through user input (CLI args). |
Co-authored-by: Joseph Perez <45749060+josmperez@users.noreply.github.com>
leventebalogh
approved these changes
Aug 6, 2024
There was a problem hiding this comment.
Not necessarily for this PR, but I think it would make sense to change to title from "Prompts" to something like "CLI prompts" (or similar) to make it more clear when navigating in the side menu.
|
🚀 PR was released in |
grafana-plugins-platform-bot
bot
added
the
released
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.
What this PR does / why we need it:
With the release of create-plugin@5.0.0 we simplified the prompts. This PR enhances the cli args by:
Which issue(s) this PR fixes:
Fixes #
Special notes for your reviewer:
📦 Published PR as canary version:
Canary Versions✨ Test out this PR locally via:
npm install @grafana/create-plugin@5.1.0-canary.1030.d9383c4.0 # or yarn add @grafana/create-plugin@5.1.0-canary.1030.d9383c4.0