Skip to content

fix: update uncloneable options error message #20059

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 4 commits into from
Sep 3, 2025
Merged

fix: update uncloneable options error message #20059

merged 4 commits into from
Sep 3, 2025
+7 −7

Conversation

cosmic-pixel-painter
Copy link
Contributor

@cosmic-pixel-painter cosmic-pixel-painter commented Aug 30, 2025 •
edited
Loading

Prerequisites checklist

What is the purpose of this pull request? (put an "X" next to an item)

[ ] Documentation update
[ ] Bug fix (template)
[ ] New rule (template)
[ ] Changes an existing rule (template)
[ ] Add autofix to a rule
[ ] Add a CLI option
[x] Add something to the core
[ ] Other, please explain:

What changes did you make? (Give an overview)

This change updates the error message for UNCLONEABLE_OPTIONS. I was reading the latest blog post about multithreading in eslint. It's a fantastic new feature and the post is great. When I reached the section about the cloneablity requirement, I thought it was helpful how the author mentioned some example cloneables in the text, but then noticed the error message itself didn't:

The option “ruleFilter” cannot be cloned. When concurrency is enabled, all options must be cloneable. Remove uncloneable options or use an options module.

to

The option “ruleFilter” cannot be cloned. When concurrency is enabled, all options must be cloneable values--such as primitives, plain objects, or arrays. Remove uncloneable options or use an options module.`,

I thought it would be helpful to add those examples directly in the error message. Users will get an additional hint about what is causing the error and it will help narrow the fix.

Is there anything you'd like reviewers to focus on?

  • lib/eslint/eslint.js

@cosmic-pixel-painter cosmic-pixel-painter requested a review from a team as a code owner August 30, 2025 13:35
@github-project-automation github-project-automation bot moved this to Needs Triage in Triage Aug 30, 2025
@eslint-github-bot
Copy link

Hi @soda-sorcery!, thanks for the Pull Request

The pull request title isn't properly formatted. We ask that you update the pull request title to match this format, as we use it to generate changelogs and automate releases.

  • The commit message tag wasn't recognized. Did you mean "docs", "fix", or "feat"?
  • There should be a space following the initial tag and colon, for example 'feat: Message'.
  • The first letter of the tag should be in lowercase

To Fix: You can fix this problem by clicking 'Edit' next to the pull request title at the top of this page.

Read more about contributing to ESLint here

@linux-foundation-easycla Linux Foundation: EasyCLA
Copy link

linux-foundation-easycla bot commented Aug 30, 2025 •
edited
Loading

CLA Signed

The committers listed above are authorized under a signed CLA.

@github-actions github-actions bot added cli Relates to ESLint's command-line interface core Relates to ESLint's core APIs and features labels Aug 30, 2025
@netlify Netlify
Copy link

netlify bot commented Aug 30, 2025 •
edited
Loading

✅ Deploy Preview for docs-eslint ready!

Name Link
🔨 Latest commit 5fc9d1a
🔍 Latest deploy log https://app.netlify.com/projects/docs-eslint/deploys/68b71c87d17492000891ba31
😎 Deploy Preview https://deploy-preview-20059--docs-eslint.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

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

@eslint-github-bot
Copy link

Hi @soda-sorcery!, thanks for the Pull Request

The pull request title isn't properly formatted. We ask that you update the pull request title to match this format, as we use it to generate changelogs and automate releases.

  • The commit message tag wasn't recognized. Did you mean "docs", "fix", or "feat"?
  • There should be a space following the initial tag and colon, for example 'feat: Message'.
  • The first letter of the tag should be in lowercase

To Fix: You can fix this problem by clicking 'Edit' next to the pull request title at the top of this page.

Read more about contributing to ESLint here

@cosmic-pixel-painter cosmic-pixel-painter changed the title Refactor: Update uncloneable options error message refactor: Update uncloneable options error message Aug 30, 2025
@eslint-github-bot eslint-github-bot bot added the chore This change is not user-facing label Aug 30, 2025
@cosmic-pixel-painter cosmic-pixel-painter changed the title refactor: Update uncloneable options error message feat: Update uncloneable options error message Aug 30, 2025
@eslint-github-bot eslint-github-bot bot added the feature This change adds a new feature to ESLint label Aug 30, 2025
@cosmic-pixel-painter cosmic-pixel-painter changed the title feat: Update uncloneable options error message feat: update uncloneable options error message Aug 30, 2025
@nzakas nzakas changed the title feat: update uncloneable options error message fix: update uncloneable options error message Sep 2, 2025
@eslint-github-bot eslint-github-bot bot added the bug ESLint is working incorrectly label Sep 2, 2025
nzakas
nzakas reviewed Sep 2, 2025
View reviewed changes
@nzakas nzakas moved this from Needs Triage to Implementing in Triage Sep 2, 2025
@cosmic-pixel-painter cosmic-pixel-painter force-pushed the uncloneable-options-error-msg-suggestion branch from 0cda265 to b52ae57 Compare September 2, 2025 16:03
@cosmic-pixel-painter
Copy link
Contributor Author

Changes were made. I think it flows better with this update.

nzakas
nzakas approved these changes Sep 3, 2025
View reviewed changes
Copy link
Member

@nzakas nzakas left a comment

Choose a reason for hiding this comment

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

LGTM. Thanks!

@nzakas nzakas merged commit 10e7ae2 into eslint:main Sep 3, 2025
30 checks passed
@github-project-automation github-project-automation bot moved this from Implementing to Complete in Triage Sep 3, 2025
nzakas pushed a commit that referenced this pull request Sep 23, 2025
@cosmic-pixel-painter @nzakas
fix: update uncloneable options error message (#20059)
5bf4936 
* refactor: updated uncloneable-options error message to give more clarity

* updated tests to match error message change

* fix: language clean-up for clarity
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@nzakas nzakas nzakas approved these changes

Assignees

No one assigned

Labels

bug ESLint is working incorrectly chore This change is not user-facing cli Relates to ESLint's command-line interface core Relates to ESLint's core APIs and features feature This change adds a new feature to ESLint

Projects

Triage
Status: Complete

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@cosmic-pixel-painter @nzakas