Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/coderabbitai/ast-grep-essentials
Community-led collection of essential ast-grep rules.
https://github.com/coderabbitai/ast-grep-essentials
Last synced: about 1 month ago
JSON representation
Community-led collection of essential ast-grep rules.
- Host: GitHub
- URL: https://github.com/coderabbitai/ast-grep-essentials
- Owner: coderabbitai
- License: apache-2.0
- Created: 2024-03-12T22:14:31.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2024-04-16T00:38:51.000Z (5 months ago)
- Last Synced: 2024-05-02T01:34:31.332Z (5 months ago)
- Homepage:
- Size: 80.1 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# AST-GREP Essentials
## Overview
`ast-grep-essentials` is a community-led collection of
[`ast-grep`](https://ast-grep.github.io) rules to help developers mitigate
security vulnerabilities and enforce best practices in their codebases.
> [!TIP]
>
> Please read the CodeRabbit
> [documentation](https://docs.coderabbit.ai/guides/review-instructions) to
> understand how to use `ast-grep` in [CodeRabbit](https://coderabbit.ai)
> reviews.
## Structure
```plaintext
ast-grep-essentials
│
├── rules
│ ├── javascript
│ │ ├── jwt
│ │ │ ├── rule1.yml
│ │ │ ├── rule2.yml
│ │ │ └── ...
│ │ ├── ...
│ │ └── ...
│ └── go
│ ├── jwt-go
│ │ ├── rule1.yml
│
├── utils
│ ├── script1.yml
│ ├── script2.yml
│ └── ...
│
└── tests
├── javascript
│ ├── rule1-test.yml
│ ├── rule2-test.yml
│ └── ...
├── ...
└── ...
```
The package is organized into three main directories:
- `rules`: Contains `ast-grep` rules categorized by language and security
category.
- `utils`: Houses utility configs to support rule management.
- `tests`: Includes test cases for validating the effectiveness of the rules
across different languages.
### Rules Structure
Within the `rules` directory, you'll find the following structure:
- `language`: Each language supported by `ast-grep` (e.g., Python, JavaScript).
- `category`: Rules categorized based on security concerns (e.g., Input
Validation, Authentication).
#### Rule file structure
> [!TIP]
>
> Read the `ast-grep` > documentation to understand the
> [rule configuration](https://ast-grep.github.io/reference/yaml.html) and the
> [rule object properties](https://ast-grep.github.io/reference/rule.html).
Each rule file should have the following structure:
```yaml
# Unique across the package, not just the language
id: rule-id
# The language property that the rule is going to get matched against
language: "language" # e.g., javaScript, go
# A short description of the rule
message: "Rule message"
# A more detailed explanation of the rule
note: "Rule note"
# Severity level of the rule (e.g., hint, warning)
severity: "severity"
# ast-grep rule property, check documentation for more information
rule: ...
```
### Tests Structure
Inside the `tests` directory, tests are organized by language:
- `language`: Test cases specific to the corresponding language's rules.
- `rule-file`: each test rule file should have by convention the
`rule-file-name-test.yml` format.
> [!NOTE]
>
> Tests should follow the `ast-grep` testing rules format. Please refer to the
> `ast-grep`
> [documentation](https://ast-grep.github.io/guide/test-rule.html#test-case-configuration)
## Contributing
This project relies on the community to contribute rules. Please open a pull
request with your rules and tests. Please ensure that the rules are truly
essential and have a low false positive rate.
## Community
Join the discussion on our [Discord server](https://discord.gg/C3rGCxHn).