-
Notifications
You must be signed in to change notification settings - Fork 48
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
Conversation
…ans bare templated attributes; align option notation style to ESLint
There was a problem hiding this 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 (`"`) |
There was a problem hiding this comment.
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.
- `"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 (`'`) |
There was a problem hiding this comment.
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.
- `"single"` enforces the use of single quotes (`'`) | |
- `"single"` enforces the use of single quotes (`'`). |
Copilot uses AI. Check for mistakes.
There was a problem hiding this 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!
Codecov ReportAll modified and coverable lines are covered by tests ✅
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
Flags with carried forward coverage won't be shown. Click here to find out more. 🚀 New features to boost your workflow:
|
Checklist
Description