-
Notifications
You must be signed in to change notification settings - Fork 2.4k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
fix(misc): update artifact generator option descriptions and cleanup leftovers #29077
base: master
Are you sure you want to change the base?
Conversation
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
☁️ Nx Cloud ReportCI is running/has finished running commands for commit 0122138. As they complete they will appear below. Click to see the status, the terminal output, and the build insights. 📂 See all runs for this CI Pipeline Execution ✅ Successfully ran 7 targets
Sent with 💌 from NxCloud. |
@@ -9,17 +9,16 @@ | |||
"properties": { | |||
"path": { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I still think the name path
is confusing, to be honest. To understand what it is, you need to carefully read the description. I think for such a widely used and simple generator, one should not need to read the description. It should be self explanatory. I would argue we keep the name
as the default and prompted property (and infer the path from the name), and leave the path as optional and not prompted. The angular component generator only prompts for name, and I think we should keep that. Maybe I am wrong. I am trying to look at this from an outsider/user perspective.
"description": "The name of the component.", | ||
"x-prompt": "What name would you like to use for the component?" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think we should keep this, remove the path
prompt.
"$default": { | ||
"$source": "argv", | ||
"index": 0 | ||
}, | ||
"x-prompt": "Where to create the component?" | ||
"x-prompt": "What is the component file path?" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Where to generate the component?
?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I considered that one, but it is less explicit about the fact that the option is meant to be a file path. I find it more ambiguous. While the current one explicitly asks for a file path.
c7ddb10
to
0122138
Compare
path
is the artifact file path relative to the current working directoryname
is the artifact symbol namename
and remove it from the important options (won't be displayed by default in Nx Console generation UI, it will be part of the collapsed options) given that most of the time, it's meant to match the filename (last segment of thepath
)page
generatorCurrent Behavior
Expected Behavior
Related Issue(s)
Fixes #