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.11.1.tar.gz (7.2 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.11.1-py3-none-any.whl (10.4 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for plain_code-0.11.1.tar.gz
Algorithm Hash digest
SHA256 3cce3f35c12a9aa5f2877a1f6da97db5a1761de670a5e2a9a55f6e1674bb950b
MD5 9982af9ce027448dd882b08db3cd5d28
BLAKE2b-256 13b31148350a8589f6a9b4f11fc35fbd46d72a90ee7daaee68fe59d26d52ef76

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for plain_code-0.11.1-py3-none-any.whl
Algorithm Hash digest
SHA256 c0ebbb9fe1e234ae9b766cc69e90eb8f39af224eceb853051184fc7a182438f8
MD5 499744bf641330b73bab46953f6f5c56
BLAKE2b-256 d3dcce57af14300fbfbd175aadd0d1004181a7159123f986c94cd54288a0f078

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