Update ast-grep docs with the new essential rules property #39
Conversation
WalkthroughWalkthroughThe changes in this update encompass a significant rebranding effort from "semgrep" to "ast-grep" across documentation and configurations. It includes adjustments to text formatting, YAML structure modifications, updates to package names, introduction of new properties for rules, and a focus on emphasizing security in package management. Changes
Possibly related issues
TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Additionally, you can add CodeRabbit Configration File (
|
✅ Deploy Preview for reliable-buttercream-0e11cf ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
Deploying coderabbit-docs with
|
| Latest commit: |
02b2f38
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://1ec9aa5e.coderabbit-docs.pages.dev |
| Branch Preview URL: | https://update-ast-grep-docs.coderabbit-docs.pages.dev |
![coderabbitaidev[bot]](https://avatars.githubusercontent.com/in/375467?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
Review Status
Configuration used: CodeRabbit UI
Files selected for processing (1)
- docs/guides/review-instructions.md (8 hunks)
Additional comments not posted (2)
docs/guides/review-instructions.md (2)
88-92: The introduction of theessential_rulesproperty and the custom package name underpackagesaligns well with the PR objectives of enhancing security and flexibility in rule management. Ensure that the formatorganization/repositoryfor package names is consistently applied across all documentation and examples.
117-118: The addition ofallandanycomposite rules enhances the expressiveness of rule definitions. This change supports the objective of providing users with more control over rule application. Ensure that examples of using these new properties are clear and accessible to users.
Co-authored-by: coderabbitaidev[bot] <142196860+coderabbitaidev[bot]@users.noreply.github.com>
There was a problem hiding this comment.
Actionable comments posted: 0
Review Status
Configuration used: CodeRabbit UI
Files selected for processing (1)
- docs/guides/review-instructions.md (7 hunks)
Additional comments not posted (5)
docs/guides/review-instructions.md (5)
23-23: Add a space after the colon for consistency, as previously suggested.- **`instructions`**:Review the JavaScript code against the Google JavaScript + **`instructions`**: Review the JavaScript code against the Google JavaScript
88-92: Consider clarifying the purpose and usage of theessential_rulesproperty in the YAML configuration. Explain how it affects the rule application process and what benefits it provides, especially in terms of security.
117-118: Theallandanycomposite rules are well-defined. Ensure that examples provided in the documentation are consistent with these definitions and accurately demonstrate their usage.
308-311: Correct the possessive form of "it's" to "its" and consider rephrasing to avoid the comma splice before "because", as previously suggested.- A set of essential security rules, because we value security, this package gets + A set of essential security rules. Because we value security, this package gets - it's own property in the `.coderabbit.yml` file, to make it easier to install and not overwrite. + its own property in the `.coderabbit.yml` file, to make it easier to install and not overwrite.
347-348: Ensure that the sentence starts with a capital letter and consider adding a comma before "and" for clarity, as previously suggested.- **rules** and **utils** directories are keywords and it should be the same. + **Rules** and **utils** directories are keywords, and it should be the same.
No description provided.