fix: set to specific config file linter, formatter and use main as auto pr request branch

[andostronaut]

This is an automated pull request for branch fix/remove-json-from-eslint-filetypes-and-set-main-auto-pr-branch

Summary by CodeRabbit

• Documentation
  • Updated documentation content with improved navigation and metadata.
  • Added a new "Roadmap" section outlining upcoming enhancements.

[coderabbitai]

Walkthrough

This pull request updates various configuration and documentation files. The ESLint configuration in .eslintrc.json now extends Next.js rules for core web vitals and TypeScript. The GitHub Actions workflow in .github/workflows/pr.yml is adjusted to target the main branch instead of develop. A new .prettierrc.json file is added for consistent code formatting, and the inline Prettier and ESLint configurations are removed from package.json with a new Prettier dependency added. Additionally, minor documentation changes are applied by updating key names and adding a new Roadmap section.

Changes

Files	Change Summary
.eslintrc.json	Added configuration extending "next/core-web-vitals" and "next/typescript".
.github/workflows/pr.yml	Updated branch management: ignored branch changed from develop to main and updated the PULL_REQUEST_BRANCH environment variable.
.prettierrc.json	New Prettier configuration file with formatting options (e.g., no trailing commas, single quotes, max line length 100, etc.).
package.json	Added devDependency "prettier": "^3.5.1", and removed inline Prettier and ESLint configuration blocks.
src/.../drowser/_meta.ts and src/.../drowser/roadmap.mdx	Updated documentation: renamed meta key 'report-structure' to structure and added a new key/section for roadmap.

Possibly related PRs

• Develop #98: Involves similar modifications to the drowser meta file with key naming updates.
• Develop #89: Addresses workflow configuration changes related to branch management in GitHub Actions.

Poem

Hoppin’ through the code with glee,
I found some rules for Next.js spree.
A cleaner flow in action, neat and bright,
Prettier and docs now set just right.
With each change, my whiskers twitch with delight! 🐇✨

✨ Finishing Touches

• 📝 Generate Docstrings (Beta)

---

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 generate docstrings to generate docstrings for this PR. (Beta)
• @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.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (3)

src/pages/docs/drowser/roadmap.mdx (2)

4-4: Add a comma after "For now" for better readability.

-For now we don't have a roadmap, but we are working on it. Stay tuned! 
+For now, we don't have a roadmap, but we are working on it. Stay tuned! 

---

1-4: Consider enhancing the roadmap placeholder content.

While the current message is clear, consider adding more context about planned features or development direction to set user expectations.

Example enhancement:

 # Roadmap

-
-For now we don't have a roadmap, but we are working on it. Stay tuned! 
+While our detailed roadmap is still in development, we're actively working on:
+
+- Improving documentation
+- Enhancing user experience
+- Adding new features
+
+Stay tuned for updates! We welcome your feedback and suggestions.

🧰 Tools

🪛 LanguageTool

[typographical] ~3-~3: Consider adding a comma here.
Context: # Roadmap For now we don't have a roadmap, but we are wor...

(FOR_NOW_COMMA)

package.json (1)

1-38: Configuration Externalization and Cleanup

The removal of the inline ESLint and Prettier configuration blocks from this file (as noted in the PR summary) improves modularity by delegating configurations to dedicated files (i.e., .eslintrc.json and .prettierrc.json). Please ensure that these new files are correctly configured and referenced throughout the project.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 31e8db0 and c0eba27.

⛔ Files ignored due to path filters (1)

• pnpm-lock.yaml is excluded by !**/pnpm-lock.yaml

📒 Files selected for processing (6)

• .eslintrc.json (1 hunks)
• .github/workflows/pr.yml (2 hunks)
• .prettierrc.json (1 hunks)
• package.json (1 hunks)
• src/pages/docs/drowser/_meta.ts (1 hunks)
• src/pages/docs/drowser/roadmap.mdx (1 hunks)

✅ Files skipped from review due to trivial changes (2)

• .prettierrc.json
• .eslintrc.json

🧰 Additional context used

🪛 LanguageTool

src/pages/docs/drowser/roadmap.mdx

[typographical] ~3-~3: Consider adding a comma here.
Context: # Roadmap For now we don't have a roadmap, but we are wor...

(FOR_NOW_COMMA)

🔇 Additional comments (4)

src/pages/docs/drowser/_meta.ts (1)

1-9: LGTM! The meta object structure is well-organized.

The changes simplify the key names and follow a logical documentation flow, from installation to changelog. The addition of the roadmap section enhances the documentation structure.

.github/workflows/pr.yml (2)

6-6: Align Branch Ignoring with Updated Strategy

The workflow now ignores pushes on the main branch instead of develop. This update aligns with the new branch management strategy and prevents the workflow from triggering on changes to the main branch.

---

16-16: Updated Automatic PR Branch

The environment variable PULL_REQUEST_BRANCH has been updated to main (previously develop). This change ensures that the generated pull requests use main as the default branch, as intended.

package.json (1)

33-33: New Prettier Dependency Added

The addition of "prettier": "^3.5.1" in the devDependencies section is correct and supports consistent code formatting. This change is in line with moving configuration from the inline settings to a dedicated configuration file.