Add JSON schemas for pyrefly.toml and pyproject.toml validation #2100

Prathamesh-tech-eng · 2026-01-13T12:13:36Z

Description:
This PR adds JSON schemas (pyrefly.json and pyproject-tool-pyrefly.json) to enable editor support (auto-completion, validation, and documentation) for Pyrefly configuration files in pyrefly.toml and pyproject.toml.

Fixes #536

Notes:

I've constructed this schema based on crates/pyrefly_config/src/config.rs and and crates/pyrefly_config/src/base.rs
I used kebab-case for keys (e.g., project-includes) as defined by the Serde structs.
I placed the schema in the schemas/ directory

meta-cla · 2026-01-13T12:13:41Z

Hi @Prathamesh-tech-eng!

Thank you for your pull request and welcome to our community.

Action Required

In order to merge any pull request (code, docs, etc.), we require contributors to sign our Contributor License Agreement, and we don't seem to have one on file for you.

Process

In order for us to review and merge your suggested changes, please sign at https://code.facebook.com/cla. If you are contributing on behalf of someone else (eg your employer), the individual CLA may not be sufficient and your employer may need to sign the corporate CLA.

Once the CLA is signed, our tooling will perform checks and validations. Afterwards, the pull request will be tagged with CLA signed. The tagging process may take up to 1 hour after signing. Please give it that time before contacting us about it.

If you have received this in error or have any questions, please contact us at [email protected]. Thanks!

connernilsen

Hey @Prathamesh-tech-eng, thanks for working on this!

I have a few recommendations for changes, and an additional followup to make sure this is integrated into Schemastore as well.

For the followup, can we:

make a PR to schemastore to add our pyrefly.json there.
update their pyproject.toml to have a tool entry for Pyrefly.
Add some tests like the ones for pyproject.toml? Doesn't need to be a ton, but just some stuff to verify what we're doing is generally correct.

connernilsen · 2026-01-14T17:48:33Z

schemas/pyrefly.json

+          "errors": {
+            "description": "Error configuration overrides for matched files.",
+            "type": "object",
+            "additionalProperties": {
+              "type": "boolean"
+            }
+          },
+          "replace-imports-with-any": {
+            "description": "Module glob patterns to replace with typing.Any for matched files.",
+            "type": "array",
+            "items": {
+              "type": "string"
+            }
+          },
+          "untyped-def-behavior": {
+            "description": "Override untyped function behavior for matched files.",
+            "type": "string",
+            "enum": ["check-and-infer-return-type", "check-and-infer-return-any", "skip-and-infer-return-any"]
+          },
+          "ignore-errors-in-generated-code": {
+            "description": "Override generated code error handling for matched files.",
+            "type": "boolean"
+          }
+        }


I'm not sure if this is possible, so if you struggle to find a way to do this, don't worry about it.

Could we pull this out into a subschema and do two things with it?

flatten the subschema into the top-level object

reuse that sub-schema here

This would help us avoid redefining definitions in multiple places, which means we won't have to remember to update multiple things if there are changes to the config base object.

Again, not sure if flattening is possible, but it would be awesome if it works!

connernilsen · 2026-01-14T17:51:08Z

schemas/pyproject-tool-pyrefly.json

@@ -0,0 +1,277 @@
+{


If you look at how the pyproject.toml in schemastore works, we might be able to get away with just the pyrefly.json config below and reference it in a pyproject definition.

When we merge into schemastore, I'd like to follow those examples, so this file will be redundant.

connernilsen · 2026-01-14T17:51:45Z

schemas/pyrefly.json

+      "description": "The Python version to use for type checking. Format: <major>[.<minor>[.<micro>]]",
+      "type": "string",
+      "default": "3.13.0",
+      "pattern": "^\\d+(\\.\\d+)?(\\.\\d+)?$"


Awesome validation!

connernilsen · 2026-01-14T17:55:55Z

schemas/pyrefly.json

+        {
+          "if": {
+            "properties": {
+              "type": {"const": "buck"}
+            }
+          },
+          "then": {
+            "properties": {
+              "isolation-dir": true,
+              "extras": true
+            }
+          }
+        },
+        {
+          "if": {
+            "properties": {
+              "type": {"const": "custom"}
+            }
+          },
+          "then": {
+            "required": ["command"],
+            "properties": {
+              "command": true,
+              "repo_root": true
+            }
+          }
+        }


Is it possible to set not conditions here for the custom-only fields when using the buck type, and vice versa for custom with buck-only fields?

It might be possible to do a subschema for the buck and custom fields, specify both subschemas in the field definitions, and just list the subschemas here to simplify the conditions.

connernilsen · 2026-01-14T17:56:58Z

schemas/pyrefly.json

+              "isolation-dir": true,
+              "extras": true
+            }


Just to double check, these aren't required fields, right? Just fields that are allowed with the buck type?

connernilsen · 2026-01-14T17:57:19Z

schemas/pyrefly.json

+            "required": ["command"],
+            "properties": {
+              "command": true,
+              "repo_root": true


Repo root should be for all types, not just custom

- Extract configBase into reusable subschema - Flatten configBase properties into top-level schema - Reuse configBase in sub-config via - Fix build-system: move repo_root to all types, add not conditions - Simplify pyproject-tool-pyrefly.json to reference pyrefly.json - All tests passing

Prathamesh-tech-eng · 2026-01-15T07:50:22Z

@connernilsen I've addressed all the feedback! Here is a summary of the changes:

Extracted configBase to avoid repetition
I created a $defs/configBase section containing all the shared properties (like errors, untyped-def-behavior, replace-imports-with-any, etc.).
Flattened ConfigBase into the root
All configBase properties are now duplicated in the main properties section so they're available at the root level. This ensures the schema works correctly with additionalProperties: false.
Applied ConfigBase to sub-config
The sub-config items now use allOf with { "$ref": "#/$defs/configBase" }. This ensures that any future changes to the base config automatically propagate to sub-configs without manual duplication.
Fixed Build System Logic
I cleaned up the validation logic:

Moved repo_root: It is now a top-level property inside build-system, accessible to both buck and custom types (addressing your comment about it being for all types).

Added strict not conditions:

If type: "buck", the schema explicitly forbids command.

If type: "custom", the schema requires command but forbids isolation-dir and extras.

Clarified optional fields: isolation-dir and extras are defined as properties but not required (answering your question about them).

Simplified pyproject-tool-pyrefly.json
I updated this to just reference pyrefly.json via $ref rather than duplicating 270+ lines. This aligns with the SchemaStore pattern you mentioned.

Once this is approved, I'll proceed with opening the PR to SchemaStore.

Prathamesh-tech-eng added 3 commits January 13, 2026 17:11

Add schema files and update gitignore

245a912

Merge branch 'facebook:main' into main

866c805

Add missing skip-lsp-config-indexing field to schemas

ccc5f7b

Prathamesh-tech-eng mentioned this pull request Jan 13, 2026

Add Pyrefly config to schemastore #536

Open

meta-cla bot added the cla signed label Jan 13, 2026

stroxler assigned connernilsen Jan 13, 2026

connernilsen self-requested a review January 14, 2026 16:51

connernilsen requested changes Jan 14, 2026

View reviewed changes

Merge branch 'facebook:main' into main

926a43f

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Add JSON schemas for pyrefly.toml and pyproject.toml validation #2100

Add JSON schemas for pyrefly.toml and pyproject.toml validation #2100

Prathamesh-tech-eng commented Jan 13, 2026

Uh oh!

meta-cla bot commented Jan 13, 2026

Uh oh!

connernilsen left a comment

Uh oh!

connernilsen Jan 14, 2026

Uh oh!

connernilsen Jan 14, 2026

Uh oh!

connernilsen Jan 14, 2026

Uh oh!

connernilsen Jan 14, 2026

Uh oh!

connernilsen Jan 14, 2026

Uh oh!

connernilsen Jan 14, 2026

Uh oh!

Prathamesh-tech-eng commented Jan 15, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Add JSON schemas for pyrefly.toml and pyproject.toml validation #2100

Are you sure you want to change the base?

Add JSON schemas for pyrefly.toml and pyproject.toml validation #2100

Conversation

Prathamesh-tech-eng commented Jan 13, 2026

Uh oh!

meta-cla bot commented Jan 13, 2026

Action Required

Process

Uh oh!

connernilsen left a comment

Choose a reason for hiding this comment

Uh oh!

connernilsen Jan 14, 2026

Choose a reason for hiding this comment

Uh oh!

connernilsen Jan 14, 2026

Choose a reason for hiding this comment

Uh oh!

connernilsen Jan 14, 2026

Choose a reason for hiding this comment

Uh oh!

connernilsen Jan 14, 2026

Choose a reason for hiding this comment

Uh oh!

connernilsen Jan 14, 2026

Choose a reason for hiding this comment

Uh oh!

connernilsen Jan 14, 2026

Choose a reason for hiding this comment

Uh oh!

Prathamesh-tech-eng commented Jan 15, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants