search

coderabbitai / coderabbit-docs

Official documentation of CodeRabbit: AI Code Reviews
https://docs.coderabbit.ai
7 stars 4 forks source link

feat: semgrep #98

Closed cr-ruhanmuzaffar closed 1 month ago

cr-ruhanmuzaffar commented 1 month ago

Summary by CodeRabbit

coderabbitaidev[bot] commented 1 month ago

[!CAUTION]

Review failed

The pull request is closed.

Walkthrough

The pull request introduces documentation for Semgrep, a static analysis tool, by adding a comprehensive guide in docs/tools/semgrep.md. This guide details the types of files and programming languages Semgrep can analyze, its configuration options, and provides a link to the Semgrep CLI reference. Additionally, it updates the documentation table in docs/tools/tools.md to include Semgrep, enhancing the overall resource for users regarding available tools.

Changes

Files Change Summary
docs/tools/semgrep.md Added a comprehensive guide to Semgrep, detailing file types, configuration, and CLI reference.
docs/tools/tools.md Added Semgrep entry in the documentation table, linking it to the new guide.

Possibly related PRs

Suggested reviewers

Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): > :bangbang: **IMPORTANT** > Auto-reply has been disabled for this repository in the CodeRabbit settings. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged. - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitaidev` in a new review comment at the desired location with your query. Examples: -- `@coderabbitaidev generate unit testing code for this file.` -- `@coderabbitaidev modularize this function.` - PR comments: Tag `@coderabbitaidev` 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: -- `@coderabbitaidev generate interesting stats about this repository and render them as a table.` -- `@coderabbitaidev read src/utils.ts and generate unit testing code.` -- `@coderabbitaidev read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` -- `@coderabbitaidev 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) - `@coderabbitaidev pause` to pause the reviews on a PR. - `@coderabbitaidev resume` to resume the paused reviews. - `@coderabbitaidev review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitaidev full review` to do a full review from scratch and review all the files again. - `@coderabbitaidev summary` to regenerate the summary of the PR. - `@coderabbitaidev resolve` resolve all the CodeRabbit review comments. - `@coderabbitaidev configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitaidev help` to get help. ### Other keywords and placeholders - Add `@coderabbitaidev ignore` anywhere in the PR description to prevent this PR from being reviewed. - Add `@coderabbitaidev summary` or `@coderabbitai summary` to generate the high-level summary at a specific location in the PR description. - Add `@coderabbitaidev` or `@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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.

[!TIP]

Early access features: enabled We are currently testing the following features in early access: - **OpenAI `o1` for code reviews**: OpenAI's new `o1` model is being tested for code reviews. This model has advanced reasoning capabilities and can provide more nuanced feedback on your code. Note: - You can enable or disable early access features from the CodeRabbit UI or by updating the CodeRabbit configuration file. - - Please join our [Discord Community](https://discord.com/invite/GsXnASn26c) to provide feedback and report issues on the [discussion post](https://discordapp.com/channels/1134356397673414807/1279579842131787838).