Skip to content

fix(eslint-plugin): [no-misused-spread] correct and elaborate string spread report message #10751

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

Conversation

JoshuaKGoldberg
Copy link
Member

PR Checklist

Overview

Updates the report message for a string spread to bemoan both ... and .split("").

💖

@typescript-eslint
Copy link
Contributor

Thanks for the PR, @JoshuaKGoldberg!

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.

Copy link

netlify bot commented Jan 31, 2025

Deploy Preview for typescript-eslint ready!

Name Link
🔨 Latest commit 1af6d6f
🔍 Latest deploy log https://app.netlify.com/sites/typescript-eslint/deploys/67a3f59ff07f3d00088de281
😎 Deploy Preview https://deploy-preview-10751--typescript-eslint.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
1 paths audited
Performance: 98 (🔴 down 1 from production)
Accessibility: 100 (no change from production)
Best Practices: 92 (no change from production)
SEO: 98 (no change from production)
PWA: 80 (no change from production)
View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link

nx-cloud bot commented Jan 31, 2025

View your CI Pipeline Execution ↗ for commit 1af6d6f.

Command Status Duration Result
nx run-many --target=build --exclude website --... ✅ Succeeded 4s View ↗
nx run-many --target=clean ✅ Succeeded 11s View ↗

☁️ Nx Cloud last updated this comment at 2025-02-05 23:50:13 UTC

'- .split("") produces UTF-16 code units, which breaks rich characters in many languages',
"If this string does not need to preserve emojis or other non-English characters, disable this lint rule on this line or configure the 'allow' rule option.",
'Otherwise, consider using `Intl.Segmenter`.',
].join('\n'),
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

To anybody with opinions on string splitting: please bikeshed the heck out of this message!

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice!
I would prefer having the disable comment sentence as the otherwise with something like

  • If you want to split on graphemes, consider using Intl.Segmenter
  • Otherwise, if this string does not need to preserve emojis ...

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1. I think it makes sense to say "consider using Intl.Segmenter for robust, locale-aware string decomposition." first, and then "Otherwise, if you don't need to preserve emojis or other non-Ascii characters, disable, etc..."

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the people have spoken

Co-authored-by: Kirk Waiblinger <53019676+kirkwaiblinger@users.noreply.github.com>
Copy link
Member

@kirkwaiblinger kirkwaiblinger left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The PR has not been updated with the people's demands 😜 https://github.com/typescript-eslint/typescript-eslint/pull/10751/files#r1942930884

Wondering if you forgot to push?

@JoshuaKGoldberg
Copy link
Member Author

🤦

kirkwaiblinger
kirkwaiblinger previously approved these changes Feb 5, 2025
Copy link

codecov bot commented Feb 5, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 87.28%. Comparing base (3372a4a) to head (1af6d6f).
Report is 26 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main   #10751      +/-   ##
==========================================
+ Coverage   87.26%   87.28%   +0.01%     
==========================================
  Files         450      450              
  Lines       15715    15739      +24     
  Branches     4601     4609       +8     
==========================================
+ Hits        13714    13737      +23     
  Misses       1645     1645              
- Partials      356      357       +1     
Flag Coverage Δ
unittest 87.28% <ø> (+0.01%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files with missing lines Coverage Δ
...kages/eslint-plugin/src/rules/no-misused-spread.ts 100.00% <ø> (ø)

... and 9 files with indirect coverage changes

Copy link
Contributor

@ArnaudBarre ArnaudBarre left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚀

@kirkwaiblinger kirkwaiblinger added the 1 approval >=1 team member has approved this PR; we're now leaving it open for more reviews before we merge label Feb 10, 2025
@JoshuaKGoldberg
Copy link
Member Author

I'd normally prefer to leave this open for a couple more days to get a full week (https://typescript-eslint.io/maintenance/pull-requests#approvals). But this is kind of a hot topic. Merging a couple days early.

@JoshuaKGoldberg JoshuaKGoldberg merged commit 7acfb5f into typescript-eslint:main Feb 10, 2025
62 of 63 checks passed
@JoshuaKGoldberg JoshuaKGoldberg deleted the no-misused-spread-string-report branch February 10, 2025 16:40
renovate bot added a commit to andrei-picus-tink/auto-renovate that referenced this pull request Feb 11, 2025
| datasource | package                          | from   | to     |
| ---------- | -------------------------------- | ------ | ------ |
| npm        | @typescript-eslint/eslint-plugin | 8.23.0 | 8.24.0 |
| npm        | @typescript-eslint/parser        | 8.23.0 | 8.24.0 |


## [v8.24.0](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/eslint-plugin/CHANGELOG.md#8240-2025-02-10)

##### 🚀 Features

-   **eslint-plugin:** \[no-unnecessary-condition] make `allowConstantLoopConditions` more granular ([#10639](typescript-eslint/typescript-eslint#10639))

##### 🩹 Fixes

-   **eslint-plugin:** \[no-misused-spread] correct and elaborate string spread report message ([#10751](typescript-eslint/typescript-eslint#10751))
-   **eslint-plugin:** \[restrict-plus-operands] report adding bigints to strings when `allowNumberAndString` is `false` ([#10737](typescript-eslint/typescript-eslint#10737))

##### ❤️ Thank You

-   Josh Goldberg ✨
-   noah
-   Ronen Amiel

You can read about our [versioning strategy](https://main--typescript-eslint.netlify.app/users/versioning) and [releases](https://main--typescript-eslint.netlify.app/users/releases) on our website.
renovate bot added a commit to andrei-picus-tink/auto-renovate that referenced this pull request Feb 11, 2025
| datasource | package                          | from   | to     |
| ---------- | -------------------------------- | ------ | ------ |
| npm        | @typescript-eslint/eslint-plugin | 8.23.0 | 8.24.0 |
| npm        | @typescript-eslint/parser        | 8.23.0 | 8.24.0 |


## [v8.24.0](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/eslint-plugin/CHANGELOG.md#8240-2025-02-10)

##### 🚀 Features

-   **eslint-plugin:** \[no-unnecessary-condition] make `allowConstantLoopConditions` more granular ([#10639](typescript-eslint/typescript-eslint#10639))

##### 🩹 Fixes

-   **eslint-plugin:** \[no-misused-spread] correct and elaborate string spread report message ([#10751](typescript-eslint/typescript-eslint#10751))
-   **eslint-plugin:** \[restrict-plus-operands] report adding bigints to strings when `allowNumberAndString` is `false` ([#10737](typescript-eslint/typescript-eslint#10737))

##### ❤️ Thank You

-   Josh Goldberg ✨
-   noah
-   Ronen Amiel

You can read about our [versioning strategy](https://main--typescript-eslint.netlify.app/users/versioning) and [releases](https://main--typescript-eslint.netlify.app/users/releases) on our website.
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Feb 18, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
1 approval >=1 team member has approved this PR; we're now leaving it open for more reviews before we merge
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Bug: [no-misused-spread] report for string spread harmfully conflates Unicode code points with UTF-16 code units
3 participants