Move plain preflight check back to plain preflight

Author: davegaeddert

plain-dev/plain/dev/README.md

@@ -39,7 +39,7 @@ This will:
 The `plain dev` command does several things:
 
 - Sets `PLAIN_CSRF_TRUSTED_ORIGINS` to localhost by default
-- Runs `plain preflight check` to check for any issues
+- Runs `plain preflight` to check for any issues
 - Executes any pending model migrations
 - Starts `gunicorn` with `--reload`
 - Serves HTTPS on port 8443 by default (uses the next free port if 8443 is taken and no port is specified)
@@ -96,7 +96,7 @@ Runs:
 - Custom commands defined in `pyproject.toml` at `tool.plain.pre-commit.run`
 - `plain code check`, if [`plain.code`](https://plainframework.com/docs/plain-code/plain/code/) is installed
 - `uv lock --locked`, if using uv
-- `plain preflight check`
+- `plain preflight`
 - `plain migrate --check`
 - `plain makemigrations --dry-run --check`
 - `plain build`

plain-dev/plain/dev/core.py

@@ -266,7 +266,7 @@ def modify_hosts_file(self) -> None:
 
     def run_preflight(self) -> None:
         if subprocess.run(
-            ["plain", "preflight", "check", "--quiet"], env=self.plain_env
+            ["plain", "preflight", "--quiet"], env=self.plain_env
         ).returncode:
             click.secho("Preflight check failed!", fg="red")
             sys.exit(1)

plain-dev/plain/dev/precommit/cli.py

@@ -77,10 +77,9 @@ def cli(install: bool) -> None:
     if plain_db_connected():
         check_short(
             click.style("Preflight:", bold=True)
-            + click.style(" plain preflight check", dim=True),
+            + click.style(" plain preflight", dim=True),
             "plain",
             "preflight",
-            "check",
             "--quiet",
         )
         check_short(
@@ -101,10 +100,9 @@ def cli(install: bool) -> None:
     else:
         check_short(
             click.style("Preflight:", bold=True)
-            + click.style(" plain preflight check", dim=True),
+            + click.style(" plain preflight", dim=True),
             "plain",
             "preflight",
-            "check",
             "--quiet",
         )
         click.secho("--> Skipping migration checks", bold=True, fg="yellow")

plain/plain/cli/preflight.py

@@ -5,21 +5,13 @@
 
 from plain import preflight
 from plain.packages import packages_registry
-from plain.preflight.registry import checks_registry
-from plain.runtime import settings
 
 
-@click.group("preflight")
-def preflight_cli() -> None:
-    """Run or manage preflight checks."""
-    pass
-
-
-@preflight_cli.command("check")
+@click.command("preflight")
 @click.option(
     "--deploy",
     is_flag=True,
-    help="Check deployment settings.",
+    help="Include deployment checks.",
 )
 @click.option(
     "--format",
@@ -32,14 +24,13 @@ def preflight_cli() -> None:
     is_flag=True,
     help="Hide progress output and warnings, only show errors.",
 )
-def check_command(deploy: bool, format: str, quiet: bool) -> None:
+def preflight_cli(deploy: bool, format: str, quiet: bool) -> None:
     """
-    Use the system check framework to validate entire Plain project.
+    Run preflight checks to validate your Plain project.
     Exit with error code if any errors are found. Warnings do not cause failure.
     """
     # Auto-discover and load preflight checks
     packages_registry.autodiscover_modules("preflight", include_app=True)
-
     if not quiet:
         click.secho("Running preflight checks...", dim=True, italic=True, err=True)
 
@@ -200,48 +191,3 @@ def check_command(deploy: bool, format: str, quiet: bool) -> None:
     # Exit with error if there are any errors (not warnings)
     if has_errors:
         sys.exit(1)
-
-
-@preflight_cli.command("list")
-def list_checks() -> None:
-    """List all available preflight checks."""
-    packages_registry.autodiscover_modules("preflight", include_app=True)
-
-    regular = []
-    deployment = []
-    silenced_checks = settings.PREFLIGHT_SILENCED_CHECKS
-
-    for name, (check_class, deploy) in sorted(checks_registry.checks.items()):
-        # Use class docstring as description
-        description = check_class.__doc__ or "No description"
-        # Get first line of docstring
-        description = description.strip().split("\n")[0]
-
-        is_silenced = name in silenced_checks
-        if deploy:
-            deployment.append((name, description, is_silenced))
-        else:
-            regular.append((name, description, is_silenced))
-
-    if regular:
-        click.echo("Regular checks:")
-        for name, description, is_silenced in regular:
-            silenced_text = (
-                click.style(" (silenced)", fg="red", dim=True) if is_silenced else ""
-            )
-            click.echo(
-                f"  {click.style(name)}: {click.style(description, dim=True)}{silenced_text}"
-            )
-
-    if deployment:
-        click.echo("\nDeployment checks:")
-        for name, description, is_silenced in deployment:
-            silenced_text = (
-                click.style(" (silenced)", fg="red", dim=True) if is_silenced else ""
-            )
-            click.echo(
-                f"  {click.style(name)}: {click.style(description, dim=True)}{silenced_text}"
-            )
-
-    if not regular and not deployment:
-        click.echo("No preflight checks found.")

plain/plain/preflight/README.md

@@ -13,7 +13,7 @@
 Preflight checks help identify issues with your settings or environment before running your application.
 
 ```bash
-plain preflight check
+plain preflight
 ```
 
 ## Development
@@ -22,31 +22,53 @@ If you use [`plain.dev`](/plain-dev/README.md) for local development, the Plain
 
 ## Deployment
 
-The `plain preflight check` command should often be part of your deployment process. Make sure to add the `--deploy` flag to the command to run checks that are only relevant in a production environment.
+The `plain preflight` command should often be part of your deployment process. Make sure to add the `--deploy` flag to the command to run checks that are only relevant in a production environment.
 
 ```bash
-plain preflight check --deploy
+plain preflight --deploy
 ```
 
 ## Custom preflight checks
 
-Use the `@register_check` decorator to add your own preflight check to the system. Just make sure that particular Python module is somehow imported so the check registration runs.
+Use the `@register_check` decorator to add your own preflight check to the system. Create a class that inherits from `PreflightCheck` and implements a `run()` method that returns a list of `PreflightResult` objects.
 
 ```python
-from plain.preflight import register_check, Error
-
-
-@register_check
-def custom_check(package_configs, **kwargs):
-    return Error("This is a custom error message.", id="custom.C001")
+from plain.preflight import PreflightCheck, PreflightResult, register_check
+
+
+@register_check("custom.example")
+class CustomCheck(PreflightCheck):
+    """Description of what this check validates."""
+
+    def run(self) -> list[PreflightResult]:
+        # Your check logic here
+        if some_condition:
+            return [
+                PreflightResult(
+                    fix="This is a custom error message.",
+                    id="custom.example_failed",
+                )
+            ]
+        return []
 ```
 
-For deployment-specific checks, add the `deploy` argument to the decorator.
+For deployment-specific checks, add `deploy=True` to the decorator.
 
 ```python
-@register_check(deploy=True)
-def custom_deploy_check(package_configs, **kwargs):
-    return Error("This is a custom error message for deployment.", id="custom.D001")
+@register_check("custom.deploy_example", deploy=True)
+class CustomDeployCheck(PreflightCheck):
+    """Description of what this deployment check validates."""
+
+    def run(self) -> list[PreflightResult]:
+        # Your deployment check logic here
+        if some_deploy_condition:
+            return [
+                PreflightResult(
+                    fix="This is a custom error message for deployment.",
+                    id="custom.deploy_example_failed",
+                )
+            ]
+        return []
 ```
 
 ## Silencing preflight checks

scripts/pre-commit

@@ -15,4 +15,4 @@ echo "${BOLD}Running tests${NORMAL}"
 
 echo ""
 echo "${BOLD}Running preflight in example${NORMAL}"
-cd example && DATABASE_URL=sqlite://:memory: uv run plain preflight check
+cd example && DATABASE_URL=sqlite://:memory: uv run plain preflight