plain.code 0.10.0__tar.gz → 0.12.0__tar.gz

{plain_code-0.10.0 → plain_code-0.12.0}/PKG-INFO

@@ -1,14 +1,16 @@
 Metadata-Version: 2.4
 Name: plain.code
-Version: 0.10.0
+Version: 0.12.0
 Summary: Preconfigured code formatting and linting.
 Author-email: Dave Gaeddert <dave.gaeddert@dropseed.dev>
+License-Expression: BSD-3-Clause
 License-File: LICENSE
 Requires-Python: >=3.13
 Requires-Dist: plain<1.0.0
 Requires-Dist: requests>=2.0.0
 Requires-Dist: ruff>=0.1.0
 Requires-Dist: tomlkit>=0.11.0
+Requires-Dist: ty>=0.0.1a27
 Description-Content-Type: text/markdown
 
 # plain.code
@@ -21,7 +23,13 @@ Description-Content-Type: text/markdown
 
 ## 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 `plain code` command provides comprehensive code quality tools:
+
+- **[Ruff](https://astral.sh/ruff)** - Python linting and formatting
+- **[ty](https://astral.sh/ty)** - Python type checking
+- **[Biome](https://biomejs.dev/)** - JavaScript, JSON, and CSS formatting
+
+Ruff and ty are installed as Python dependencies. 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`:
 
@@ -33,6 +41,25 @@ This will automatically fix linting issues and format your code according to the
 
 ![](https://assets.plainframework.com/docs/plain-fix.png)
 
+To check your code without making changes (including type checking):
+
+```bash
+plain code check
+```
+
+You can skip specific tools if needed:
+
+```bash
+# Skip type checking during rapid development
+plain code check --skip-ty
+
+# Only run type checks
+plain code check --skip-ruff --skip-biome
+
+# Skip Biome checks
+plain code check --skip-biome
+```
+
 If [`plain.dev`](/plain-dev/README.md) 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
@@ -45,6 +72,9 @@ You can customize the behavior in your `pyproject.toml`:
 [tool.plain.code]
 exclude = ["path/to/exclude"]
 
+[tool.plain.code.ty]
+enabled = true  # Set to false to disable ty
+
 [tool.plain.code.biome]
 enabled = true  # Set to false to disable Biome
 version = "1.5.3"  # Pin to a specific version

plain_code-0.12.0/plain/code/CHANGELOG.md

@@ -0,0 +1,137 @@
+# plain-code changelog
+
+## [0.12.0](https://github.com/dropseed/plain/releases/plain-code@0.12.0) (2025-11-24)
+
+### What's changed
+
+- Added [ty](https://astral.sh/ty) type checker integration, running automatically as part of `plain code check` ([40db43a](https://github.com/dropseed/plain/commit/40db43a))
+- Added `--skip-ruff`, `--skip-ty`, and `--skip-biome` flags to `plain code check` for selectively skipping tools ([40db43a](https://github.com/dropseed/plain/commit/40db43a))
+- ty can be disabled in configuration via `[tool.plain.code.ty]` with `enabled = false` ([40db43a](https://github.com/dropseed/plain/commit/40db43a))
+
+### Upgrade instructions
+
+- No changes required
+
+## [0.11.4](https://github.com/dropseed/plain/releases/plain-code@0.11.4) (2025-11-17)
+
+### What's changed
+
+- The `plain fix` command now displays styled output that matches the format of `plain code check`, showing the tool name in bold and the command being run in dim text ([cde9a8e](https://github.com/dropseed/plain/commit/cde9a8e))
+
+### Upgrade instructions
+
+- No changes required
+
+## [0.11.3](https://github.com/dropseed/plain/releases/plain-code@0.11.3) (2025-11-03)
+
+### What's changed
+
+- Improved CLI command descriptions to be more concise and user-friendly ([fdb9e80](https://github.com/dropseed/plain/commit/fdb9e80))
+- The `plain fix` command is now marked as a common command and registered as a shortcut for `plain code fix` ([73d3a48](https://github.com/dropseed/plain/commit/73d3a48), [7910a06](https://github.com/dropseed/plain/commit/7910a06))
+
+### Upgrade instructions
+
+- No changes required
+
+## [0.11.2](https://github.com/dropseed/plain/releases/plain-code@0.11.2) (2025-10-31)
+
+### What's changed
+
+- Added BSD-3-Clause license identifier to package metadata ([8477355](https://github.com/dropseed/plain/commit/8477355))
+
+### Upgrade instructions
+
+- No changes required
+
+## [0.11.1](https://github.com/dropseed/plain/releases/plain-code@0.11.1) (2025-10-27)
+
+### What's changed
+
+- Improved `plain code check` output with styled command labels and a clearer error message when checks fail ([5e75a0d](https://github.com/dropseed/plain/commit/5e75a0d))
+
+### Upgrade instructions
+
+- No changes required
+
+## [0.11.0](https://github.com/dropseed/plain/releases/plain-code@0.11.0) (2025-10-22)
+
+### What's changed
+
+- All CLI commands now skip runtime setup for faster execution by using the `@without_runtime_setup` decorator ([b7358d7](https://github.com/dropseed/plain/commit/b7358d7))
+
+### Upgrade instructions
+
+- No changes required
+
+## [0.10.2](https://github.com/dropseed/plain/releases/plain-code@0.10.2) (2025-10-06)
+
+### What's changed
+
+- Added comprehensive type annotations throughout the codebase for improved IDE support and type checking ([7455fa0](https://github.com/dropseed/plain/commit/7455fa0))
+
+### Upgrade instructions
+
+- No changes required
+
+## [0.10.1](https://github.com/dropseed/plain/releases/plain-code@0.10.1) (2025-09-25)
+
+### What's changed
+
+- Improved Biome download performance by using larger chunk sizes (1MB instead of 8KB) for faster binary downloads ([9bf4eca](https://github.com/dropseed/plain/commit/9bf4eca))
+
+### Upgrade instructions
+
+- No changes required
+
+## [0.10.0](https://github.com/dropseed/plain/releases/plain-code@0.10.0) (2025-09-19)
+
+### What's changed
+
+- Minimum Python version increased from 3.11 to 3.13 ([d86e307](https://github.com/dropseed/plain/commit/d86e307))
+
+### Upgrade instructions
+
+- Ensure your Python environment is running Python 3.13 or later before upgrading
+
+## [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
+
+- Improved error handling by using `click.UsageError` instead of `print` and `sys.exit` for better CLI error messages ([88f06c5](https://github.com/dropseed/plain/commit/88f06c5))
+
+### Upgrade instructions
+
+- No changes required
+
+## [0.9.0](https://github.com/dropseed/plain/releases/plain-code@0.9.0) (2025-07-03)
+
+### What's changed
+
+- Updated Biome integration to support the new **Biome 2** release. The download logic now uses the new `@biomejs/biome@<version>` tag format and the built-in default configuration has been modernised (`root: true`, `files.includes`, etc.) ([83fa906](https://github.com/dropseed/plain/commit/83fa906)).
+- A progress bar is now displayed while the Biome binary is being downloaded so you can see the download progress in real time ([ec637aa](https://github.com/dropseed/plain/commit/ec637aa)).
+
+### Upgrade instructions
+
+- If you have pinned a specific Biome version in your `pyproject.toml` under `[tool.plain.code.biome]`, make sure it is compatible with Biome 2 (for example, `version = "2.0.0"`). Otherwise, use `plain code update` to update to Biome 2.
+
+## [0.8.3](https://github.com/dropseed/plain/releases/plain-code@0.8.3) (2025-06-26)
+
+### What's changed
+
+- Added this `CHANGELOG.md` file to start tracking changes for the `plain.code` package ([82710c3](https://github.com/dropseed/plain/commit/82710c3)).
+- No functional changes were introduced in this release.
+
+### Upgrade instructions
+
+- No changes required

{plain_code-0.10.0 → plain_code-0.12.0}/plain/code/README.md

@@ -8,7 +8,13 @@
 
 ## 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 `plain code` command provides comprehensive code quality tools:
+
+- **[Ruff](https://astral.sh/ruff)** - Python linting and formatting
+- **[ty](https://astral.sh/ty)** - Python type checking
+- **[Biome](https://biomejs.dev/)** - JavaScript, JSON, and CSS formatting
+
+Ruff and ty are installed as Python dependencies. 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`:
 
@@ -20,6 +26,25 @@ This will automatically fix linting issues and format your code according to the
 
 ![](https://assets.plainframework.com/docs/plain-fix.png)
 
+To check your code without making changes (including type checking):
+
+```bash
+plain code check
+```
+
+You can skip specific tools if needed:
+
+```bash
+# Skip type checking during rapid development
+plain code check --skip-ty
+
+# Only run type checks
+plain code check --skip-ruff --skip-biome
+
+# Skip Biome checks
+plain code check --skip-biome
+```
+
 If [`plain.dev`](/plain-dev/README.md) 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
@@ -32,6 +57,9 @@ You can customize the behavior in your `pyproject.toml`:
 [tool.plain.code]
 exclude = ["path/to/exclude"]
 
+[tool.plain.code.ty]
+enabled = true  # Set to false to disable ty
+
 [tool.plain.code.biome]
 enabled = true  # Set to false to disable Biome
 version = "1.5.3"  # Pin to a specific version

{plain_code-0.10.0 → plain_code-0.12.0}/plain/code/biome.py

@@ -121,11 +121,11 @@ class Biome:
                     label="Downloading Biome",
                     width=0,
                 ) as bar:
-                    for chunk in resp.iter_content(chunk_size=8192):
+                    for chunk in resp.iter_content(chunk_size=1024 * 1024):
                         f.write(chunk)
                         bar.update(len(chunk))
             else:
-                for chunk in resp.iter_content(chunk_size=8192):
+                for chunk in resp.iter_content(chunk_size=1024 * 1024):
                     f.write(chunk)
         os.chmod(self.standalone_path, 0o755)
 
@@ -153,7 +153,7 @@ class Biome:
         self.set_version_in_config(v)
         return v
 
-    def invoke(self, *args, cwd=None) -> subprocess.CompletedProcess:
+    def invoke(self, *args: str, cwd: str | None = None) -> subprocess.CompletedProcess:
         # Run the standalone biome binary with given args
         config_path = os.path.abspath(
             os.path.join(os.path.dirname(__file__), "biome_defaults.json")

{plain_code-0.10.0 → plain_code-0.12.0}/plain/code/cli.py

@@ -1,30 +1,36 @@
+from __future__ import annotations
+
 import subprocess
 import sys
 import tomllib
 from pathlib import Path
+from typing import Any
 
 import click
 
 from plain.cli import register_cli
 from plain.cli.print import print_event
+from plain.cli.runtime import common_command, without_runtime_setup
 
 from .biome import Biome
 
 DEFAULT_RUFF_CONFIG = Path(__file__).parent / "ruff_defaults.toml"
 
 
+@without_runtime_setup
 @register_cli("code")
 @click.group()
-def cli():
+def cli() -> None:
     """Code formatting and linting"""
     pass
 
 
+@without_runtime_setup
 @cli.command()
 @click.option("--force", is_flag=True, help="Reinstall even if up to date")
 @click.pass_context
-def install(ctx, force):
-    """Install or update the Biome standalone per configuration."""
+def install(ctx: click.Context, force: bool) -> None:
+    """Install or update Biome binary"""
     config = get_code_config()
 
     if not config.get("biome", {}).get("enabled", True):
@@ -49,9 +55,10 @@ def install(ctx, force):
         click.secho("Biome already installed", fg="green")
 
 
+@without_runtime_setup
 @cli.command()
-def update():
-    """Update the Biome standalone binary to the latest release."""
+def update() -> None:
+    """Update Biome to latest version"""
     config = get_code_config()
 
     if not config.get("biome", {}).get("enabled", True):
@@ -64,47 +71,78 @@ def update():
     click.secho(f"Biome {version} installed", fg="green")
 
 
+@without_runtime_setup
 @cli.command()
 @click.pass_context
 @click.argument("path", default=".")
-def check(ctx, path):
-    """Check the given path for formatting or linting issues."""
+@click.option("--skip-ruff", is_flag=True, help="Skip Ruff checks")
+@click.option("--skip-ty", is_flag=True, help="Skip ty type checks")
+@click.option("--skip-biome", is_flag=True, help="Skip Biome checks")
+def check(
+    ctx: click.Context,
+    path: str,
+    skip_ruff: bool,
+    skip_ty: bool,
+    skip_biome: bool,
+) -> None:
+    """Check for formatting and linting issues"""
     ruff_args = ["--config", str(DEFAULT_RUFF_CONFIG)]
     config = get_code_config()
 
     for e in config.get("exclude", []):
         ruff_args.extend(["--exclude", e])
 
-    print_event("Ruff check")
-    result = subprocess.run(["ruff", "check", path, *ruff_args])
-    if result.returncode != 0:
-        sys.exit(result.returncode)
+    def maybe_exit(return_code: int) -> None:
+        if return_code != 0:
+            click.secho(
+                "\nCode check failed. Run `plain fix` and/or fix issues manually.",
+                fg="red",
+                err=True,
+            )
+            sys.exit(return_code)
 
-    print_event("Ruff format check")
-    result = subprocess.run(["ruff", "format", path, "--check", *ruff_args])
-    if result.returncode != 0:
-        sys.exit(result.returncode)
+    if not skip_ruff:
+        print_event(
+            click.style("Ruff lint:", bold=True) + click.style(" ruff check", dim=True)
+        )
+        result = subprocess.run(["ruff", "check", path, *ruff_args])
+        maybe_exit(result.returncode)
 
-    if config.get("biome", {}).get("enabled", True):
+        print_event(
+            click.style("Ruff format:", bold=True)
+            + click.style(" ruff format --check", dim=True)
+        )
+        result = subprocess.run(["ruff", "format", path, "--check", *ruff_args])
+        maybe_exit(result.returncode)
+
+    if not skip_ty and config.get("ty", {}).get("enabled", True):
+        print_event(click.style("Ty:", bold=True) + click.style(" ty check", dim=True))
+        result = subprocess.run(["ty", "check", path])
+        maybe_exit(result.returncode)
+
+    if not skip_biome and config.get("biome", {}).get("enabled", True):
         biome = Biome()
 
         if biome.needs_update():
             ctx.invoke(install)
 
-        print_event("Biome check")
+        print_event(
+            click.style("Biome:", bold=True) + click.style(" biome check", dim=True)
+        )
         result = biome.invoke("check", path)
-        if result.returncode != 0:
-            sys.exit(result.returncode)
+        maybe_exit(result.returncode)
 
 
-@register_cli("fix")
+@common_command
+@without_runtime_setup
+@register_cli("fix", shortcut_for="code fix")
 @cli.command()
 @click.pass_context
 @click.argument("path", default=".")
 @click.option("--unsafe-fixes", is_flag=True, help="Apply ruff unsafe fixes")
 @click.option("--add-noqa", is_flag=True, help="Add noqa comments to suppress errors")
-def fix(ctx, path, unsafe_fixes, add_noqa):
-    """Lint and format the given path."""
+def fix(ctx: click.Context, path: str, unsafe_fixes: bool, add_noqa: bool) -> None:
+    """Fix formatting and linting issues"""
     ruff_args = ["--config", str(DEFAULT_RUFF_CONFIG)]
     config = get_code_config()
 
@@ -115,21 +153,32 @@ def fix(ctx, path, unsafe_fixes, add_noqa):
         raise click.UsageError("Cannot use both --unsafe-fixes and --add-noqa")
 
     if unsafe_fixes:
-        print_event("Ruff fix (with unsafe fixes)")
+        print_event(
+            click.style("Ruff lint:", bold=True)
+            + click.style(" ruff check --fix --unsafe-fixes", dim=True)
+        )
         result = subprocess.run(
             ["ruff", "check", path, "--fix", "--unsafe-fixes", *ruff_args]
         )
     elif add_noqa:
-        print_event("Ruff fix (add noqa)")
+        print_event(
+            click.style("Ruff lint:", bold=True)
+            + click.style(" ruff check --add-noqa", dim=True)
+        )
         result = subprocess.run(["ruff", "check", path, "--add-noqa", *ruff_args])
     else:
-        print_event("Ruff fix")
+        print_event(
+            click.style("Ruff lint:", bold=True)
+            + click.style(" ruff check --fix", dim=True)
+        )
         result = subprocess.run(["ruff", "check", path, "--fix", *ruff_args])
 
     if result.returncode != 0:
         sys.exit(result.returncode)
 
-    print_event("Ruff format")
+    print_event(
+        click.style("Ruff format:", bold=True) + click.style(" ruff format", dim=True)
+    )
     result = subprocess.run(["ruff", "format", path, *ruff_args])
     if result.returncode != 0:
         sys.exit(result.returncode)
@@ -140,12 +189,19 @@ def fix(ctx, path, unsafe_fixes, add_noqa):
         if biome.needs_update():
             ctx.invoke(install)
 
-        print_event("Biome format")
-
         args = ["check", path, "--write"]
 
         if unsafe_fixes:
             args.append("--unsafe")
+            print_event(
+                click.style("Biome:", bold=True)
+                + click.style(" biome check --write --unsafe", dim=True)
+            )
+        else:
+            print_event(
+                click.style("Biome:", bold=True)
+                + click.style(" biome check --write", dim=True)
+            )
 
         result = biome.invoke(*args)
 
@@ -153,7 +209,7 @@ def fix(ctx, path, unsafe_fixes, add_noqa):
             sys.exit(result.returncode)
 
 
-def get_code_config():
+def get_code_config() -> dict[str, Any]:
     pyproject = Path("pyproject.toml")
     if not pyproject.exists():
         return {}

{plain_code-0.10.0 → plain_code-0.12.0}/plain/code/entrypoints.py

@@ -1,4 +1,4 @@
-def setup():
+def setup() -> None:
     # This package isn't an installed app,
     # so we need to trigger our own import and cli registration.
     from .cli import cli  # noqa

{plain_code-0.10.0 → plain_code-0.12.0}/pyproject.toml

@@ -1,13 +1,15 @@
 [project]
 name = "plain.code"
-version = "0.10.0"
+version = "0.12.0"
 description = "Preconfigured code formatting and linting."
 authors = [{name = "Dave Gaeddert", email = "dave.gaeddert@dropseed.dev"}]
 readme = "README.md"
+license = "BSD-3-Clause"
 requires-python = ">=3.13"
 dependencies = [
     "plain<1.0.0",
     "ruff>=0.1.0",
+    "ty>=0.0.1a27",
     "requests>=2.0.0",
     "tomlkit>=0.11.0",
 ]

plain_code-0.10.0/plain/code/CHANGELOG.md

@@ -1,54 +0,0 @@
-# plain-code changelog
-
-## [0.10.0](https://github.com/dropseed/plain/releases/plain-code@0.10.0) (2025-09-19)
-
-### What's changed
-
-- Minimum Python version increased from 3.11 to 3.13 ([d86e307](https://github.com/dropseed/plain/commit/d86e307))
-
-### Upgrade instructions
-
-- Ensure your Python environment is running Python 3.13 or later before upgrading
-
-## [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
-
-- Improved error handling by using `click.UsageError` instead of `print` and `sys.exit` for better CLI error messages ([88f06c5](https://github.com/dropseed/plain/commit/88f06c5))
-
-### Upgrade instructions
-
-- No changes required
-
-## [0.9.0](https://github.com/dropseed/plain/releases/plain-code@0.9.0) (2025-07-03)
-
-### What's changed
-
-- Updated Biome integration to support the new **Biome 2** release. The download logic now uses the new `@biomejs/biome@<version>` tag format and the built-in default configuration has been modernised (`root: true`, `files.includes`, etc.) ([83fa906](https://github.com/dropseed/plain/commit/83fa906)).
-- A progress bar is now displayed while the Biome binary is being downloaded so you can see the download progress in real time ([ec637aa](https://github.com/dropseed/plain/commit/ec637aa)).
-
-### Upgrade instructions
-
-- If you have pinned a specific Biome version in your `pyproject.toml` under `[tool.plain.code.biome]`, make sure it is compatible with Biome 2 (for example, `version = "2.0.0"`). Otherwise, use `plain code update` to update to Biome 2.
-
-## [0.8.3](https://github.com/dropseed/plain/releases/plain-code@0.8.3) (2025-06-26)
-
-### What's changed
-
-- Added this `CHANGELOG.md` file to start tracking changes for the `plain.code` package ([82710c3](https://github.com/dropseed/plain/commit/82710c3)).
-- No functional changes were introduced in this release.
-
-### Upgrade instructions
-
-- No changes required