Metadata-Version: 2.4
Name: robotpajamas.pants.pyrefly
Version: 0.0.1
Summary: A Pants plugin adding support for the Pyrefly type checker.
License: Apache License, Version 2.0
Project-URL: Documentation, https://github.com/sureshjoshi/pants-plugins
Project-URL: Source, https://github.com/sureshjoshi/pants-plugins
Project-URL: Tracker, https://github.com/sureshjoshi/pants-plugins/issues
Project-URL: Changelog, https://github.com/sureshjoshi/pants-plugins/blob/main/pants-plugins/experimental/pyrefly/CHANGELOG.md
Keywords: pants,pants-plugin,pyrefly
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Topic :: Software Development :: Build Tools
Requires-Python: >=3.11.0
Description-Content-Type: text/markdown
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: keywords
Dynamic: license
Dynamic: project-url
Dynamic: requires-python
Dynamic: summary

# pants-pyrefly-plugin

This plugin provides a Pants `check` backend using [Pyrefly](https://github.com/facebook/pyrefly) - the new Python type checker from Facebook.

## Installation

This plugin was tested on Python 3.11 and Pants 2.31.0.dev3.

Add the following to your `pants.toml` file:

```toml
[GLOBAL]
plugins = [
    ...
    "robotpajamas.pants.pyrefly",
]

...

backend_packages = [
    ...
    "experimental.pyrefly",
]
```

## Usage

This plugin is  even more beta than Pyrefly itself. It's largely just a copy/paste/rename of the [Ty plugin](https://pypi.org/project/robotpajamas.pants.ty/), so your mileage may vary.

`pants check --only=pyrefly src/foo/bar.py`

The hard part of adding a new linter or formatter isn't usually the code itself, it's how to untangle the mess of configurations for the tool and weave them into various Pants-isms (e.g. configurations, interpreter constraints, partitions, environment variables, reasonable defaults, escape hatches, etc...).
