Apr 6, 2024 · Apr 6, 2024 · Apr 6, 2024 · Apr 6, 2024 · Apr 6, 2024
diff --git a/docs/guides/review-instructions.md b/docs/guides/review-instructions.md

 - **`path`**: `**/*.js`

  **`instructions`**: Review the JavaScript code against the Google JavaScript
  **`instructions`**:Review the JavaScript code against the Google JavaScript
  style guide and point out any mismatches

 - **`path`**: `tests/**.*`
  #...
  tools:
    ast-grep:
      essential_rules: true # option to enable essential security rules
      rule_dirs:
        - "custom-name"
      packages:
        - "ast-grep-essentials" #default packageinstalled
        - "myorg/myawesomepackage" #custom packagename following the format organization/repository
  #...
 ```

  follows: { regex: "can|use|any" }
  precedes: { kind: "multi_keys", pattern: "in.sub" }
  # composite rule
  all: [{ pattern: "match.all" }, { kind: "match_all" }]
  any: [{ pattern: "match.any" }, { kind: "match_any" }]
  all: [{ pattern: "match.all" }, { kind: "match_all" }]
  any: [{ pattern: "match.any" }, { kind: "match_any" }]
  not: { pattern: "not.this" }
  matches: "utility-rule"
 ```
  #...
  tools:
    ast-grep:
      essential_rules: true
      rule_dirs:
        - "rules"
      util_dirs:
        - "utils"
      packages:
        - "ast-grep-essentials"
        - "my-awesome-org/my-awesome-package" # public repository that contains ast-grep rules
  #...
 ```

 Packages provided by Coderabbit are:

 - `ast-grep-essentials`: A set of essential security rules
 - `ast-grep-essentials`: A set of essential security rules. Because we value security, this package gets
  its own property in the `.coderabbit.yml` file, to make it easier to install and not overwrite. Check
  the [package repository](https://github.com/coderabbitai/ast-grep-essentials)
  for more information.

 To use a package, you need to add the package name to the `packages` field in
 the `.coderabbit.yml` file.
  #...
  tools:
    ast-grep:
      packages:
        - "ast-grep-essentials"
      essential_rules: true
      packages: # list of packages to install, in future coderabbit will provide a set of packages, beside the essentials one.
        - "my-awesome-org/my-awesome-package" # custom package name following the format organization/repository
  #...
 ```


 - should be a public repository
 - contains rules that follow the ast-grep rule format
 - has the following folder structure:

 ```text
 my-awesome-project   # project root
  |- rules           # rule directory
  | |- my-rule.yml
  |- utils           # utils directory
  | |- is-literal.yml
 ```

 **rules** and **utils** directories are keywords, and it should be the same. Inside each directory, the structure is up
 to you. You can also have any other root directories or files beside the two shown above.

 - package name should be in the format `organization/repository`

 ```yaml
Original file line number	Diff line number	Diff line change
Expand Up		@@ -20,7 +20,7 @@ style guide by file types or directories.

		- `path`: `*/.js`

		`instructions`: Review the JavaScript code against the Google JavaScript
		`instructions`:Review the JavaScript code against the Google JavaScript
petrisorcoderabbit marked this conversation as resolved. Show resolvedHide resolved
		style guide and point out any mismatches

		- `path`: `tests/*.`
Expand DownExpand Up		@@ -85,10 +85,11 @@ reviews:
		#...
		tools:
		ast-grep:
		essential_rules: true # option to enable essential security rules
		rule_dirs:
		- "custom-name"
		packages:
		- "ast-grep-essentials" #default packageinstalled
		- "myorg/myawesomepackage" #custom packagename following the format organization/repository
		#...
		```

Expand All		@@ -113,8 +114,8 @@ rule:
		follows: { regex: "can\|use\|any" }
		precedes: { kind: "multi_keys", pattern: "in.sub" }
		# composite rule
		all: [{ pattern: "match.all" }, { kind: "match_all" }]
		any: [{ pattern: "match.any" }, { kind: "match_any" }]
		all: [{ pattern: "match.all" }, { kind: "match_all" }]
		any: [{ pattern: "match.any" }, { kind: "match_any" }]
		not: { pattern: "not.this" }
		matches: "utility-rule"
		```
Expand DownExpand Up		@@ -265,12 +266,12 @@ reviews:
		#...
		tools:
		ast-grep:
		essential_rules: true
		rule_dirs:
		- "rules"
		util_dirs:
		- "utils"
		packages:
		- "ast-grep-essentials"
		- "my-awesome-org/my-awesome-package" # public repository that contains ast-grep rules
		#...
		```
Expand DownExpand Up		@@ -304,7 +305,10 @@ within your organization.

		Packages provided by Coderabbit are:

		- `ast-grep-essentials`: A set of essential security rules
		- `ast-grep-essentials`: A set of essential security rules. Because we value security, this package gets
		its own property in the `.coderabbit.yml` file, to make it easier to install and not overwrite. Check
		the [package repository](https://github.com/coderabbitai/ast-grep-essentials)
		for more information.

		To use a package, you need to add the package name to the `packages` field in
		the `.coderabbit.yml` file.
Expand All		@@ -315,8 +319,9 @@ reviews:
		#...
		tools:
		ast-grep:
		packages:
		- "ast-grep-essentials"
		essential_rules: true
		packages: # list of packages to install, in future coderabbit will provide a set of packages, beside the essentials one.
		- "my-awesome-org/my-awesome-package" # custom package name following the format organization/repository
		#...
		```

Expand All		@@ -329,6 +334,19 @@ Requirements for a package:

		- should be a public repository
		- contains rules that follow the ast-grep rule format
		- has the following folder structure:

		```text
		my-awesome-project # project root
		\|- rules # rule directory
		\| \|- my-rule.yml
		\|- utils # utils directory
		\| \|- is-literal.yml
		```

		rules and utils directories are keywords, and it should be the same. Inside each directory, the structure is up
		to you. You can also have any other root directories or files beside the two shown above.

		- package name should be in the format `organization/repository`

		```yaml
Expand Down