docs: flat config documentation

[DaveMBush]

Issue Number: #9

Body

Update documentation

Summary by CodeRabbit

• Documentation
  • Updated the README to enhance clarity on installation and configuration for the eslint-plugin-rxjs package.
  • Simplified configuration examples for both Flat and Legacy Configs, improving usability.
  • Clarified changes regarding rule removals and replacements, ensuring users have comprehensive guidance on available rules.

[coderabbitai]

Walkthrough

The README.md file for the eslint-plugin-rxjs package has been updated to reflect recent changes in configuration examples for both Flat and Legacy Configs. Key modifications include the replacement of the spread operator in the Flat Config example with a direct reference to rxjs.configs.recommended, and the addition of an extends property in the Legacy Config example. The documentation has been refined for clarity, emphasizing installation requirements and providing comprehensive guidance on configuration and usage.

Changes

File	Change Summary
packages/eslint-plugin-rxjs/README.md	- Updated Flat Config example to use rxjs.configs.recommended instead of spreading its rules. - Updated Legacy Config example to include extends: ["plugin:@smarttools/rxjs/recommended-legacy"]. - Enhanced documentation for installation and configuration clarity.

Possibly related PRs

• docs: update readme files #4: The changes in this PR also involve updates to the README.md file, specifically enhancing the documentation for Flat and Legacy Configs, which aligns with the main PR's focus on clarifying configuration examples.
• docs: correct documentation for flat recommended configuration #7: This PR addresses the documentation for the Flat Config recommended configuration, which is directly related to the changes made in the main PR regarding the integration of rxjs.configs.recommended.
• fix: lat config fix #8: Although this PR primarily focuses on fixing a configuration issue, it relates to the overall structure of the ESLint plugin configuration discussed in the main PR, particularly regarding how the recommended configuration is structured.

🐰 In the meadow, changes bloom bright,
The README shines, a guiding light.
Configs refined, rules now clear,
With each new line, we cheer and cheer!
For plugins that guide, and tests that pass,
Our coding journey is sure to amass! 🌼

---

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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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.
  • 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 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 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 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 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.

[nx-cloud]

☁️ Nx Cloud Report

CI is running/has finished running commands for commit 57f06db. As they complete they will appear below. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this CI Pipeline Execution

---

✅ Successfully ran 1 target

• nx affected -t lint test build

---

Sent with 💌 from NxCloud.

[coderabbitai]

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (1)

packages/eslint-plugin-rxjs/README.md (1)

77-77: Enhance the flat config documentation with additional context.

The flat config example is correct and follows best practices by using rxjs.configs.recommended directly. Consider adding a comment to clarify that this includes all recommended rules and that additional custom rules can be added in the subsequent config object.

 module.exports = [
+  // Include all recommended rules
   rxjs.configs.recommended,
   {
     files: ['**/*.ts'],
     plugins: {
       rxjs,
     },
+    // Add your custom rules here
   },
   // additional rules
 ];

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 89e834b and 57f06db.

📒 Files selected for processing (2)

• README.md (1 hunks)
• packages/eslint-plugin-rxjs/README.md (1 hunks)

🔇 Additional comments (1)

README.md (1)

77-77: Same improvements needed as in packages/eslint-plugin-rxjs/README.md