semgrep-rules

KO | EN

gitlite — search

#typescript #llm #machine-learning #deep-learning #linux #macos #java #windows #awesome #kubernetes #vue #awesome-list #ios #openai

(★ 66)

Semgrep rules specific to Frappe Framework

semgrep-rules Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Frappe Semgrep rules

Semgrep rules specific to [Frappe Framework](https://github.com/frappe/frappe)

These rules guard against typical mistakes or bad practices while working on Frappe Framework apps. Frappe's own apps also use this to simplify repetitive checks in code review process.

## How to Use in my app

### Github Action

You can use a GitHub Action to automatically validate changes with semgrep rules on all PRs.

```yaml
name: Linters

on:
  pull_request: { }

jobs:
  linters:
    name: Frappe Linter
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3

- name: Set up Python
        uses: actions/setup-python@v4
        with:
          python-version: '3.10'

- name: Download Semgrep rules
        run: git clone --depth 1 https://github.com/frappe/semgrep-rules.git frappe-semgrep-rules

- name: Download semgrep
        run: pip install semgrep

- name: Run Semgrep rules
        run: semgrep ci --config ./frappe-semgrep-rules/rules
```

### Manually / running semgrep locally

- Install and verify that semgrep works `semgrep --version`
- clone the rules repository with `git clone`
- Run semgrep specifying rules folder as config `semgrep --config=~/path/to/frappe-semgrep-rules/rules your_app_folder`

Tip: You can optionally pass `--severity=ERROR` to ignore rules that produce warnings and only catch errors.

## How to contribute new rules

- Read how Semgrep works: [Getting started with semgrep rules](https://semgrep.dev/docs/writing-rules/overview/)
- Write a rule. Make sure it doesn't have too many false positives.
- Write positive and negative test cases for rule you are adding: [Testing rules](https://semgrep.dev/docs/writing-rules/testing-rules/)

semgrep-rules

semgrep-rules Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

semgrep-rules

semgrep-rules Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README