plain.dev 0.35.0__tar.gz → 0.37.0__tar.gz

{plain_dev-0.35.0 → plain_dev-0.37.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: plain.dev
-Version: 0.35.0
+Version: 0.37.0
 Summary: A single command that runs everything you need for local development.
 Author-email: Dave Gaeddert <dave.gaeddert@dropseed.dev>
 License-Expression: BSD-3-Clause
@@ -56,7 +56,7 @@ This will:
 The `plain dev` command does several things:
 
 - Sets `PLAIN_CSRF_TRUSTED_ORIGINS` to localhost by default
-- Runs `plain preflight` to check for any issues
+- Runs `plain preflight check` 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)
@@ -113,7 +113,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 --database default`
+- `plain preflight check`
 - `plain migrate --check`
 - `plain makemigrations --dry-run --check`
 - `plain build`

{plain_dev-0.35.0 → plain_dev-0.37.0}/plain/dev/CHANGELOG.md

@@ -1,5 +1,26 @@
 # plain-dev changelog
 
+## [0.37.0](https://github.com/dropseed/plain/releases/plain-dev@0.37.0) (2025-09-29)
+
+### What's changed
+
+- Added a `p` alias prompt that suggests setting up a shell alias for `uv run plain` to make command execution faster ([d913b44](https://github.com/dropseed/plain/commit/d913b44fab), [6632529](https://github.com/dropseed/plain/commit/663252925b))
+
+### Upgrade instructions
+
+- No changes required
+
+## [0.36.0](https://github.com/dropseed/plain/releases/plain-dev@0.36.0) (2025-09-25)
+
+### What's changed
+
+- The `plain preflight` command has been updated to use `plain preflight check` with a `--quiet` flag for cleaner output in development workflows ([b0b610d](https://github.com/dropseed/plain/commit/b0b610d461))
+- Pre-commit hooks now use the updated preflight check syntax ([b0b610d](https://github.com/dropseed/plain/commit/b0b610d461))
+
+### Upgrade instructions
+
+- No changes required
+
 ## [0.35.0](https://github.com/dropseed/plain/releases/plain-dev@0.35.0) (2025-09-22)
 
 ### What's changed

{plain_dev-0.35.0 → plain_dev-0.37.0}/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` to check for any issues
+- Runs `plain preflight check` 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 --database default`
+- `plain preflight check`
 - `plain migrate --check`
 - `plain makemigrations --dry-run --check`
 - `plain build`

plain_dev-0.37.0/plain/dev/alias.py

@@ -0,0 +1,152 @@
+import os
+import subprocess
+import sys
+from functools import cached_property
+from pathlib import Path
+
+import click
+
+
+class AliasManager:
+    """Manages the 'p' alias for 'uv run plain'."""
+
+    MARKER_FILE = Path.home() / ".plain" / "dev" / ".alias_prompted"
+    ALIAS_COMMAND = "uv run plain"
+    ALIAS_NAME = "p"
+
+    @cached_property
+    def shell(self):
+        """Detect the current shell."""
+        shell = os.environ.get("SHELL", "")
+        if "zsh" in shell:
+            return "zsh"
+        elif "bash" in shell:
+            return "bash"
+        elif "fish" in shell:
+            return "fish"
+        return None
+
+    @cached_property
+    def shell_config_file(self):
+        """Get the appropriate shell configuration file."""
+        home = Path.home()
+
+        if self.shell == "zsh":
+            return home / ".zshrc"
+        elif self.shell == "bash":
+            # Check for .bash_aliases first (Ubuntu/Debian convention)
+            if (home / ".bash_aliases").exists():
+                return home / ".bash_aliases"
+            return home / ".bashrc"
+        elif self.shell == "fish":
+            return home / ".config" / "fish" / "config.fish"
+
+        return None
+
+    def _command_exists(self, command):
+        """Check if a command exists in the system."""
+        try:
+            result = subprocess.run(
+                ["which", command], capture_output=True, text=True, check=False
+            )
+            return result.returncode == 0
+        except Exception:
+            return False
+
+    def _alias_exists(self):
+        """Check if the 'p' alias already exists."""
+        # First check if 'p' is already a command
+        if self._command_exists(self.ALIAS_NAME):
+            return True
+
+        # Check if alias is defined in shell
+        try:
+            # Try to run the alias to see if it exists
+            result = subprocess.run(
+                [self.shell, "-i", "-c", f"alias {self.ALIAS_NAME}"],
+                capture_output=True,
+                text=True,
+                check=False,
+                timeout=2,
+            )
+            return result.returncode == 0
+        except (subprocess.TimeoutExpired, Exception):
+            return False
+
+    def _add_alias_to_shell(self):
+        """Add the alias to the shell configuration file."""
+        if not self.shell_config_file or not self.shell_config_file.exists():
+            return False
+
+        alias_line = f'alias {self.ALIAS_NAME}="{self.ALIAS_COMMAND}"'
+        comment = "# Added by Plain"
+
+        # Check if alias already in file
+        try:
+            with open(self.shell_config_file) as f:
+                content = f.read()
+                if alias_line in content:
+                    return True
+        except Exception:
+            return False
+
+        # Add alias to file
+        try:
+            with open(self.shell_config_file, "a") as f:
+                f.write(f"\n{comment}\n{alias_line}\n")
+
+            click.secho(
+                f"✓ Added '{self.ALIAS_NAME}' alias to {self.shell_config_file.name}. Restart your shell!",
+                fg="green",
+            )
+            return True
+        except Exception as e:
+            click.secho(
+                f"Failed to add alias to {self.shell_config_file.name}: {e}", fg="red"
+            )
+            return False
+
+    def check_and_prompt(self):
+        """Check if alias exists and prompt user to set it up if needed."""
+        # Only suggest if project uses uv (has uv.lock file)
+        if not Path("uv.lock").exists():
+            return
+
+        # Don't prompt if already configured
+        if self._alias_exists():
+            return
+
+        # Don't prompt if we've asked before
+        if self.MARKER_FILE.exists():
+            return
+
+        # Don't prompt for certain commands
+        if "--help" in sys.argv or "-h" in sys.argv:
+            return
+
+        # Mark that we've asked (do this first so we don't ask again even if they Ctrl+C)
+        self.MARKER_FILE.parent.mkdir(parents=True, exist_ok=True)
+        self.MARKER_FILE.touch()
+
+        click.echo()
+        click.secho("💡 Tip: ", fg="yellow", bold=True, nl=False)
+        click.echo(
+            f"Set up `{self.ALIAS_NAME}` as an alias to run commands faster (e.g., `{self.ALIAS_NAME} dev` instead of `uv run plain dev`)."
+        )
+        click.echo()
+
+        # Check if shell is supported
+        if not self.shell or not self.shell_config_file:
+            click.echo("To set this up manually, add to your shell config:")
+            click.echo(f'  alias {self.ALIAS_NAME}="{self.ALIAS_COMMAND}"')
+            click.echo()
+            return
+
+        # Offer to set it up
+        prompt_text = f"Would you like to add this to {self.shell_config_file.name}?"
+        if click.confirm(prompt_text, default=False):
+            click.echo()
+            if self._add_alias_to_shell():
+                sys.exit(0)  # Completely exit
+
+        click.echo()

{plain_dev-0.35.0 → plain_dev-0.37.0}/plain/dev/cli.py

@@ -9,6 +9,7 @@ import click
 from plain.cli import register_cli
 from plain.runtime import APP_PATH, PLAIN_TEMP_PATH
 
+from .alias import AliasManager
 from .core import ENTRYPOINT_GROUP, DevProcess
 from .services import ServicesProcess
 
@@ -119,7 +120,6 @@ class DevGroup(click.Group):
 )
 def cli(ctx, port, hostname, log_level, start, stop):
     """Start local development"""
-
     if ctx.invoked_subcommand:
         return
 
@@ -170,6 +170,9 @@ def cli(ctx, port, hostname, log_level, start, stop):
         )
         return
 
+    # Check and prompt for alias setup
+    AliasManager().check_and_prompt()
+
     dev.setup(port=port, hostname=hostname, log_level=log_level)
     returncode = dev.run()
     if returncode:

{plain_dev-0.35.0 → plain_dev-0.37.0}/plain/dev/core.py

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

{plain_dev-0.35.0 → plain_dev-0.37.0}/plain/dev/precommit/cli.py

@@ -63,7 +63,8 @@ def cli(install):
             "Running preflight checks",
             "plain",
             "preflight",
-            "--database",
+            "check",
+            "--quiet",
         )
         check_short("Checking Plain migrations", "plain", "migrate", "--check")
         check_short(
@@ -74,7 +75,13 @@ def cli(install):
             "--check",
         )
     else:
-        check_short("Running Plain checks (without database)", "plain", "preflight")
+        check_short(
+            "Running Plain checks (without database)",
+            "plain",
+            "preflight",
+            "check",
+            "--quiet",
+        )
         click.secho("--> Skipping migration checks", bold=True, fg="yellow")
 
     print_event("Running plain build")

{plain_dev-0.35.0 → plain_dev-0.37.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "plain.dev"
-version = "0.35.0"
+version = "0.37.0"
 description = "A single command that runs everything you need for local development."
 authors = [{name = "Dave Gaeddert", email = "dave.gaeddert@dropseed.dev"}]
 license = "BSD-3-Clause"