Preconfigured code formatting and linting.
Project description
plain.code
Preconfigured code formatting and linting.
Overview
The plain code command provides comprehensive code quality tools:
- Ruff - Python linting and formatting
- ty - Python type checking
- Biome - JavaScript, JSON, and CSS formatting
Ruff and ty are installed as Python dependencies. Biome is managed automatically as a standalone binary (npm is not required).
The most used command is plain code fix, which can be run using the alias plain fix:
plain fix
This will automatically fix linting issues and format your code according to the configured rules.
To check your code without making changes (including type checking):
plain code check
You can skip specific tools if needed:
# Skip type checking during rapid development
plain code check --skip-ty
# Only run type checks
plain code check --skip-ruff --skip-biome
# Skip Biome checks
plain code check --skip-biome
If plain.dev is installed then plain code check will be run automatically as a part of plain precommit to help catch issues before they are committed.
Configuration
Default configuration is provided by ruff_defaults.toml and biome_defaults.json.
You can customize the behavior in your pyproject.toml:
[tool.plain.code]
exclude = ["path/to/exclude"]
[tool.plain.code.ty]
enabled = true # Set to false to disable ty
[tool.plain.code.biome]
enabled = true # Set to false to disable Biome
version = "1.5.3" # Pin to a specific version
For more advanced configuration options, see get_code_config.
Generally it's expected that you won't change the configuration! We've tried to pick defaults that "just work" for most projects. If you find yourself needing to customize things, you should probably just move to using the tools themselves directly instead of the plain.code package.
Installation
Install the plain.code package from PyPI:
uv add plain.code
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file plain_code-0.15.0.tar.gz.
File metadata
- Download URL: plain_code-0.15.0.tar.gz
- Upload date:
- Size: 8.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: uv/0.9.17 {"installer":{"name":"uv","version":"0.9.17","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
79acfd4ef3e5717616395e3fd45cb4408bdfd3dd2f9ae9be44173d8b87cd9ced
|
|
| MD5 |
416406742ae539d153acbf50933e5a1c
|
|
| BLAKE2b-256 |
d24d193abf8f41f95ff2e7e2ba3b9c7e393b6bd6069ea22e625e29fdf5490855
|
File details
Details for the file plain_code-0.15.0-py3-none-any.whl.
File metadata
- Download URL: plain_code-0.15.0-py3-none-any.whl
- Upload date:
- Size: 11.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: uv/0.9.17 {"installer":{"name":"uv","version":"0.9.17","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
f78f5a531d46cc120e40ca6ae3767f4b742118ba5756d6da6f5149ac57a0afbe
|
|
| MD5 |
7656ad90a9c60138f785d4756d5a9d87
|
|
| BLAKE2b-256 |
cd52bed1da28984ab704e15c57ba8f1a851301b08ceb08a4be20e0f2ffb8ef08
|