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.2.tar.gz (7.0 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.2-py3-none-any.whl (10.1 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for plain_code-0.10.2.tar.gz
Algorithm Hash digest
SHA256 0c499490a752c8f712a576b46b408c4fc2431cf2414366f15326b67b2df18c89
MD5 84f8e7b6a17a494a2582573ed50c1145
BLAKE2b-256 e28767ad665e2a22a2eaff618fc6b1e792d39bb95b622c6936e90c5f77805b98

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for plain_code-0.10.2-py3-none-any.whl
Algorithm Hash digest
SHA256 02405f55c2911be905ade1cf9177598a204a8e3e5b9cd88b58c665e437be4760
MD5 b39697b45e6a566353817feb1360e225
BLAKE2b-256 542f159c6ad2f7aa6fb1fcd7fa7f1c4afe82d5c724e1216baa788609e784e951

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