Fix: Use type alias instead of interface for Props definitions #518
Conversation
This file contains hidden or 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
Use `type` instead of `interface` for Props definitions to align with Vue ecosystem best practices. Type aliases are more flexible for union and intersection types, which is the recommended approach in Vue's official documentation and the broader Vue community. This addresses feedback from GitHub Copilot review on PR #517.
There was a problem hiding this comment.
Pull request overview
This PR updates Props definitions from interface to type alias syntax across Vue components to align with Vue ecosystem best practices and improve type system flexibility.
Key Changes:
- Converted
export interface Propstoexport type Props = {in two Vue component files - Maintains identical type structure while adopting the more conventional TypeScript syntax for Vue props
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| src/components/JsonTreeViewItem.vue | Changed Props definition from interface to type alias |
| src/components/JsonTreeView.vue | Changed Props definition from interface to type alias |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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.
Summary
This PR changes Props definitions from
interfacetotypealias to align with Vue ecosystem best practices.Changes
export interface Propstoexport type Props = {in:src/components/JsonTreeView.vuesrc/components/JsonTreeViewItem.vueRationale
Type aliases are the recommended approach for Vue props definitions according to Vue's official documentation and the broader Vue community. The main advantages are:
typefor propsColorScheme,ItemData)This addresses feedback from GitHub Copilot's automated review on PR #517.
Testing