Skip to main content

plain.code

Preconfigured code formatting and linting.

Overview

Plain.code provides comprehensive code quality tools with sensible defaults:

  • Ruff - Python linting and formatting
  • ty - Python type checking
  • oxlint - JavaScript and TypeScript linting
  • oxfmt - JavaScript, TypeScript, JSON, and CSS formatting

Ruff and ty are installed as Python dependencies. oxlint and oxfmt are managed automatically as standalone binaries (npm is not required).

Commands

plain fix

The most used command is plain fix, which automatically fixes linting issues and formats your code:

plain fix

You can also apply unsafe fixes or add noqa comments to suppress errors:

# Apply Ruff's unsafe fixes
plain fix --unsafe-fixes

# Add noqa comments instead of fixing
plain fix --add-noqa

plain code check

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-oxc

# Skip oxlint and oxfmt checks
plain code check --skip-oxc

# Skip annotation coverage checks
plain code check --skip-annotations

If plain.dev is installed, plain code check will be run automatically as a part of plain pre-commit to help catch issues before they are committed.

plain code annotations

Check the type annotation coverage of your codebase:

plain code annotations

This outputs a summary like 85.2% typed (23/27 functions).

To see which functions are missing annotations:

plain code annotations --details

You can also output the results as JSON for use in CI or other tools:

plain code annotations --json

Settings

Default configuration is provided by ruff_defaults.toml.

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.oxc]
enabled = true  # Set to false to disable oxlint/oxfmt
version = "1.43.0"  # Pin to a specific version

[tool.plain.code.annotations]
enabled = true  # Set to false to disable annotation checks
exclude = ["migrations"]  # Exclude specific patterns

For more advanced configuration options, see get_code_config.

Generally you won't need to change the configuration. The defaults are designed to "just work" for most projects. If you find yourself needing extensive customization, consider using the underlying tools (Ruff, ty, oxlint, oxfmt) directly instead.

FAQs

How do I install or update oxlint/oxfmt manually?

oxlint and oxfmt are installed automatically when you run plain fix or plain code check. If you need to manage them manually:

# Install oxlint/oxfmt (or reinstall if corrupted)
plain code install

# Force reinstall even if up to date
plain code install --force

# Update to the latest version
plain code update

Why are test files excluded from annotation coverage?

Test files (test_*.py, *_test.py, and files in tests/ or test/ directories) are excluded by default because they typically contain many small helper functions where type annotations add noise without providing significant value. You can customize this behavior via the exclude option in the annotations configuration.

How do I check a specific directory?

All commands accept a path argument:

plain fix path/to/directory
plain code check path/to/directory
plain code annotations path/to/directory

Installation

Install the plain.code package from PyPI:

uv add plain.code

Metadata

Release files for plain.code 0.22.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for plain.code 0.22.0
File Size Uploaded Provenance Actions
plain_code-0.22.0.tar.gz 17.4 kB Without provenance Details for plain_code-0.22.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for plain.code 0.22.0
File Interpreter ABI Platform Actions
plain_code-0.22.0-py3-none-any.whl Python 3 none any Details for plain_code-0.22.0-py3-none-any.whl

Total release size: 38.8 kB

Release files / plain_code-0.22.0.tar.gz

Download URL plain_code-0.22.0.tar.gz
Size 17.4 kB
Tags Source
SHA-256 checksum
How to use checksums
ea0f86ea9be0f6177751af9825b6e3659d86d277c3877bb71d2d95a391723c35
BLAKE2b-256 checksum
How to use checksums
c873b0cc216dcf03396db942177dc35642259273e49f450a3d0df5ded2d411a2
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.11.31 {"installer":{"name":"uv","version":"0.11.31","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}

Release files / plain_code-0.22.0-py3-none-any.whl

Download URL plain_code-0.22.0-py3-none-any.whl
Size 21.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
01c4fbe85927da1ef5eb03da658d2c2f9526cd21e70d6f9d75db4d00f11a8135
BLAKE2b-256 checksum
How to use checksums
76379e29c49cc6333f744808eb8ae0edc3cc347a24252f3552551b8ece8aadff
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.11.31 {"installer":{"name":"uv","version":"0.11.31","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}

Security for plain.code 0.22.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.22.0 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page