fix(eslint-plugin): replace unclear "error typed" with more helpful description
#11704
Conversation
|
Thanks for the PR, @wjhsf! typescript-eslint is a 100% community driven project, and we are incredibly grateful that you are contributing to that community. The core maintainers work on this in their personal time, so please understand that it may not be possible for them to review your work immediately. Thanks again! 🙏 Please, if you or your company is finding typescript-eslint valuable, help us sustain the project by sponsoring it transparently on https://opencollective.com/typescript-eslint. |
✅ Deploy Preview for typescript-eslint ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
wjhsf
changed the title
error typed" with more helpful descriptionerror typed" with more helpful description
|
| Command | Status | Duration | Result |
|---|---|---|---|
nx run integration-tests:test |
❌ Failed | 52s | View ↗ |
nx test eslint-plugin --coverage=false |
✅ Succeeded | 5m 25s | View ↗ |
nx run-many -t lint |
✅ Succeeded | 3m 15s | View ↗ |
nx run-many -t typecheck |
✅ Succeeded | 2m 9s | View ↗ |
nx test eslint-plugin-internal --coverage=false |
✅ Succeeded | 6s | View ↗ |
nx run types:build |
✅ Succeeded | 5s | View ↗ |
nx test typescript-estree --coverage=false |
✅ Succeeded | 2s | View ↗ |
nx run generate-configs |
✅ Succeeded | 7s | View ↗ |
Additional runs (29) |
✅ Succeeded | ... | View ↗ |
☁️ Nx Cloud last updated this comment at 2025-10-31 18:54:04 UTC
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #11704 +/- ##
=======================================
Coverage 90.66% 90.66%
=======================================
Files 518 518
Lines 52415 52415
Branches 8678 8678
=======================================
Hits 47521 47521
Misses 4880 4880
Partials 14 14
Flags with carried forward coverage won't be shown. Click here to find out more.
🚀 New features to boost your workflow:
|
wjhsf
changed the title
error typed" with more helpful descriptionerror typed" with more helpful description
JoshuaKGoldberg
left a comment
JoshuaKGoldberg
left a comment
There was a problem hiding this comment.
🙌 time to bikeshed! 🙌
| messageId, | ||
| data: { | ||
| type: isErrorType ? '`error` type' : '`any`', | ||
| type: isErrorType ? 'unresolved due to error' : '`any`', |
There was a problem hiding this comment.
Not the most natural phrasing
🤔 yeah, I'm not sure that this specific change is better for users. Looking at the deploy preview playground, the report message is:
Unsafe call of a(n) unresolved due to error typed value.
It took me a few tries to parse out the English grammar in that sentence, and I had to rely on already knowing the rule & this PR.
I'm drawing a blank here (and am a little swamped), but let's bikeshed. What's a more clear phrase we could go with?
There was a problem hiding this comment.
Using an entirely new message would be best. Something along the lines of "Unsafe call of a type that could not be resolved." That's what I originally started doing in this PR, but then I had to touch more files than I wanted to, so I changed to the kludgy phrasing.
There was a problem hiding this comment.
FWIW I like that phrasing more. I can't think of a way to more concisely tell the user "this type could not be resolved" than just saying so.
JoshuaKGoldberg
added
the
awaiting response
2 participants
PR Checklist
errortype typed value" (especially in JSDoc) #9591Steps in Contributing were takenOverview
As described in #9591, the error message "Unsafe call of a(n)
errortype typed value". Namely, what is "anerrortype typed value"? It's unclear to anyone who does not know that TypeScript has a special flavor ofanyfor types that could not be resolved. (Probably just about everyone who doesn't work on TypeScript tooling.)This PR aims to provide clarity by changing "
errortyped" to "unresolved due to error", resulting in error messages like "Unsafe call of a(n) unresolved due to error typed value". Not the most natural phrasing, and it would probably be better to use a distinct error message, but my goal was to make a minimal change and not have to go stomping through the code to figure things out. 😅