Skip to main content

Preconfigured code formatting and linting.

Project description

plain.code

Preconfigured code formatting and linting.

Overview

The plain code command lints and formats Python files using Ruff, and JavaScript, JSON, and CSS files using Biome. Ruff is installed as a Python dependency, and 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.

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


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

plain_code-0.10.0.tar.gz (6.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

plain_code-0.10.0-py3-none-any.whl (9.9 kB view details)

Uploaded Python 3

File details

Details for the file plain_code-0.10.0.tar.gz.

File metadata

  • Download URL: plain_code-0.10.0.tar.gz
  • Upload date:
  • Size: 6.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.8.18

File hashes

Hashes for plain_code-0.10.0.tar.gz
Algorithm Hash digest
SHA256 097bcb1dfcb4a90c2ad101a2f7b46f484df9ac4e8adae727c7ff9279cb3b6292
MD5 4fe9f596b206e51355c9033a90432e00
BLAKE2b-256 1c65c9c959185eecab40a8222edd7d60e2ee1ddb813094bfb3d16039a1e5e20d

See more details on using hashes here.

File details

Details for the file plain_code-0.10.0-py3-none-any.whl.

File metadata

File hashes

Hashes for plain_code-0.10.0-py3-none-any.whl
Algorithm Hash digest
SHA256 f21d613ad9f25db6b373cb698b1d734ffbbf48b798287b4166893be88827ab04
MD5 092a49df6754422abc514270b396ec51
BLAKE2b-256 4c39b3c9f9068352c6ecb0073b0ab1b77bb22fd1e4c4ee01d8a819a082fc85a6

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page