Add JSON schemas for pyrefly.toml and pyproject.toml validation by Prathamesh-tech-eng · Pull Request #2100 · facebook/pyrefly

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 cla@meta.com. 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!

schemas/pyproject-tool-pyrefly.json

schemas/pyrefly.json

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.

github-actions · 2026-01-30T00:39:27Z

This pull request has been automatically marked as stale because it has not had recent activity for more than 2 weeks.

If you are still working on this this pull request, please add a comment or push new commits to keep it active. Otherwise, please unassign yourself and allow someone else to take over.

Thank you for your contributions!

Prathamesh-tech-eng · 2026-01-31T13:44:23Z

Hi @connernilsen ,

Hope you're doing well. It's been a while since we last connected, so I just wanted to follow up and check if there have been any updates regarding the changes.

connernilsen · 2026-02-03T16:18:39Z

Hey @Prathamesh-tech-eng, sorry, I've had it open in my browser but haven't been able to spare the time to look into it yet. I'll sit down sometime this week and give a review

connernilsen

Hey @Prathamesh-tech-eng, things are looking good!

Just a quick question, were you able to test this? If so, how? I was quickly trying to load it in to see if there were things I could try out with it, but wasn't sure where to start.

Also, not sure if you saw this, but there's apparently a Rust schema generator that might be worth checking out too I heard about recently. If you're interested in making this a bigger project, we could add that to this or a follow up PR and work on adding some script that runs in CI to see if the version in schemastore is the same that we have generated internally.

.gitignore

schemas/pyrefly.json

connernilsen

Sorry just a few more requests.

Also test instructions if you have just so I can validate some things

schemas/pyrefly.json

Prathamesh-tech-eng · 2026-02-09T14:26:52Z

HI @connernilsen, Addressed all the feedback , here's a summary of the changes:

additionalProperties set to true
python-platform changed from enum to examples (non-exhaustive)
errors description clarified to note any valid error code works
Top-level schema now uses allOf with $ref to configBase (no duplication)
.gitignore updated to track test files and docs

To test : Run pip install jsonschema toml referencing then python schemas/validate_schemas.py. It validates both test TOML files against the schemas. You can also test in VS Code with the "Even Better TOML" extension.

I looked into schemars (https://github.com/GREsau/schemars), which can derive JSON Schema from Rust structs with #[derive(JsonSchema)]. That could auto-generate these schemas from ConfigBase/ConfigFile and we could add a CI check to detect drift between the generated schema and what's in schemastore. Happy to explore that as a follow-up PR if you think it's worth pursuing.

…ow additionalProperties, make python-platform non-exhaustive

- errors: accept both boolean and severity strings (ignore/info/warn/error) - Add missing configBase fields: tensor-shapes, recursion-depth-limit, recursion-overflow-handler - Add 'ty' to enabled-ignores enum - Fix project-includes default to include **/*.ipynb - Add baseline field (top-level) - Remove non-existent repo_root from build-system - Add ignore-if-build-system-missing and search-path-prefix to build-system - Fix pyproject-tool-pyrefly.json to use relative path - Update test files to exercise new fields and severity strings

Prathamesh-tech-eng · 2026-02-09T16:18:13Z

I have also Performed additional fixes found during cross-referencing the schema against the Rust config source of truth:

errors values: Now accepts both booleans and severity strings ("ignore", "info", "warn", "error") via oneOf, matching the Rust Severity enum
Missing configBase fields: Added tensor-shapes, recursion-depth-limit, recursion-overflow-handler (these were present in Rust's ConfigBase but missing from the schema; they also apply to sub-config items via $ref)
enabled-ignores: Added missing "ty" variant (for # ty: ignore directives)
project-includes default: Fixed from ["**/*.py*"] to ["**/*.py*", "**/*.ipynb"] to match the Rust default
baseline: Added missing top-level string field for suppressing existing errors
build-system: Removed non-existent repo_root field (computed at runtime, not a config option), added ignore-if-build-system-missing (boolean) and search-path-prefix (array) which were present in the Rust BuildSystem struct
pyproject-tool-pyrefly.json: Changed $ref from https://pyrefly.org/schemas/pyrefly.json to relative pyrefly.json so it resolves locally without depending on the URL being live
Test files: Updated to exercise severity string values (missing-import = "warn", invalid-argument = "error") and the newly added fields

connernilsen · 2026-02-09T16:59:47Z

I looked into schemars (https://github.com/GREsau/schemars), which can derive JSON Schema from Rust structs with #[derive(JsonSchema)]. That could auto-generate these schemas from ConfigBase/ConfigFile and we could add a CI check to detect drift between the generated schema and what's in schemastore. Happy to explore that as a follow-up PR if you think it's worth pursuing.

Yeah, that would be awesome if you're interested! If not, then we can file that as a task and come back to it later!

Also, thanks for doing all of this, it looks awesome! I'm going to pull this in and start testing it, and I'll merge it and let you know if there are any followups.

meta-codesync · 2026-02-09T17:01:47Z

@connernilsen has imported this pull request. If you are a Meta employee, you can view this in D92721357.

Prathamesh-tech-eng · 2026-02-10T11:56:34Z

Thanks! Yeah, I'm definitely interested. I'll start looking into schemars and see how it can be integrated to auto-generate the schemas from the Rust config structs. I'll open a follow-up PR once I have something working. Might ping you if I run into any blockers!

And glad the schemas look good, let me know if anything comes up during testing!

grievejia

Review automatically exported from Phabricator review in Meta.

meta-codesync · 2026-02-13T17:14:55Z

@connernilsen merged this pull request in 4fc48b4.

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

Closed

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

github-actions bot added the stale label Jan 30, 2026

Prathamesh-tech-eng requested a review from connernilsen January 31, 2026 13:36

github-actions bot removed the stale label Feb 1, 2026

connernilsen reviewed Feb 6, 2026

View reviewed changes

.gitignore Show resolved Hide resolved

schemas/pyrefly.json Outdated Show resolved Hide resolved

connernilsen requested changes Feb 6, 2026

View reviewed changes

schemas/pyrefly.json Show resolved Hide resolved

schemas/pyrefly.json Outdated Show resolved Hide resolved

schemas/pyrefly.json Outdated Show resolved Hide resolved

Merge branch 'facebook:main' into main

5b69593

Address review: add test files, refactor schema to use allOf/ref, all…

347c65c

…ow additionalProperties, make python-platform non-exhaustive

Prathamesh-tech-eng force-pushed the main branch from f44cbc2 to 347c65c Compare February 9, 2026 14:30

grievejia approved these changes Feb 12, 2026

View reviewed changes

meta-codesync bot closed this in 4fc48b4 Feb 13, 2026

facebook-github-bot added the Merged label Feb 13, 2026

connernilsen mentioned this pull request Feb 17, 2026

JSONSchema for Pyrefly #2448

Open

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!

Uh oh!

Uh oh!

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!

github-actions bot commented Jan 30, 2026

Uh oh!

Prathamesh-tech-eng commented Jan 31, 2026

Uh oh!

connernilsen commented Feb 3, 2026

Uh oh!

connernilsen left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

connernilsen left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Prathamesh-tech-eng commented Feb 9, 2026

Uh oh!

Prathamesh-tech-eng commented Feb 9, 2026

Uh oh!

connernilsen commented Feb 9, 2026

Uh oh!

meta-codesync bot commented Feb 9, 2026

Uh oh!

Prathamesh-tech-eng commented Feb 10, 2026

Uh oh!

grievejia left a comment

Choose a reason for hiding this comment

Uh oh!

meta-codesync bot commented Feb 13, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants