👷 Add Prettier

[NatoBoram]

• Closes Install linters and create a pipeline #87

[cloudflare-workers-and-pages]

Deploying coderabbit-docs with    Cloudflare Pages

Latest commit:	7ca2ecf
Status:	✅  Deploy successful!
Preview URL:	https://998ce83a.coderabbit-docs.pages.dev
Branch Preview URL:	https://feature-prettier.coderabbit-docs.pages.dev

View logs

[coderabbitai]

Walkthrough

This pull request introduces several configuration and documentation changes aimed at standardizing coding styles and improving clarity. A new .editorconfig file is added to establish coding guidelines, while a .prettierignore file is created to specify files and directories that Prettier should ignore during formatting. Various documentation files are reformatted for consistency and clarity, and several source files have been updated to adhere to new formatting rules, including the removal of semicolons and adjustments to indentation styles.

Changes

File	Change Summary
.editorconfig	New file created to establish coding style guidelines, including settings for indentation and line endings.
.prettierignore	New file created to specify directories and files to be ignored by Prettier during formatting.
babel.config.js	Changed quotation marks from single to double quotes and adjusted indentation from spaces to tabs.
docs/Future Development.md	Minor formatting adjustments for clarity; content unchanged.
docs/about/features.md	Formatting adjustments for improved readability; content unchanged.
docs/about/pricing.md	Added "Plan Comparison" section; refined descriptions and corrected usage limits.
docs/guides/review-instructions.md	Minor textual adjustments for consistency; content unchanged.
docs/introduction.md	Added "What is CodeRabbit?" section; minor formatting adjustments.
docs/platforms/platforms.md	Adjusted table formatting for better alignment; content unchanged.
docs/self-hosted/azure-devops.md	Formatting adjustments for consistency; content unchanged.
docs/self-hosted/github.md	Clarified descriptions and standardized list formats; content unchanged.
docs/self-hosted/gitlab.md	Minor formatting adjustments for consistency; content unchanged.
docs/tools/cppcheck.md	Removed unnecessary space in the first sentence; content unchanged.
docs/tools/tools.md	Updated formatting for the "Supported Tools" table; content unchanged.
docusaurus.config.ts	Reformatting of configuration object for improved readability; no functional changes.
plugins/blog-plugin.js	Formatting changes and structure adjustments; no functional changes.
sidebars.ts	Formatting adjustments; no functional changes.
src/components/AiDisclaimer/AiDisclaimer.tsx	Removed semicolons and adjusted indentation; no functional changes.
src/components/AiDisclaimer/index.ts	Removed newline at the end of the file; export statement unchanged.
src/components/AiDisclaimer/style.css	Adjusted color values to lowercase hexadecimal format; no functional changes.
src/components/FeaturedPosts/FeaturedPosts.module.css	Reformatted CSS rules for consistent indentation; no functional changes.
src/components/FeaturedPosts/FeaturedPosts.tsx	Formatting changes and removal of semicolons; no functional changes.
src/components/ReportSchema.tsx	Removed trailing semicolons in import statements and return statement; no functional changes.
src/components/SchemaViewer.tsx	Minor formatting changes; no functional changes.
src/components/YamlEditor/YamlEditor.tsx	Removed semicolons and adjusted formatting; no functional changes.
src/css/custom.css	Indentation adjustments for CSS properties; no functional changes.
src/pages/index.module.css	Indentation adjustments for CSS rules; no functional changes.
src/theme/BlogPostItem/index.js	Formatting adjustments; no functional changes.
src/theme/Footer/index.js	Formatting changes; no functional changes.
tailwind.config.js	Indentation style changed from spaces to tabs; no functional changes.

Assessment against linked issues

Objective	Addressed	Explanation
Install linters and create a pipeline (#87)	✅

Possibly related PRs

• Future Development.md #111: Formatting adjustments in Future Development.md align with the new .editorconfig file for coding style guidelines.
• docs: enhance Support, Features, and Intro pages; improve image SEO, internal linking, clarity, and layout. #115: Enhancements in docs/about/features.md focus on clarity, similar to the objectives of the .editorconfig file.
• 👷 Add markdownlint pipeline #125: The addition of a markdownlint pipeline relates to the .editorconfig file, both aiming to improve code quality and consistency.

Suggested reviewers

• aravindputrevu
• tyaga001
• MonRay2024

Poem

In the land of code, where rabbits roam,
We tidy our scripts, make them feel home.
With tabs and new lines, we dance with glee,
A prettier project, for all to see! 🐇✨

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 8f2de5b and 7ca2ecf.

📒 Files selected for processing (3)

• docs/about/features.md (3 hunks)
• docs/guides/delete-account.md (0 hunks)
• docs/introduction.md (4 hunks)

💤 Files with no reviewable changes (1)

• docs/guides/delete-account.md

🚧 Files skipped from review as they are similar to previous changes (2)

• docs/about/features.md
• docs/introduction.md

---

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

[coderabbitai]

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 05a7eb7 and 8f2de5b.

⛔ Files ignored due to path filters (6)

• .github/workflows/algolia.yaml is excluded by !**/*.yaml
• .prettierrc.yaml is excluded by !**/*.yaml
• .vscode/extensions.json is excluded by !**/*.json
• package.json is excluded by !**/*.json
• static/schema/reporting.json is excluded by !**/*.json
• tsconfig.json is excluded by !**/*.json

📒 Files selected for processing (30)

• .editorconfig (1 hunks)
• .prettierignore (1 hunks)
• babel.config.js (1 hunks)
• docs/Future Development.md (1 hunks)
• docs/about/features.md (3 hunks)
• docs/about/pricing.md (1 hunks)
• docs/guides/review-instructions.md (1 hunks)
• docs/introduction.md (3 hunks)
• docs/platforms/platforms.md (2 hunks)
• docs/self-hosted/azure-devops.md (4 hunks)
• docs/self-hosted/github.md (4 hunks)
• docs/self-hosted/gitlab.md (4 hunks)
• docs/tools/cppcheck.md (1 hunks)
• docs/tools/tools.md (2 hunks)
• docusaurus.config.ts (1 hunks)
• plugins/blog-plugin.js (1 hunks)
• sidebars.ts (2 hunks)
• src/components/AiDisclaimer/AiDisclaimer.tsx (1 hunks)
• src/components/AiDisclaimer/index.ts (1 hunks)
• src/components/AiDisclaimer/style.css (1 hunks)
• src/components/FeaturedPosts/FeaturedPosts.module.css (1 hunks)
• src/components/FeaturedPosts/FeaturedPosts.tsx (1 hunks)
• src/components/ReportSchema.tsx (1 hunks)
• src/components/SchemaViewer.tsx (1 hunks)
• src/components/YamlEditor/YamlEditor.tsx (2 hunks)
• src/css/custom.css (1 hunks)
• src/pages/index.module.css (1 hunks)
• src/theme/BlogPostItem/index.js (1 hunks)
• src/theme/Footer/index.js (1 hunks)
• tailwind.config.js (1 hunks)

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

• .editorconfig
• .prettierignore
• babel.config.js
• docs/Future Development.md
• docs/about/features.md
• docs/guides/review-instructions.md
• docs/introduction.md
• docs/platforms/platforms.md
• docs/self-hosted/gitlab.md
• docs/tools/cppcheck.md
• docs/tools/tools.md
• plugins/blog-plugin.js
• sidebars.ts
• src/components/AiDisclaimer/index.ts
• src/components/AiDisclaimer/style.css
• src/components/FeaturedPosts/FeaturedPosts.module.css
• src/components/FeaturedPosts/FeaturedPosts.tsx
• src/components/ReportSchema.tsx
• src/components/SchemaViewer.tsx
• src/css/custom.css
• src/pages/index.module.css
• src/theme/BlogPostItem/index.js
• src/theme/Footer/index.js
• tailwind.config.js

🧰 Additional context used

🪛 LanguageTool

docs/self-hosted/azure-devops.md

[misspelling] ~8-~8: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...Ops. sidebar_position: 3 --- ## Create a Azure DevOps User - Username: Set ...

(EN_A_VS_AN)

docs/self-hosted/github.md

[grammar] ~31-~31: This phrase is duplicated. You should probably use “Pull request” only once.
Context: ...sue comment - Issues - Label - Public - Pull request - Pull request review - Pull request review comment - ...

(PHRASE_REPETITION)

---

[grammar] ~40-~40: This phrase is duplicated. You should probably use “ID Client” only once.
Context: ... information from the GitHub App - App ID - Client ID - Client Secret - Webhook Secret ## Prepare an ...

(PHRASE_REPETITION)

🪛 Gitleaks

docusaurus.config.ts

183-183: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.

(generic-api-key)

🪛 Biome

src/components/AiDisclaimer/AiDisclaimer.tsx

[error] 5-5: Don't use '{}' as a type.

Prefer explicitly define the object shape. '{}' means "any non-nullable value".

(lint/complexity/noBannedTypes)

src/components/YamlEditor/YamlEditor.tsx

[error] 53-53: Change to an optional chain.

Unsafe fix: Change to an optional chain.

(lint/complexity/useOptionalChain)

---

[error] 71-71: Change to an optional chain.

Unsafe fix: Change to an optional chain.

(lint/complexity/useOptionalChain)

🔇 Additional comments (1)

docs/about/pricing.md (1)

79-88: Well-structured comparison table.

The table provides a clear and comprehensive comparison of features between plans. The formatting is consistent and follows markdown best practices, making it easy to read and understand.