-
-
Notifications
You must be signed in to change notification settings - Fork 33.7k
fix(types): no props typings in js files #13109
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
base: main
Are you sure you want to change the base?
Conversation
computed: { | ||
test() { | ||
// @ts-expect-error Invalid typecast if `this.a` is not any | ||
;/** @type import('../utils').IsAny<typeof this.a> */ (this.a) |
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.
If this.a
is any
this conversion wouldn't result in an error
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.
Hi! I'm a grad student working on a research project about using large language models to automate code review. Based on your commit e509aeb and the changes in types/test/v3/define-component-test.js, my tool generated this comment:
- Parameter Validation: Ensure that the
props
object is validated before being used in thedefineComponent
function. Ifprops
is expected to contain certain types or structures, there should be checks to confirm that these are present and valid. - Handling Undefined or Null Values: If the
defineComponent
function is called withprops
that may be undefined or null, it should handle these cases gracefully. - Type Checking: Implement runtime type checking to ensure that the values passed to
props
conform to the expected types. - Error Handling: If the
defineComponent
function encounters an error due to invalid props, it should have a mechanism to handle such errors without crashing the application. - Logical Evaluation: Verify that the
defineComponent
function correctly handles prop types. Ensure proper validation for the prop types defined in theprops
object. - Direct Feedback: Add or modify tests that specifically check the behavior of the
defineComponent
function with various prop types. Confirm that components using different prop types behave correctly and that any errors are handled appropriately. - Test Coverage: Ensure that there are existing tests that validate the behavior of
defineComponent
with respect to prop types. If there are no tests that specifically check for the correct handling of prop types, it would be prudent to add them. - Edge Cases: Consider adding tests that cover edge cases for the prop types defined in the
props
object. - Specificity: Ensure that subsequent tests accurately reflect the behavior of prop types. Revise any tests that do not align with this focus.
- Conclusion: Further verification of the
defineComponent
function's implementation and the associated tests is necessary to ensure that the functionality aligns with the new description. If the tests do not adequately cover the expected behavior of prop types, additional tests should be implemented.
As part of my research, I'm trying to understand how useful these comments are in real-world development. If you have a moment, I'd be super grateful if you could quickly reply to these two yes/no questions:
- Does this comment provide suggestions from a dimension you hadn’t considered?
-
- Do you find this comment helpful?
Thanks a lot for your time and feedback! And sorry again if this message is a bother.
What kind of change does this PR introduce? (check at least one)
Does this PR introduce a breaking change? (check one)
If yes, please describe the impact and migration path for existing applications:
The PR fulfills these requirements:
main
branch for v2.x (or to a previous version branch)fix #xxx[,#xxx]
, where "xxx" is the issue number)If adding a new feature, the PR's description includes:
Other information:
This PR intended to fix an annoying problem that caused no type support for
props
injs
files. As it said it ts documentation unspecified types defaults toany
which caused the wholeprops
object to becomeany
.Explicitly specifying the type
unknown
in generic should fully fix this problem.References:
Similar PR addressing the same issue but with a bit harder solution
Known
Vue language tools
issues which are closed as upstream because of this bug.vuejs/language-tools#2347
vuejs/language-tools#1537