docs: mention `allowTemplateLiterals: "never"` for `@stylistic/quotes` rule by fisker · Pull Request #344 · prettier/eslint-config-prettier

fisker · 2025-08-07T14:40:46Z

@stylistic/quotes deprecated Boolean value for this option.

https://eslint.style/rules/quotes#options

Important

Update README.md to clarify allowTemplateLiterals option for @stylistic/quotes rule, using "never" instead of false.

Documentation:
- Update README.md to specify that @stylistic/quotes uses "never" instead of false for allowTemplateLiterals option.
- Clarifies configuration for disallowing unnecessary backticks in ESLint.

^{This description was created by}^{for 79d32c0. You can customize this summary. It will automatically update as commits are pushed.}

Summary by CodeRabbit

Documentation
- Clarified instructions for configuring the ESLint quotes rule to disallow unnecessary backticks, including a note on option value differences between ESLint core and the @stylistic/quotes plugin.

…` rule

changeset-bot · 2025-08-07T14:40:49Z

⚠️ No Changeset found

Latest commit: 79d32c0

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

coderabbitai · 2025-08-07T14:40:54Z

Walkthrough

The README documentation was updated to clarify the configuration of the ESLint quotes rule, specifically regarding the allowTemplateLiterals option and its differing values between ESLint core and the @stylistic/quotes plugin. No changes were made to code or exported entities.

Changes

Cohort / File(s)	Change Summary
Documentation Update `README.md`	Clarified ESLint `quotes` rule configuration, specifying differences in the `allowTemplateLiterals` option between ESLint core and the `@stylistic/quotes` plugin.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

A hop through docs, a tweak so neat,
To clarify how quotes compete.
Backticks beware, your time is brief—
The README brings you quick relief.
With options clear, the code is bright,
A rabbit’s guide to quoting right!

Note

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 9b0b0a4 and 79d32c0.

📒 Files selected for processing (1)

README.md (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (5)

GitHub Check: Test on windows-latest with Node.js 22
GitHub Check: Test on windows-latest with Node.js 18
GitHub Check: Test on windows-latest with Node.js 24
GitHub Check: Test on windows-latest with Node.js 20
GitHub Check: Test on windows-latest with Node.js 16

🔇 Additional comments (1)

README.md (1)

618-620: Clarification looks good – thanks for flagging the @stylistic/quotes nuance.

The parenthetical note accurately points out the "never" string required by @stylistic/quotes, which should save users from copy-pasting the core-rule example verbatim and running into deprecation warnings. No further changes needed here.

✨ Finishing Touches

🧪 Generate unit tests

Create PR with unit tests
Post copyable unit tests in a comment

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Explain this complex logic.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai explain this code block.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and explain its main purpose.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate docstrings to generate docstrings for this PR.
@coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
@coderabbitai generate unit tests to generate unit tests for this PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

pkg-pr-new · 2025-08-07T14:41:17Z

Open in StackBlitz

npm i https://pkg.pr.new/eslint-config-prettier@344

commit: 79d32c0

ellipsis-dev

Important

Looks good to me! 👍

Reviewed everything up to 79d32c0 in 1 minute and 16 seconds. Click for details.

Reviewed 13 lines of code in 1 files
Skipped 0 files when reviewing.
Skipped posting 1 draft comments. View those below.
Modify your settings and rules to customize what types of comments Ellipsis leaves. And don't forget to react with 👍 or 👎 to teach Ellipsis.

1. README.md:619

Draft comment:
The note clarifies that @stylistic/quotes now expects "never" instead of false. Consider updating the example configuration to use "never" for consistency.
Reason this comment was not posted:
Comment was not on a location in the diff, so it can't be submitted as a review comment.

Workflow ID: wflow_g1dSIPBG153LSxPB

^{You can customize}^{by changing your verbosity settings, reacting with 👍 or 👎, replying to comments, or adding code review rules.}

docs: mention allowTemplateLiterals: "never" for `@stylistic/quotes…

79d32c0

…` rule

ellipsis-dev Bot reviewed Aug 7, 2025

View reviewed changes

JounQin approved these changes Aug 7, 2025

View reviewed changes

JounQin merged commit 0637286 into prettier:main Aug 7, 2025
20 checks passed

fisker deleted the allowTemplateLiterals-never branch August 8, 2025 00:57

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

docs: mention `allowTemplateLiterals: "never"` for `@stylistic/quotes` rule#344

docs: mention `allowTemplateLiterals: "never"` for `@stylistic/quotes` rule#344
JounQin merged 1 commit into
prettier:mainfrom
fisker:allowTemplateLiterals-never

fisker commented Aug 7, 2025 •

edited by coderabbitai Bot

Loading

Uh oh!

changeset-bot Bot commented Aug 7, 2025

Uh oh!

coderabbitai Bot commented Aug 7, 2025 •

edited

Loading

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

pkg-pr-new Bot commented Aug 7, 2025

Uh oh!

ellipsis-dev Bot left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

Conversation

fisker commented Aug 7, 2025 • edited by coderabbitai Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

changeset-bot Bot commented Aug 7, 2025

⚠️ No Changeset found

Uh oh!

coderabbitai Bot commented Aug 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Estimated code review effort

Poem

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

pkg-pr-new Bot commented Aug 7, 2025

Uh oh!

ellipsis-dev Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

fisker commented Aug 7, 2025 •

edited by coderabbitai Bot

Loading

coderabbitai Bot commented Aug 7, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)