fix: reference/yaml.md

[zoomer-k]

add warning for dont add ./ in globbing section

Summary by CodeRabbit

• Documentation
  • Added a warning note about path configuration in YAML for ast-grep
  • Clarified that paths starting with ./ are not recognized by the tool
  • Provided guidance for correct rule path configuration

[coderabbitai]

Walkthrough

The pull request introduces a new warning note in the website/reference/yaml.md documentation file to clarify the correct path specification for ast-grep YAML configurations. The change provides guidance to users about avoiding the ./ prefix when defining rule paths, highlighting that such prefixes will prevent ast-grep from recognizing the specified paths.

Changes

File	Change Summary
website/reference/yaml.md	Added a warning note explaining that ./ prefixes in rule paths are not recognized by ast-grep

Poem

🐰 A Rabbit's Path Warning 🚧

Dot-slash, beware, it leads astray,
In ast-grep's world, it won't play,
Remove the prefix, keep paths clean,
Let rules shine bright, precise and keen!
A simple tweak, a config delight 🌟

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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 generate docstrings to generate docstrings for this PR. (Beta)
• @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: 0

🧹 Nitpick comments (1)

website/reference/yaml.md (1)

240-242: LGTM! Consider enhancing the warning with an example.

The warning is well-placed and clearly communicates the issue with ./ prefixes. To make it even more helpful, consider adding a before/after example:

 :::warning Don't add `./`
 Be sure to remove `./` to the beginning of your rules. ast-grep will not recognize the paths if you add `./`.
+
+Example:
+❌ files: ["./src/**/*.js"]
+✅ files: ["src/**/*.js"]
 :::

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 493f84a and 30f059d.

📒 Files selected for processing (1)

• website/reference/yaml.md (2 hunks)

🔇 Additional comments (1)

website/reference/yaml.md (1)

244-244: LGTM! Good practice adding a newline.

Adding a newline at the end of the file follows good formatting practices.