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.1.tar.gz (6.8 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.1-py3-none-any.whl (10.0 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for plain_code-0.10.1.tar.gz
Algorithm Hash digest
SHA256 866aed576d23b751b0dfa5ebc0d5c6889a57a957f806d1f448a6e0c78c038e28
MD5 03225bfa6246acff9ab7095bf2f95005
BLAKE2b-256 c7a37cc5d1b364447bab1f68309bd39c0b51b841f77c755b90adde572bb82c0e

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for plain_code-0.10.1-py3-none-any.whl
Algorithm Hash digest
SHA256 b64d39447f624d77af22e98a1cb0c723284e7a234bcc161823f02a2dff9b247d
MD5 18c06f1dbea7bb6424b8e9d3843e1035
BLAKE2b-256 884b944a28eb0694423f3c661a90e06124269bc58cdb44af75d1aec4cc4638c7

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