fix: correct no-restricted-import messages
#20374
Conversation
✅ Deploy Preview for docs-eslint canceled.
|
| * @returns {string} The formatted import names. | ||
| */ | ||
| function formatImportNames(importNames) { | ||
| return new Intl.ListFormat("en-US").format( |
There was a problem hiding this comment.
This could throw an error if Node.js is built without ICU as Intl is then not available.
Or in general I think this should be a utility as other rules also use lists in their messages.
There was a problem hiding this comment.
We're already using the same here, so if it's problematic then we should replace it:
Line 683 in e593aa0
There was a problem hiding this comment.
I should've make my point more clear: I would not lower our compatibility (some runtimes may not support Intl for any reason) for the two instances of Intl as it is easily inlineable as the locale is fixed:
function formatList(list) {
return `${list.slice(0, -1).join(', ')}${list.length > 1 ? ` and ${list.at(-1)` : ''}`;
}There was a problem hiding this comment.
If we want to add support for environments that don't support Intl, such as custom Node.js builds, I think we should replace all usages of Intl. There aren't many, but here is another one that should be also addressed, in addition to the other occurrence of Intl.ListFormat shown in #20374 (comment):
eslint/lib/shared/string-utils.js
Line 44 in 129882d
Since that would be a new feature outside the scope of this PR, maybe it's better to discuss it in a separate issue?
There was a problem hiding this comment.
Yes, let's discuss this in a separate issue, created #20380 for tracking.
snitin315
added
the
accepted
Prerequisites checklist
What is the purpose of this pull request? (put an "X" next to an item)
[ ] Documentation update
[X] Bug fix (template)
[ ] New rule (template)
[ ] Changes an existing rule (template)
[ ] Add autofix to a rule
[ ] Add a CLI option
[ ] Add something to the core
[ ] Other, please explain:
What changes did you make? (Give an overview)
This PR fixes several violation messages in the
no-restricted-importsrule to make them more grammatically correct, and to avoid formatting arrays as strings in the message data, which results in incorrect spacing and missing quotes.Example:
Playground link
Before:
After:
Is there anything you'd like reviewers to focus on?