mention ast-grep-essentials

harjotgill · harjotgill · commit 882ae6496bc6 · 2024-04-21T21:47:44.000-07:00
diff --git a/docs/guides/configure-coderabbit.md b/docs/guides/configure-coderabbit.md
@@ -116,6 +116,10 @@ YAML settings:
          are stored.
        - **`util_dirs`**: The directory name where the custom `ast-grep` utils
          are stored.
+       - **`essential_rules`**: Enable the
+         [`ast-grep-essentials`](https://github.com/coderabbitai/ast-grep-essentials)
+         package, which contains community-driven security and best practice
+         rules.
        - **`packages`**: A package allows you to share rules across multiple
          projects. Essentially, a package is a collection of `ast-grep` rules.
      - **`github-checks`**: Configuration for GitHub Checks integration.
@@ -149,6 +153,7 @@ YAML settings:
            - "rules"
          util_dirs:
            - "utils"
+         essential_rules: true
          packages:
            - "my-awesome-org/my-awesome-package" # public GitHub repository that contains ast-grep rules
        github-checks:
