Recommended IDE Setup ✅
Writing code is good, but writing code with the assistance of autocomplete, autoformatting, error notifications, and linting is even better. ✨
You are not required to use the tools mentioned below in your IDE. However, keep in mind that once you finish your changes, your code must still conform to the project's quality standards.
No worries 💫
You will be able to detect and correct errors automatically with the help of predefined PDM scripts, even if you don't use any of the IDE integrations presented below.
This will be covered in a later section.
Linting and formatting 🦀
We use Ruff for linting and formatting within our codebase. It is recommended that you install an extension for this tool, to benefit from automatic linting and formatting.
Type checking 👮
Pyright is used for static type checking, enabling us to detect errors during coding instead of at runtime. It can also identify rare errors that would otherwise be time-consuming to diagnose. Installing an IDE extension for Pyright is recommended to receive notifications whenever an error is detected.