Skip to content
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

refactor(module): improve messages #355

Merged
merged 6 commits into from Mar 11, 2024
Merged

Conversation

shinGangan
Copy link
Contributor

@shinGangan shinGangan commented Mar 9, 2024

πŸ”— Linked issue

❓ Type of change

  • πŸ“– Documentation (updates to the documentation, readme or JSdoc annotations)
  • 🐞 Bug fix (a non-breaking change that fixes an issue)
  • πŸ‘Œ Enhancement (improving an existing functionality like performance)
  • ✨ New feature (a non-breaking change that adds functionality)
  • 🧹 Chore (updates to the build process or auxiliary tools and libraries)
  • ⚠️ Breaking change (fix or feature that would cause existing functionality to change)

πŸ“š Description

The current Nuxt CLI displays the following

$ $ npx nuxi@latest module search nuxt/ui                                          
βœ” Found 1 nuxt module matching nuxt/ui for nuxt 3.10.3:

- Name           ui                                                                                                                                                                                              
- Homepage       https://ui.nuxt.com
- Compatibility  nuxt: ^3.0.0
- Repository     https://github.com/nuxt/ui
- Description    Fully styled and customizable components for Nuxt, powered by Headless UI and Tailwind CSS.
- Package        @nuxt/ui
β†’ Install        nuxt module add @nuxt/ui

This installation command does not work correctly when I actually try it. That is because the command is different.
I have changed the CLI message to avoid user confusion.


The following other corrections were made in this PR

  • Execution command and display message did not match
    • target: nuxi module add, nuxi module search

πŸ“ Checklist

  • I have linked an issue or discussion.
  • I have added tests (if possible).
  • I have updated the documentation accordingly.

@shinGangan
Copy link
Contributor Author

Hi @pi0 , please review when you have a time πŸ™ .
(It is not a critical bug, so it is not a high priority.)

.eslintrc Outdated
@@ -1,5 +1,11 @@
{
"extends": ["@nuxt/eslint-config"],
"ignorePatterns":[
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please split it to another chore: PR πŸ™πŸΌ

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry, reverted this commit: 73ae4ea

This content would like to requested for review in a separate PR.

package.json Outdated Show resolved Hide resolved
@pi0 pi0 changed the title refactor(module): fix CLI messages refactor(module): improve messages Mar 9, 2024
Copy link
Member

@pi0 pi0 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

@pi0 pi0 merged commit 8970b11 into nuxt:main Mar 11, 2024
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants