-
-
Notifications
You must be signed in to change notification settings - Fork 0
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
docs(commitlint,eslint,prettier): improve README.md
file
#182
Conversation
Also add spell checker `cspell`.
🦋 Changeset detectedLatest commit: 92b4d20 The changes in this PR will be included in the next version bump. This PR includes changesets to release 3 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
WalkthroughThis update primarily focuses on enhancing the developer experience by updating dependencies, refining documentation, and introducing a spell checker tool. Key changes include dependency updates for Changes
Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
Quality Gate passedIssues Measures |
PR Description updated to latest commit (92b4d20) |
PR Review 🔍
Code feedback:
|
Failed to generate code suggestions for PR |
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.
Actionable comments posted: 3
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files ignored due to path filters (1)
bun.lockb
is excluded by!bun.lockb
Files selected for processing (11)
- .changeset/odd-lobsters-teach.md (1 hunks)
- .cspell.json (1 hunks)
- .vscode/settings.json (2 hunks)
- package.json (2 hunks)
- packages/commitlint-config/README.md (2 hunks)
- packages/eslint-config/CHANGELOG.md (3 hunks)
- packages/eslint-config/README.md (2 hunks)
- packages/eslint-config/src/typegen.d.ts (9 hunks)
- packages/prettier-config/CHANGELOG.md (1 hunks)
- packages/prettier-config/README.md (1 hunks)
- packages/tsconfig/CHANGELOG.md (1 hunks)
Files skipped from review due to trivial changes (2)
- .cspell.json
- packages/tsconfig/CHANGELOG.md
Additional context used
LanguageTool
.changeset/odd-lobsters-teach.md
[uncategorized] ~7-~7: You might be missing the article “the” here.
Context: ...heob/eslint-config': patch --- ImproveREADME.md
file and add spell checker.
[uncategorized] ~7-~7: You might be missing the article “a” here.
Context: ...h --- ImproveREADME.md
file and add spell checker.packages/prettier-config/README.md
[uncategorized] ~3-~3: A comma might be missing here.
Context: ...config To make my configurations a bit easier I share my [Prettier](https://prettier....
[uncategorized] ~33-~33: A comma might be missing here.
Context: ... ## Usage If you need to override some settings you can do it this way: ```js // .pret...packages/commitlint-config/README.md
[uncategorized] ~3-~3: Possible missing comma found.
Context: ...config To make my configurations a bit easier I share my [Commitlint](https://commitl...
[uncategorized] ~56-~56: Possible missing comma found.
Context: ... scopes or if you need to override some settings you can do it in the `commitlint.config...packages/prettier-config/CHANGELOG.md
[uncategorized] ~81-~81: “to the” seems less likely than “to”.
Context: ...//github.com/mheob)! - Format all files to the new tabs instead of spaces behavior - ...
[style] ~83-~83: Using many exclamation marks might seem excessive (in this case: 8 exclamation marks for a text that’s 3708 characters long)
Context: ...hanks @mheob! - Update dependencies ## 1.4.0 ### Mi...packages/eslint-config/CHANGELOG.md
[grammar] ~95-~95: A determiner may be missing.
Context: ...ub.com/mheob) ### Minor Changes - add newest rules fromeslint-plugin-unicorn
--> ...packages/eslint-config/README.md
[uncategorized] ~3-~3: A comma might be missing here.
Context: ...config To make my configurations a bit easier I share my [ESLint](https://eslint.org/...
[uncategorized] ~6-~6: This verb may not be in the correct tense. Consider changing the tense to fit the context better.
Context: ...IMPORTANT]\ > Since v6.0.0, this config is rewritten to the new [ESLint Flat confi...
[uncategorized] ~49-~49: It appears that a hyphen is missing (if ‘auto’ is not used in the context of ‘cars’).
Context: ... . --fix" } } ``` ## VS Code support (auto fix on save) Install [VS Code ESLint exten...
[typographical] ~114-~114: Consider adding a comma after ‘Normally’ for more clarity.
Context: ...h better organization and composition. Normally you only need to import themheob
pre...
[uncategorized] ~253-~253: This verb may not be in the correct form. Consider using a different form for this context.
Context: ...ally rather a dangerous move that might leading to potential naming collisions, pointed...
[grammar] ~253-~253: The modal verb ‘might’ requires the verb’s base form.
Context: ...level"** config per project, that might pivots the taste of how rules are named. > > T...
[uncategorized] ~255-~255: This verb does not appear to agree with the subject. Consider using a different form.
Context: ...res more about the user-facings DX, and try to ease out the implementation details....
[grammar] ~257-~257: In this context, the infinitive form should follow “to”.
Context: ...ill not a good idea. You might not want to doing this if you are maintaining your own es...
[style] ~259-~259: The phrase ‘feel free to’ is used quite frequently. Consider using a less frequent alternative to set your writing apart from others and make it sound more professional.
Context: ...maintaining your own eslint config. > > Feel free to open issues if you want to combine this...
[style] ~259-~259: For conciseness, consider replacing this expression with an adverb.
Context: ...figure out a way to make them work. But at this moment I have no plan to revert the renaming. ...
[style] ~261-~261: The adverb ‘also’ is commonly used to connect clauses and isn’t usually used at the end of a phrase or before a conjunction. Consider replacing it with a more formal alternative.
Context: ...t will automatically rename the plugins also for your custom configs. You can use th...
[typographical] ~390-~390: The word “otherwise” is an adverb that can’t be used like a conjunction, and therefore needs to be separated from the sentence.
Context: ...ould prompt you to install the required dependencies, otherwise, you can install them manually: ```bash...
[typographical] ~409-~409: The word “otherwise” is an adverb that can’t be used like a conjunction, and therefore needs to be separated from the sentence.
Context: ...ould prompt you to install the required dependencies, otherwise, you can install them manually: ```bash...
[typographical] ~428-~428: The word “otherwise” is an adverb that can’t be used like a conjunction, and therefore needs to be separated from the sentence.
Context: ...ould prompt you to install the required dependencies, otherwise, you can install them manually: ```bash...
[typographical] ~447-~447: The word “otherwise” is an adverb that can’t be used like a conjunction, and therefore needs to be separated from the sentence.
Context: ...ould prompt you to install the required dependencies, otherwise, you can install them manually: ```bash...
[typographical] ~466-~466: The word “otherwise” is an adverb that can’t be used like a conjunction, and therefore needs to be separated from the sentence.
Context: ...ould prompt you to install the required dependencies, otherwise, you can install them manually: ```bash...
Biome
.vscode/settings.json
[error] 10-10: Expected a property but instead found '// Disable the default formatter, use eslint instead'.
[error] 11-11: End of file expected
[error] 11-11: End of file expected
[error] 11-11: End of file expected
[error] 11-11: End of file expected
[error] 12-12: End of file expected
[error] 12-12: End of file expected
[error] 12-12: End of file expected
[error] 12-14: End of file expected
[error] 15-15: End of file expected
[error] 15-15: End of file expected
[error] 15-18: End of file expected
[error] 18-20: End of file expected
[error] 21-21: End of file expected
[error] 21-21: End of file expected
[error] 21-42: End of file expected
[error] 42-43: End of file expected
packages/eslint-config/src/typegen.d.ts
[error] 383-383: The computed expression can be simplified without the use of a string literal.
[error] 416-416: The computed expression can be simplified without the use of a string literal.
[error] 442-442: The computed expression can be simplified without the use of a string literal.
[error] 479-479: The computed expression can be simplified without the use of a string literal.
[error] 854-854: The computed expression can be simplified without the use of a string literal.
[error] 2727-2727: The computed expression can be simplified without the use of a string literal.
[error] 2732-2732: The computed expression can be simplified without the use of a string literal.
[error] 3082-3082: The computed expression can be simplified without the use of a string literal.
[error] 3150-3150: The computed expression can be simplified without the use of a string literal.
[error] 5476-5476: The computed expression can be simplified without the use of a string literal.
Markdownlint
packages/prettier-config/README.md
39-39: Column: 1
Hard tabs
40-40: Column: 1
Hard tabs
41-41: Column: 1
Hard tabs
52-52: Column: 1
Hard tabs
53-53: Column: 1
Hard tabs
54-54: Column: 1
Hard tabs
55-55: Column: 1
Hard tabs
56-56: Column: 1
Hard tabs
57-57: Column: 1
Hard tabs
58-58: Column: 1
Hard tabs
59-59: Column: 1
Hard tabs
61-61: Column: 1
Hard tabs
62-62: Column: 1
Hard tabs
63-63: Column: 1
Hard tabs
64-64: Column: 1
Hard tabs
65-65: Column: 1
Hard tabs
66-66: Column: 1
Hard tabs
67-67: Column: 1
Hard tabs
68-68: Column: 1
Hard tabs
69-69: Column: 1
Hard tabs
70-70: Column: 1
Hard tabs
71-71: Column: 1
Hard tabs
72-72: Column: 1
Hard tabs
73-73: Column: 1
Hard tabs
74-74: Column: 1
Hard tabs
75-75: Column: 1
Hard tabs
76-76: Column: 1
Hard tabs
77-77: Column: 1
Hard tabspackages/commitlint-config/README.md
39-39: Column: 1
Hard tabs
40-40: Column: 1
Hard tabs
41-41: Column: 1
Hard tabs
42-42: Column: 1
Hard tabs
43-43: Column: 1
Hard tabs
52-52: Column: 1
Hard tabs
70-70: Column: 1
Hard tabs
71-71: Column: 1
Hard tabs
72-72: Column: 1
Hard tabs
73-73: Column: 1
Hard tabs
74-74: Column: 1
Hard tabs
75-75: Column: 1
Hard tabspackages/eslint-config/README.md
42-42: Column: 1
Hard tabs
43-43: Column: 1
Hard tabs
44-44: Column: 1
Hard tabs
45-45: Column: 1
Hard tabs
57-57: Column: 1
Hard tabs
58-58: Column: 1
Hard tabs
59-59: Column: 1
Hard tabs
61-61: Column: 1
Hard tabs
62-62: Column: 1
Hard tabs
63-63: Column: 1
Hard tabs
65-65: Column: 1
Hard tabs
66-66: Column: 1
Hard tabs
67-67: Column: 1
Hard tabs
68-68: Column: 1
Hard tabs
69-69: Column: 1
Hard tabs
71-71: Column: 1
Hard tabs
72-72: Column: 1
Hard tabs
73-73: Column: 1
Hard tabs
74-74: Column: 1
Hard tabs
75-75: Column: 1
Hard tabs
76-76: Column: 1
Hard tabs
77-77: Column: 1
Hard tabs
78-78: Column: 1
Hard tabs
79-79: Column: 1
Hard tabs
80-80: Column: 1
Hard tabs
81-81: Column: 1
Hard tabs
82-82: Column: 1
Hard tabs
83-83: Column: 1
Hard tabs
85-85: Column: 1
Hard tabs
86-86: Column: 1
Hard tabs
87-87: Column: 1
Hard tabs
88-88: Column: 1
Hard tabs
89-89: Column: 1
Hard tabs
90-90: Column: 1
Hard tabs
91-91: Column: 1
Hard tabs
92-92: Column: 1
Hard tabs
93-93: Column: 1
Hard tabs
94-94: Column: 1
Hard tabs
95-95: Column: 1
Hard tabs
96-96: Column: 1
Hard tabs
97-97: Column: 1
Hard tabs
98-98: Column: 1
Hard tabs
99-99: Column: 1
Hard tabs
100-100: Column: 1
Hard tabs
101-101: Column: 1
Hard tabs
102-102: Column: 1
Hard tabs
103-103: Column: 1
Hard tabs
104-104: Column: 1
Hard tabs
105-105: Column: 1
Hard tabs
106-106: Column: 1
Hard tabs
107-107: Column: 1
Hard tabs
135-135: Column: 1
Hard tabs
136-136: Column: 1
Hard tabs
138-138: Column: 1
Hard tabs
139-139: Column: 1
Hard tabs
140-140: Column: 1
Hard tabs
141-141: Column: 1
Hard tabs
142-142: Column: 1
Hard tabs
144-144: Column: 1
Hard tabs
145-145: Column: 1
Hard tabs
147-147: Column: 1
Hard tabs
148-148: Column: 1
Hard tabs
149-149: Column: 1
Hard tabs
151-151: Column: 1
Hard tabs
162-162: Column: 1
Hard tabs
163-163: Column: 1
Hard tabs
164-164: Column: 1
Hard tabs
166-166: Column: 1
Hard tabs
167-167: Column: 1
Hard tabs
168-168: Column: 1
Hard tabs
169-169: Column: 1
Hard tabs
170-170: Column: 1
Hard tabs
171-171: Column: 1
Hard tabs
172-172: Column: 1
Hard tabs
173-173: Column: 1
Hard tabs
174-174: Column: 1
Hard tabs
188-188: Column: 1
Hard tabs
189-189: Column: 1
Hard tabs
190-190: Column: 1
Hard tabs
191-191: Column: 1
Hard tabs
192-192: Column: 1
Hard tabs
193-193: Column: 1
Hard tabs
194-194: Column: 1
Hard tabs
195-195: Column: 1
Hard tabs
196-196: Column: 1
Hard tabs
197-197: Column: 1
Hard tabs
198-198: Column: 1
Hard tabs
199-199: Column: 1
Hard tabs
200-200: Column: 1
Hard tabs
201-201: Column: 1
Hard tabs
202-202: Column: 1
Hard tabs
203-203: Column: 1
Hard tabs
204-204: Column: 1
Hard tabs
208-208: Column: 1
Hard tabs
209-209: Column: 1
Hard tabs
210-210: Column: 1
Hard tabs
211-211: Column: 1
Hard tabs
212-212: Column: 1
Hard tabs
213-213: Column: 1
Hard tabs
214-214: Column: 1
Hard tabs
215-215: Column: 1
Hard tabs
216-216: Column: 1
Hard tabs
217-217: Column: 1
Hard tabs
218-218: Column: 1
Hard tabs
219-219: Column: 1
Hard tabs
220-220: Column: 1
Hard tabs
221-221: Column: 1
Hard tabs
272-272: Column: 1
Hard tabs
273-273: Column: 1
Hard tabs
274-274: Column: 1
Hard tabs
275-275: Column: 1
Hard tabs
276-276: Column: 1
Hard tabs
277-277: Column: 1
Hard tabs
278-278: Column: 1
Hard tabs
279-279: Column: 1
Hard tabs
280-280: Column: 1
Hard tabs
281-281: Column: 1
Hard tabs
282-282: Column: 1
Hard tabs
283-283: Column: 1
Hard tabs
284-284: Column: 1
Hard tabs
285-285: Column: 1
Hard tabs
286-286: Column: 1
Hard tabs
287-287: Column: 1
Hard tabs
288-288: Column: 1
Hard tabs
299-299: Column: 1
Hard tabs
300-300: Column: 1
Hard tabs
301-301: Column: 1
Hard tabs
302-302: Column: 1
Hard tabs
303-303: Column: 1
Hard tabs
304-304: Column: 1
Hard tabs
305-305: Column: 1
Hard tabs
306-306: Column: 1
Hard tabs
307-307: Column: 1
Hard tabs
308-308: Column: 1
Hard tabs
309-309: Column: 1
Hard tabs
310-310: Column: 1
Hard tabs
311-311: Column: 1
Hard tabs
312-312: Column: 1
Hard tabs
313-313: Column: 1
Hard tabs
326-326: Column: 1
Hard tabs
327-327: Column: 1
Hard tabs
328-328: Column: 1
Hard tabs
329-329: Column: 1
Hard tabs
330-330: Column: 1
Hard tabs
331-331: Column: 1
Hard tabs
332-332: Column: 1
Hard tabs
333-333: Column: 1
Hard tabs
334-334: Column: 1
Hard tabs
335-335: Column: 1
Hard tabs
336-336: Column: 1
Hard tabs
337-337: Column: 1
Hard tabs
338-338: Column: 1
Hard tabs
339-339: Column: 1
Hard tabs
352-352: Column: 1
Hard tabs
365-365: Column: 1
Hard tabs
366-366: Column: 1
Hard tabs
367-367: Column: 1
Hard tabs
386-386: Column: 1
Hard tabs
405-405: Column: 1
Hard tabs
424-424: Column: 1
Hard tabs
443-443: Column: 1
Hard tabs
462-462: Column: 1
Hard tabs
496-496: Column: 1
Hard tabs
504-504: Column: 1
Hard tabs
519-519: Column: 1
Hard tabs
520-520: Column: 1
Hard tabs
521-521: Column: 1
Hard tabs
536-536: Column: 1
Hard tabs
546-546: Column: 1
Hard tabs
547-547: Column: 1
Hard tabs
548-548: Column: 1
Hard tabs
549-549: Column: 1
Hard tabs
550-550: Column: 1
Hard tabs
551-551: Column: 1
Hard tabs
Additional comments not posted (17)
.vscode/settings.json (1)
6-6
: The updates to markdown linting rules and file associations are correctly implemented.Also applies to: 26-41
package.json (1)
15-15
: The updates to scripts and devDependencies, including the addition of a spell checker, are correctly implemented.Also applies to: 34-41
packages/prettier-config/CHANGELOG.md (1)
81-81
: The updates to the changelog entries are correctly implemented.packages/eslint-config/CHANGELOG.md (2)
146-146
: Clear and concise update on simplifying sub configurations. Good job documenting this fix!
156-156
: Good documentation on the transition from tabs to spaces, enhancing readability and consistency.packages/eslint-config/README.md (3)
5-7
: Important update on the transition to ESLint Flat config, enhancing clarity for users on configuration changes.
31-31
: Inclusion of BUN in the installation instructions caters to a broader audience. Well done!
231-260
: Comprehensive explanation on plugin renaming. It's crucial to monitor for any potential naming collisions that might arise from this change.Verification successful
The search results indicate that there are no issues related to naming collisions reported in the repository. The only mentions of naming collisions are in the README file, which acknowledges the potential risk and provides guidance on how to handle it.
- : The documentation on plugin renaming is comprehensive and acknowledges the potential for naming collisions. No issues related to naming collisions have been reported in the repository.
Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify if there are any issues reported related to naming collisions since the renaming. # Test: Search for issues related to naming collisions. Expect: No recent issues. gh issue list --search "naming collisions"Length of output: 44
Script:
#!/bin/bash # Description: Verify if there are any mentions of naming collisions in the codebase and issues. # Search for mentions of naming collisions in the codebase rg -i "naming collision" . # Search for issues related to naming collisions gh issue list --search "collision"Length of output: 849
packages/eslint-config/src/typegen.d.ts (9)
16-20
: Looks good. Ensure the documentation link is up-to-date.
625-650
: The documentation links provided are helpful for understanding the purpose of each rule. Ensure that these rules are correctly implemented in the ESLint configuration.
4497-4497
: Markingts/prefer-ts-expect-error
as deprecated is a good practice if it's being replaced by a more appropriate rule. Ensure that this change is documented in the project's migration guide or changelog.
5502-5503
: The types forJSONArrayExpression
andJSONObjectExpression
are added. Ensure these are integrated properly in your ESLint rules where JSON structures are validated.
5502-5503
: The addition ofJSONArrayExpression
andJSONObjectExpression
types is noted. Ensure these types are utilized appropriately in your ESLint configurations to enforce coding standards related to JSON data handling.
5502-5503
: The introduction ofJSONArrayExpression
andJSONObjectExpression
types is a good enhancement. Make sure to document their usage clearly in the project's developer guidelines.
5502-5503
: The addition ofJSONArrayExpression
andJSONObjectExpression
types seems to be part of a larger configuration. Ensure these types are used consistently across your project.
671-791
: The rules added here are comprehensive and cover a wide range of import/export practices. Double-check that all these rules are compatible with your project's existing codebase to avoid extensive refactoring.
2839-2848
: The rules for React components look good. Verify that these rules do not conflict with any existing JSX patterns in your project.
'@mheob/eslint-config': patch | ||
--- | ||
|
||
Improve `README.md` file and add spell checker. |
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.
Consider adding articles for grammatical correctness.
- Improve `README.md` file and add spell checker.
+ Improve the `README.md` file and add a spell checker.
Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
Improve `README.md` file and add spell checker. | |
Improve the `README.md` file and add a spell checker. |
arrowParens: 'avoid', | ||
endOfLine: 'lf', | ||
printWidth: 100, | ||
proseWrap: 'always', | ||
singleQuote: true, | ||
semi: true, | ||
singleQuote: true, |
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.
Consider replacing hard tabs with spaces for consistency and readability in markdown files.
- arrowParens: 'avoid',
- endOfLine: 'lf',
- printWidth: 100,
- proseWrap: 'always',
- semi: true,
- singleQuote: true,
+ arrowParens: 'avoid',
+ endOfLine: 'lf',
+ printWidth: 100,
+ proseWrap: 'always',
+ semi: true,
+ singleQuote: true,
Also applies to: 61-61
Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
arrowParens: 'avoid', | |
endOfLine: 'lf', | |
printWidth: 100, | |
proseWrap: 'always', | |
singleQuote: true, | |
semi: true, | |
singleQuote: true, | |
arrowParens: 'avoid', | |
endOfLine: 'lf', | |
printWidth: 100, | |
proseWrap: 'always', | |
semi: true, | |
singleQuote: true, |
{ | ||
"config": { | ||
"commitizen": { | ||
"path": "node_modules/cz-git" | ||
} |
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.
Consider replacing hard tabs with spaces for consistency and readability in markdown files.
- "config": {
- "commitizen": {
- "path": "node_modules/cz-git"
- }
- }
+ "config": {
+ "commitizen": {
+ "path": "node_modules/cz-git"
+ }
+ }
Also applies to: 47-47, 56-56
Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
{ | |
"config": { | |
"commitizen": { | |
"path": "node_modules/cz-git" | |
} | |
{ | |
"config": { | |
"commitizen": { | |
"path": "node_modules/cz-git" | |
} |
### **User description** This PR was opened by the [Changesets release](https://github.com/changesets/action) GitHub action. When you're ready to do a release, you can merge this and the packages will be published to npm automatically. If you're not ready to do a release yet, that's fine, whenever you add more changesets to main, this PR will be updated. # Releases ## @mheob/commitlint-config@1.1.2 ### Patch Changes - [#182](#182) ([@mheob](https://github.com/mheob)): Improve `README.md` file and add spell checker. ## @mheob/eslint-config@6.1.1 ### Patch Changes - [#182](#182) ([@mheob](https://github.com/mheob)): Improve `README.md` file and add spell checker. ## @mheob/prettier-config@3.3.1 ### Patch Changes - [#182](#182) ([@mheob](https://github.com/mheob)): Improve `README.md` file and add spell checker. ___ ### **PR Type** Other ___ ### **Description** - Removed unnecessary changeset files. - Updated CHANGELOG files for `commitlint-config`, `eslint-config`, and `prettier-config` with patch changes. - Bumped versions for `commitlint-config`, `eslint-config`, and `prettier-config`. ___ ### **Changes walkthrough** 📝 <table><thead><tr><th></th><th align="left">Relevant files</th></tr></thead><tbody><tr><td><strong>Miscellaneous </strong></td><td><table> <tr> <td> <details> <summary><strong>hot-crews-fetch.md</strong><dd><code>Remove unnecessary changeset file.</code> </dd></summary> <hr> .changeset/hot-crews-fetch.md - Removed the changeset file. </details> </td> <td><a href="https://github.com/mheob/config/pull/183/files#diff-dd082bbce86dd50abefee0e51be98d22abcf211510ceac71ef05dfa1d13da1ce">+0/-2</a> </td> </tr> <tr> <td> <details> <summary><strong>odd-lobsters-teach.md</strong><dd><code>Remove unnecessary changeset file.</code> </dd></summary> <hr> .changeset/odd-lobsters-teach.md - Removed the changeset file. </details> </td> <td><a href="https://github.com/mheob/config/pull/183/files#diff-0378a91c3bf0a95f76811c7f2c1e834a09ddce6a74fe32459f78a53dbc29f3dd">+0/-7</a> </td> </tr> </table></td></tr><tr><td><strong>Documentation </strong></td><td><table> <tr> <td> <details> <summary><strong>CHANGELOG.md</strong><dd><code>Update CHANGELOG for commitlint-config to version 1.1.2.</code> </dd></summary> <hr> packages/commitlint-config/CHANGELOG.md - Added patch changes entry for version 1.1.2. </details> </td> <td><a href="https://github.com/mheob/config/pull/183/files#diff-8358a4cbef3dc34a22d58f21cc207d8b6e5e16faa9fc91ed6847741bb6fa3d12">+6/-0</a> </td> </tr> <tr> <td> <details> <summary><strong>CHANGELOG.md</strong><dd><code>Update CHANGELOG for eslint-config to version 6.1.1.</code> </dd></summary> <hr> packages/eslint-config/CHANGELOG.md - Added patch changes entry for version 6.1.1. </details> </td> <td><a href="https://github.com/mheob/config/pull/183/files#diff-6ea0f1f368fcd29c5a4ca206a2f182f90ce923447d83b31ce2674d19d51d33ca">+6/-0</a> </td> </tr> <tr> <td> <details> <summary><strong>CHANGELOG.md</strong><dd><code>Update CHANGELOG for prettier-config to version 3.3.1.</code> </dd></summary> <hr> packages/prettier-config/CHANGELOG.md - Added patch changes entry for version 3.3.1. </details> </td> <td><a href="https://github.com/mheob/config/pull/183/files#diff-ddb9fe629f21ee0433429ca77d6adeb79eac6b873067dba8669866330368fd60">+6/-0</a> </td> </tr> </table></td></tr><tr><td><strong>Configuration changes </strong></td><td><table> <tr> <td> <details> <summary><strong>package.json</strong><dd><code>Bump version for commitlint-config to 1.1.2.</code> </dd></summary> <hr> packages/commitlint-config/package.json - Bumped version from 1.1.1 to 1.1.2. </details> </td> <td><a href="https://github.com/mheob/config/pull/183/files#diff-87fd28eb27578b163254fbe53ccf45433b016160d257da77ca98bcb8564192a9">+1/-1</a> </td> </tr> <tr> <td> <details> <summary><strong>package.json</strong><dd><code>Bump version for eslint-config to 6.1.1.</code> </dd></summary> <hr> packages/eslint-config/package.json - Bumped version from 6.1.0 to 6.1.1. </details> </td> <td><a href="https://github.com/mheob/config/pull/183/files#diff-b398e019411e81059801ebf7fe19f6ebcad0bc316fd5c0449d8acdbee9d6d5de">+1/-1</a> </td> </tr> <tr> <td> <details> <summary><strong>package.json</strong><dd><code>Bump version for prettier-config to 3.3.1.</code> </dd></summary> <hr> packages/prettier-config/package.json - Bumped version from 3.3.0 to 3.3.1. </details> </td> <td><a href="https://github.com/mheob/config/pull/183/files#diff-c24a860d7309ff63e39189b46c5469be962d62ace30869867a50343943c68441">+1/-1</a> </td> </tr> </table></td></tr></tr></tbody></table> ___ > 💡 **PR-Agent usage**: >Comment `/help` on the PR to get a list of all available PR-Agent tools and their descriptions ## Summary by CodeRabbit - **New Features** - Added spell checker to `README.md` files for improved documentation quality. - **Documentation** - Enhanced `README.md` files for `@mheob/commitlint-config`, `@mheob/eslint-config`, and `@mheob/prettier-config`. - **Chores** - Updated version numbers for `@mheob/commitlint-config` to 1.1.2, `@mheob/eslint-config` to 6.1.1, and `@mheob/prettier-config` to 3.3.1.
PR Type
documentation, enhancement, configuration changes
Description
antfu/curly
,react/avoid-shorthand-boolean
, andreact/avoid-shorthand-fragment
.import
rules to versionv0.5.1
.unused-imports/no-unused-imports-ts
andunused-imports/no-unused-vars-ts
rules.antfu/consistent-list-newline
.cspell
script for spell checking and included@cspell/dict-de-de
andcspell
as development dependencies.commitlint-config
README.eslint-config
,prettier-config
, andtsconfig
.Changes walkthrough 📝
1 files
typegen.d.ts
Add new ESLint rules and update documentation links.
packages/eslint-config/src/typegen.d.ts
antfu/curly
,react/avoid-shorthand-boolean
,and
react/avoid-shorthand-fragment
.import
rules to versionv0.5.1
.unused-imports/no-unused-imports-ts
andunused-imports/no-unused-vars-ts
rules.antfu/consistent-list-newline
.7 files
odd-lobsters-teach.md
Add changeset note for patch updates.
.changeset/odd-lobsters-teach.md
@mheob/commitlint-config
,@mheob/prettier-config
, and@mheob/eslint-config
.README.md
Improve formatting and update file naming conventions.
packages/commitlint-config/README.md
CHANGELOG.md
Fix typos in changelog entries.
packages/eslint-config/CHANGELOG.md
README.md
Add extensive documentation for ESLint configuration.
packages/eslint-config/README.md
configurations.
CHANGELOG.md
Fix typos in changelog entries.
packages/prettier-config/CHANGELOG.md
README.md
Update Prettier configuration documentation.
packages/prettier-config/README.md
CHANGELOG.md
Fix typos in changelog entries.
packages/tsconfig/CHANGELOG.md
3 files
.cspell.json
Add spell checker configuration with custom words.
.cspell.json
settings.json
Update VS Code settings for markdown and ESLint validation.
.vscode/settings.json
package.json
Add spell checker script and dependencies.
package.json
cspell
script for spell checking.@cspell/dict-de-de
andcspell
as development dependencies.Summary by CodeRabbit
New Features
Documentation
README.md
foreslint-config
with comprehensive guidance on the new ESLint Flat config.prettier-config
documentation to reflect changes in configuration settings.Bug Fixes
tsconfig
CHANGELOG.md.Chores
package.json
.Style