Skip to content

docs(rule: quote): disclaimer enforceTemplatedAttrValue implicitly bans bare templated attributes, clarify object option #395

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

Merged
merged 1 commit into from
Jul 23, 2025

Conversation

jimmy-zhening-luo
Copy link
Contributor

  • also, align option notation style to ESLint

Checklist

Description

…ans bare templated attributes; align option notation style to ESLint
@jimmy-zhening-luo jimmy-zhening-luo changed the title docs(rule: quote): +disclaimer enforceTemplatedAttrValue implicitly bans bare templated attributes docs(rule: quote): disclaimer enforceTemplatedAttrValue implicitly bans bare templated attributes, clarify object option Jul 22, 2025
@yeonjuan yeonjuan requested review from Copilot and yeonjuan and removed request for Copilot July 23, 2025 13:08
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR improves the documentation for the quotes rule by clarifying the behavior of the enforceTemplatedAttrValue option and aligning the documentation style with ESLint conventions. The key changes include:

  • Clarified that the enforceTemplatedAttrValue: true option implicitly bans bare templated attributes
  • Updated the documentation format to match ESLint's standard option notation style
  • Restructured the options section to be more explicit about string vs object options

This rule has two options, a string option and an object option.

1. String option (quote style):
- `"double"` (default) enforces the use of double quotes (`"`)
Copy link
Preview

Copilot AI Jul 23, 2025

Choose a reason for hiding this comment

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

[nitpick] For consistency with ESLint documentation style, consider adding a period at the end of this sentence to match the punctuation pattern used in line 26.

Suggested change
- `"double"` (default) enforces the use of double quotes (`"`)
- `"double"` (default) enforces the use of double quotes (`"`).

Copilot uses AI. Check for mistakes.


1. String option (quote style):
- `"double"` (default) enforces the use of double quotes (`"`)
- `"single"` enforces the use of single quotes (`'`)
Copy link
Preview

Copilot AI Jul 23, 2025

Choose a reason for hiding this comment

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

[nitpick] For consistency with ESLint documentation style, consider adding a period at the end of this sentence to match the punctuation pattern used in line 26.

Suggested change
- `"single"` enforces the use of single quotes (`'`)
- `"single"` enforces the use of single quotes (`'`).

Copilot uses AI. Check for mistakes.

Copy link
Owner

@yeonjuan yeonjuan left a comment

Choose a reason for hiding this comment

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

Hi @jimmy-zhening-luo Thanks for the PR. LGTM!

Copy link

codecov bot commented Jul 23, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.52%. Comparing base (662b74c) to head (08e6a34).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #395   +/-   ##
=======================================
  Coverage   98.52%   98.52%           
=======================================
  Files          82       82           
  Lines        2651     2651           
  Branches      730      730           
=======================================
  Hits         2612     2612           
  Misses         39       39           
Flag Coverage Δ
unittest 98.52% <ø> (ø)

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

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@yeonjuan yeonjuan merged commit 54f6a75 into yeonjuan:main Jul 23, 2025
5 of 6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
2 participants