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(types)!: improve type safety and inference of args #132

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

DamianGlowala
Copy link

@DamianGlowala DamianGlowala commented Mar 30, 2024

πŸ”— Linked issue

nuxt/cli#381 inspired me to work on this PR, as I noticed the args can be undefined at runtime even though their types do not reflect this.

❓ 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

This PR:

  • defines the exact set of available properties based on the arg type
  • defines a relationship between required and default properties
  • adjust the types of ctx.args.<arg> based on default and required property (currently, ctx.args.<arg> is never undefined)
  • inferres the exact possible values for an enum arg when accessing via ctx.args.<arg> (e.g. 1 | 2 | 3 rather than number)
  • improves how we handle resolving aliases assigned to parseOptions.alias

πŸ“ Checklist

  • I have linked an issue or discussion.
  • I have updated the documentation accordingly.

This was referenced Jun 4, 2024
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.

1 participant