Skip to content
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

Merged
merged 1 commit into from
May 30, 2024

Conversation

mheob
Copy link
Owner

@mheob mheob commented May 30, 2024

PR Type

documentation, enhancement, configuration changes


Description

  • Added new ESLint rules for antfu/curly, react/avoid-shorthand-boolean, and react/avoid-shorthand-fragment.
  • Updated documentation links for several import rules to version v0.5.1.
  • Removed redundant unused-imports/no-unused-imports-ts and unused-imports/no-unused-vars-ts rules.
  • Added new options for antfu/consistent-list-newline.
  • Added a new spell checker configuration file with custom words and ignored paths.
  • Updated VS Code settings to include new allowed elements for markdown and added new languages to ESLint validation.
  • Added cspell script for spell checking and included @cspell/dict-de-de and cspell as development dependencies.
  • Improved formatting and updated file naming conventions in commitlint-config README.
  • Added extensive documentation for ESLint configuration, including sections for installation, usage, customization, and optional configurations.
  • Fixed typos in changelog entries for eslint-config, prettier-config, and tsconfig.

Changes walkthrough 📝

Relevant files
Enhancement
1 files
typegen.d.ts
Add new ESLint rules and update documentation links.         

packages/eslint-config/src/typegen.d.ts

  • Added new ESLint rules for antfu/curly, react/avoid-shorthand-boolean,
    and react/avoid-shorthand-fragment.
  • Updated documentation links for several import rules to version
    v0.5.1.
  • Removed redundant unused-imports/no-unused-imports-ts and
    unused-imports/no-unused-vars-ts rules.
  • Added new options for antfu/consistent-list-newline.
  • +62/-76 
    Documentation
    7 files
    odd-lobsters-teach.md
    Add changeset note for patch updates.                                       

    .changeset/odd-lobsters-teach.md

  • Added changeset note for patch updates to @mheob/commitlint-config,
    @mheob/prettier-config, and @mheob/eslint-config.
  • +7/-0     
    README.md
    Improve formatting and update file naming conventions.     

    packages/commitlint-config/README.md

    • Improved formatting and updated file naming conventions.
    +7/-5     
    CHANGELOG.md
    Fix typos in changelog entries.                                                   

    packages/eslint-config/CHANGELOG.md

    • Fixed typos in changelog entries.
    +3/-3     
    README.md
    Add extensive documentation for ESLint configuration.       

    packages/eslint-config/README.md

  • Added extensive documentation for ESLint configuration.
  • Included sections for installation, usage, customization, and optional
    configurations.
  • +542/-65
    CHANGELOG.md
    Fix typos in changelog entries.                                                   

    packages/prettier-config/CHANGELOG.md

    • Fixed typos in changelog entries.
    +1/-1     
    README.md
    Update Prettier configuration documentation.                         

    packages/prettier-config/README.md

    • Updated Prettier configuration documentation.
    +3/-2     
    CHANGELOG.md
    Fix typos in changelog entries.                                                   

    packages/tsconfig/CHANGELOG.md

    • Fixed typos in changelog entries.
    +2/-2     
    Configuration changes
    3 files
    .cspell.json
    Add spell checker configuration with custom words.             

    .cspell.json

  • Added a new spell checker configuration file.
  • Included custom words and ignored paths.
  • +49/-0   
    settings.json
    Update VS Code settings for markdown and ESLint validation.

    .vscode/settings.json

  • Updated VS Code settings to include new allowed elements for markdown.
  • Added new languages to ESLint validation.
  • +13/-5   
    package.json
    Add spell checker script and dependencies.                             

    package.json

  • Added cspell script for spell checking.
  • Added @cspell/dict-de-de and cspell as development dependencies.
  • +3/-0     

    💡 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

      • Introduced spell checker configuration for enhanced documentation accuracy.
      • Added support for additional file types in VS Code settings.
    • Documentation

      • Enhanced README.md for eslint-config with comprehensive guidance on the new ESLint Flat config.
      • Updated prettier-config documentation to reflect changes in configuration settings.
    • Bug Fixes

      • Corrected typos in tsconfig CHANGELOG.md.
    • Chores

      • Updated dependencies to latest patch versions.
      • Added new spell checker script and dependencies in package.json.
    • Style

      • Changed Prettier formatting behavior to use tabs instead of spaces.

    @mheob mheob added documentation Improvements or additions to documentation enhancement New feature or request prettier Belongs to prettier config commitlint Belongs to commitlint config labels May 30, 2024
    Copy link

    changeset-bot bot commented May 30, 2024

    🦋 Changeset detected

    Latest commit: 92b4d20

    The changes in this PR will be included in the next version bump.

    This PR includes changesets to release 3 packages
    Name Type
    @mheob/commitlint-config Patch
    @mheob/prettier-config Patch
    @mheob/eslint-config Patch

    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

    Copy link

    coderabbitai bot commented May 30, 2024

    Walkthrough

    This 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 commitlint-config, prettier-config, and eslint-config, extensive updates to README.md files, and the addition of a spell checker configuration. The updates also encompass adjustments in .vscode/settings.json and package.json to support new file types and spell checking capabilities.

    Changes

    Files/Paths Change Summary
    .changeset/odd-lobsters-teach.md Updated dependencies, enhanced README.md, and changed file extension in packages/commitlint-config/README.md.
    .cspell.json Introduced configuration settings for a spell checker tool, specifying language settings, paths to ignore, and custom words.
    .vscode/settings.json Added support for MD033 rule, removed "eslint.experimental.useFlatConfig": true, and added support for additional file types.
    package.json Added new script for spell checking, added dev dependencies for spell checking, and updated existing dependency.
    packages/eslint-config/CHANGELOG.md Simplified and fixed configuration descriptions, switched to TypeScript for source files, and corrected ESLint configuration file splits.
    packages/eslint-config/README.md Extensively updated to reflect changes related to the migration to the new ESLint Flat config, providing comprehensive guidance on configuring ESLint.
    packages/eslint-config/src/typegen.d.ts Added new ESLint rules for coding styles and conventions, including 'antfu/curly', 'react/avoid-shorthand-boolean', and 'react/avoid-shorthand-fragment'.
    packages/prettier-config/CHANGELOG.md Changed formatting behavior from spaces to tabs.
    packages/prettier-config/README.md Updated configuration for arrowParens, reordered settings, and added eslint-disable comment for perfectionist/sort-objects.
    packages/tsconfig/CHANGELOG.md Corrected typos in the description of changes, including "depricated" to "deprecated" and "Simpplify" to "Simplify".

    Poem

    In the code where changes flow,
    Dependencies updated, smooth as snow.
    Spell checkers dance, catching errs,
    ESLint guides with rules and cares.
    Documentation shines so bright,
    Prettier tabs align just right.
    A rabbit's joy in every byte! 🐇✨


    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?

    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>.
      • Generate unit testing code for this file.
      • 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 generate unit testing code for this file.
      • @coderabbitai modularize this function.
    • 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 generate interesting stats about this repository and render them as a table.
      • @coderabbitai show all the console.log statements in this repository.
      • @coderabbitai read src/utils.ts and generate unit testing code.
      • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
      • @coderabbitai help me debug CodeRabbit configuration file.

    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)

    • @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 resolve resolve all the CodeRabbit review comments.
    • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
    • @coderabbitai help to get help.

    Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

    CodeRabbit Configration 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.

    Copy link

    sonarcloud bot commented May 30, 2024

    Quality Gate Passed Quality Gate passed

    Issues
    0 New issues
    0 Accepted issues

    Measures
    0 Security Hotspots
    No data about Coverage
    0.0% Duplication on New Code

    See analysis details on SonarCloud

    Copy link
    Contributor

    PR Description updated to latest commit (92b4d20)

    Copy link
    Contributor

    PR Review 🔍

    ⏱️ Estimated effort to review [1-5]

    3, because the PR involves multiple configuration changes across various tools (ESLint, Prettier, TypeScript) and includes updates to documentation and settings. The changes are extensive and touch on many aspects of the project's setup, requiring a thorough review to ensure consistency and correctness.

    🧪 Relevant tests

    No

    ⚡ Possible issues

    Possible Bug: The new ESLint rule 'antfu/curly'?: Linter.RuleEntry<[]> might not be correctly configured. Typically, ESLint rules require a configuration object or array, but it is initialized with an empty array which might not be the intended usage.

    🔒 Security concerns

    No

    Code feedback:
    relevant filepackages/eslint-config/src/typegen.d.ts
    suggestion      

    Consider providing a specific configuration for the 'antfu/curly' rule if the empty array is not intended. This will ensure the rule is enforced correctly. [important]

    relevant line'antfu/curly'?: Linter.RuleEntry<[]>

    relevant file.vscode/settings.json
    suggestion      

    Since the ESLint flat config support is now stable, consider removing the experimental flag "eslint.experimental.useFlatConfig": true if it's no longer necessary. This can help avoid potential issues with future updates of ESLint. [medium]

    relevant line"eslint.experimental.useFlatConfig": true,

    relevant filepackage.json
    suggestion      

    Ensure that the new script "cspell": "cspell .", is integrated into the CI/CD pipelines to enforce spelling checks on new commits or during build processes. This integration helps maintain consistency in documentation and code comments. [important]

    relevant line"cspell": "cspell .",

    relevant filepackages/eslint-config/README.md
    suggestion      

    Update the documentation to include examples of how to override the new ESLint rules added in this PR, such as 'antfu/curly'. Providing examples can help users understand how to customize the rules to fit their coding standards. [medium]

    relevant line### Rules Overrides

    Copy link
    Contributor

    Failed to generate code suggestions for PR

    @kodiakhq kodiakhq bot merged commit d3dcaed into main May 30, 2024
    8 checks passed
    @kodiakhq kodiakhq bot deleted the doc/eslint-readme branch May 30, 2024 16:06
    Copy link

    @coderabbitai coderabbitai bot left a 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

    Commits

    Files that changed from the base of the PR and between 5c90c3a and 92b4d20.

    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 --- Improve README.md file and add spell checker.


    [uncategorized] ~7-~7: You might be missing the article “a” here.
    Context: ...h --- Improve README.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 from eslint-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 the mheob 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 tabs

    packages/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 tabs

    packages/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: Marking ts/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 for JSONArrayExpression and JSONObjectExpression are added. Ensure these are integrated properly in your ESLint rules where JSON structures are validated.


    5502-5503: The addition of JSONArrayExpression and JSONObjectExpression 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 of JSONArrayExpression and JSONObjectExpression types is a good enhancement. Make sure to document their usage clearly in the project's developer guidelines.


    5502-5503: The addition of JSONArrayExpression and JSONObjectExpression 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.
    Copy link

    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.

    Suggested change
    Improve `README.md` file and add spell checker.
    Improve the `README.md` file and add a spell checker.

    Comment on lines +52 to +57
    arrowParens: 'avoid',
    endOfLine: 'lf',
    printWidth: 100,
    proseWrap: 'always',
    singleQuote: true,
    semi: true,
    singleQuote: true,
    Copy link

    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.

    Suggested change
    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,

    Comment on lines +38 to +42
    {
    "config": {
    "commitizen": {
    "path": "node_modules/cz-git"
    }
    Copy link

    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.

    Suggested change
    {
    "config": {
    "commitizen": {
    "path": "node_modules/cz-git"
    }
    {
    "config": {
    "commitizen": {
    "path": "node_modules/cz-git"
    }

    kodiakhq bot pushed a commit that referenced this pull request May 30, 2024
    ### **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>&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; </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>&nbsp; &nbsp; &nbsp; </td>
    </tr>                    
    
    <tr>
      <td>
        <details>
          <summary><strong>odd-lobsters-teach.md</strong><dd><code>Remove unnecessary changeset file.</code>&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; </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>&nbsp; &nbsp; &nbsp; </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>&nbsp; </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>&nbsp; &nbsp; &nbsp; </td>
    </tr>                    
    
    <tr>
      <td>
        <details>
          <summary><strong>CHANGELOG.md</strong><dd><code>Update CHANGELOG for eslint-config to version 6.1.1.</code>&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; </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>&nbsp; &nbsp; &nbsp; </td>
    </tr>                    
    
    <tr>
      <td>
        <details>
          <summary><strong>CHANGELOG.md</strong><dd><code>Update CHANGELOG for prettier-config to version 3.3.1.</code>&nbsp; &nbsp; &nbsp; </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>&nbsp; &nbsp; &nbsp; </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>&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; </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>&nbsp; &nbsp; &nbsp; </td>
    </tr>                    
    
    <tr>
      <td>
        <details>
          <summary><strong>package.json</strong><dd><code>Bump version for eslint-config to 6.1.1.</code>&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; </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>&nbsp; &nbsp; &nbsp; </td>
    </tr>                    
    
    <tr>
      <td>
        <details>
          <summary><strong>package.json</strong><dd><code>Bump version for prettier-config to 3.3.1.</code>&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; </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>&nbsp; &nbsp; &nbsp; </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.
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Labels
    commitlint Belongs to commitlint config Configuration changes documentation Improvements or additions to documentation enhancement New feature or request prettier Belongs to prettier config Review effort [1-5]: 3
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    1 participant