https://github.com/semgrep/semgrep-interfaces
Store the ATD/openapi/protobuf/... interfaces between semgrep components
https://github.com/semgrep/semgrep-interfaces
Last synced: about 1 month ago
JSON representation
Store the ATD/openapi/protobuf/... interfaces between semgrep components
- Host: GitHub
- URL: https://github.com/semgrep/semgrep-interfaces
- Owner: semgrep
- Created: 2022-05-03T07:47:40.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-04-12T22:46:43.000Z (about 1 year ago)
- Last Synced: 2024-04-13T19:49:46.744Z (about 1 year ago)
- Language: OCaml
- Size: 1.65 MB
- Stars: 13
- Watchers: 21
- Forks: 5
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# semgrep-interfaces
This repository contains IDL (Interface Definition Language) files specifying
the interface between different Semgrep components (e.g., between
the semgrep CLI and the playground). It also includes the schema for Semgrep rules,
as both Semgrep and Semgrep App rely on this.
This repository is meant to be used as a submodule.
You may need to install opam and mypy as pre-requisites for contributing to this repository.
To update an interface:
1. Run `make setup`
2. Run `eval $(opam env)`
3. Make changes to the appropriate .atd file or edit `generate.py`
4. Run `make`. This will propagate that change to the respective .py, .ts, .ml, etc.
---
The code in this repository is licensed under the terms of the [LGPL
2.1](LICENSE). For more information about the licensing details of Semgrep
itself see [our licensing page][semgrep-licensing].
[semgrep-licensing]: https://semgrep.dev/docs/licensing/