facebook / pyre-check

Performant type-checking for python.
https://pyre-check.org/
MIT License
6.79k stars 432 forks source link

JSON schema for config file #888

Open niklasravnsborg opened 2 months ago

niklasravnsborg commented 2 months ago

Having a JSON schema for the config file (.pyre_configuration) would be beneficial. This would not only facilitate easier editing of configurations but could also enable auto-generation of documentation tables or other useful outputs.

Schemas can be integrated using the $schema key to enable editor completions:

"$schema": "url_to_schema",

For comparison, pyright already has a configuration schema here: https://github.com/microsoft/pyright/blob/main/packages/vscode-pyright/schemas/pyrightconfig.schema.json

Resources for creating a schema: