plain.code 0.9.1__tar.gz → 0.9.2__tar.gz

{plain_code-0.9.1 → plain_code-0.9.2}/PKG-INFO

@@ -1,7 +1,7 @@
 Metadata-Version: 2.4
 Name: plain.code
-Version: 0.9.1
-Summary: Code formatting and linting for Plain.
+Version: 0.9.2
+Summary: Preconfigured code formatting and linting.
 Author-email: Dave Gaeddert <dave.gaeddert@dropseed.dev>
 License-File: LICENSE
 Requires-Python: >=3.11
@@ -15,9 +15,21 @@ Description-Content-Type: text/markdown
 
 **Preconfigured code formatting and linting.**
 
+- [Overview](#overview)
+- [Configuration](#configuration)
+- [Installation](#installation)
+
+## Overview
+
 The `plain code` command lints and formats Python files using [Ruff](https://astral.sh/ruff), and JavaScript, JSON, and CSS files using [Biome](https://biomejs.dev/). 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`.
+The most used command is `plain code fix`, which can be run using the alias `plain fix`:
+
+```bash
+plain fix
+```
+
+This will automatically fix linting issues and format your code according to the configured rules.
 
 ![](https://assets.plainframework.com/docs/plain-fix.png)
 
@@ -25,6 +37,27 @@ If [`plain.dev`](/plain-dev/README.md) is installed then `plain code check` will
 
 ## Configuration
 
-Default configuration is provided by [`ruff_defaults.toml`](plain/code/ruff_defaults.toml) and [`biome_defaults.json`](plain/code/biome_defaults.json).
+Default configuration is provided by [`ruff_defaults.toml`](./ruff_defaults.toml) and [`biome_defaults.json`](./biome_defaults.json).
+
+You can customize the behavior in your `pyproject.toml`:
+
+```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`](./cli.py#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](https://pypi.org/project/plain.code/):
+
+```bash
+uv add plain.code
+```

{plain_code-0.9.1 → plain_code-0.9.2}/plain/code/CHANGELOG.md

@@ -1,5 +1,16 @@
 # plain-code changelog
 
+## [0.9.2](https://github.com/dropseed/plain/releases/plain-code@0.9.2) (2025-07-30)
+
+### What's changed
+
+- Skip Biome installation and updates when Biome is disabled in configuration ([b8beb5c](https://github.com/dropseed/plain/commit/b8beb5c))
+- Enhanced README with better structure, usage examples, and configuration documentation ([4ebecd1](https://github.com/dropseed/plain/commit/4ebecd1))
+
+### Upgrade instructions
+
+- No changes required
+
 ## [0.9.1](https://github.com/dropseed/plain/releases/plain-code@0.9.1) (2025-07-18)
 
 ### What's changed

{plain_code-0.9.1 → plain_code-0.9.2}/plain/code/README.md

@@ -2,9 +2,21 @@
 
 **Preconfigured code formatting and linting.**
 
+- [Overview](#overview)
+- [Configuration](#configuration)
+- [Installation](#installation)
+
+## Overview
+
 The `plain code` command lints and formats Python files using [Ruff](https://astral.sh/ruff), and JavaScript, JSON, and CSS files using [Biome](https://biomejs.dev/). 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`.
+The most used command is `plain code fix`, which can be run using the alias `plain fix`:
+
+```bash
+plain fix
+```
+
+This will automatically fix linting issues and format your code according to the configured rules.
 
 ![](https://assets.plainframework.com/docs/plain-fix.png)
 
@@ -12,6 +24,27 @@ If [`plain.dev`](/plain-dev/README.md) is installed then `plain code check` will
 
 ## Configuration
 
-Default configuration is provided by [`ruff_defaults.toml`](plain/code/ruff_defaults.toml) and [`biome_defaults.json`](plain/code/biome_defaults.json).
+Default configuration is provided by [`ruff_defaults.toml`](./ruff_defaults.toml) and [`biome_defaults.json`](./biome_defaults.json).
+
+You can customize the behavior in your `pyproject.toml`:
+
+```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`](./cli.py#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](https://pypi.org/project/plain.code/):
+
+```bash
+uv add plain.code
+```

{plain_code-0.9.1 → plain_code-0.9.2}/plain/code/cli.py

@@ -25,10 +25,16 @@ def cli():
 @click.pass_context
 def install(ctx, force):
     """Install or update the Biome standalone per configuration."""
+    config = get_code_config()
+
+    if not config.get("biome", {}).get("enabled", True):
+        click.secho("Biome is disabled in configuration", fg="yellow")
+        return
+
     biome = Biome()
 
     if force or not biome.is_installed() or biome.needs_update():
-        version_to_install = get_code_config().get("biome", {}).get("version", "")
+        version_to_install = config.get("biome", {}).get("version", "")
         if version_to_install:
             click.secho(
                 f"Installing Biome standalone version {version_to_install}...",
@@ -46,6 +52,12 @@ def install(ctx, force):
 @cli.command()
 def update():
     """Update the Biome standalone binary to the latest release."""
+    config = get_code_config()
+
+    if not config.get("biome", {}).get("enabled", True):
+        click.secho("Biome is disabled in configuration", fg="yellow")
+        return
+
     biome = Biome()
     click.secho("Updating Biome standalone...", bold=True)
     version = biome.install()

{plain_code-0.9.1 → plain_code-0.9.2}/pyproject.toml

@@ -1,7 +1,7 @@
 [project]
 name = "plain.code"
-version = "0.9.1"
-description = "Code formatting and linting for Plain."
+version = "0.9.2"
+description = "Preconfigured code formatting and linting."
 authors = [{name = "Dave Gaeddert", email = "dave.gaeddert@dropseed.dev"}]
 readme = "README.md"
 requires-python = ">=3.11"