splent-cli 1.23.0__tar.gz → 1.24.0__tar.gz

{splent_cli-1.23.0/src/splent_cli.egg-info → splent_cli-1.24.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: splent_cli
-Version: 1.23.0
+Version: 1.24.0
 Summary: SPLENT-CLI is a CLI to be able to work on your development more easily.
 Author-email: DiversoLab <diversolab@us.es>
 Project-URL: Homepage, https://github.com/diverso-lab/splent_cli
@@ -9,9 +9,12 @@ Requires-Python: >=3.13
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: click==8.1.8
+Requires-Dist: jinja2>=3.1
 Requires-Dist: packaging>=24.0
+Requires-Dist: python-dotenv>=1.0
 Requires-Dist: pyyaml>=6.0
 Requires-Dist: requests>=2.31.0
+Requires-Dist: splent_framework<2,>=1.15.0
 Requires-Dist: tomli_w>=1.0.0
 Provides-Extra: dev
 Requires-Dist: setuptools==80.3.1; extra == "dev"

{splent_cli-1.23.0 → splent_cli-1.24.0}/pyproject.toml

@@ -4,18 +4,27 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "splent_cli"
-version = "1.23.0"
+version = "1.24.0"
 description = "SPLENT-CLI is a CLI to be able to work on your development more easily."
 readme = "README.md"
 requires-python = ">=3.13"
 authors = [{ name = "DiversoLab", email = "diversolab@us.es" }]
 license-files = ["LICENSE"]
 
+# Everything the CLI imports at module level must be listed here (or come
+# with splent_framework, see tests/unit/test_declared_dependencies.py):
+# startup imports every command module, so one undeclared import breaks
+# `splent --help` on a clean `pip install splent_cli`.
 dependencies = [
     "click==8.1.8",
+    "jinja2>=3.1",
     "packaging>=24.0",
+    "python-dotenv>=1.0",
     "pyyaml>=6.0",
     "requests>=2.31.0",
+    # The CLI drives the framework (paths, feature order, migrations, the
+    # app factory) and only works with the same major version of it.
+    "splent_framework>=1.15.0,<2",
     "tomli_w>=1.0.0",
 ]
 

{splent_cli-1.23.0 → splent_cli-1.24.0}/src/splent_cli/cli.py

@@ -1,3 +1,4 @@
+import logging
 import os
 
 import click
@@ -37,6 +38,15 @@ class SPLENTCLI(click.Group):
             return self._feature_cmds_cache
 
         self._feature_cmds_cache: dict[str, click.BaseCommand] = {}
+        # Discovery runs before every command, including the ones a product
+        # that is not built yet (selected, not configured or derived) runs
+        # while getting there. Building its app then fails, and the framework
+        # logged that failure with a full traceback on every single command,
+        # although nothing was wrong. The failure is expected here and
+        # handled below, so the framework's logging is muted for the attempt.
+        debug = bool(os.getenv("SPLENT_DEBUG"))
+        if not debug:
+            logging.disable(logging.CRITICAL)
         try:
             from splent_cli.utils.dynamic_imports import get_app
 
@@ -57,10 +67,13 @@ class SPLENTCLI(click.Group):
                         group.add_command(cmd)
                     self._feature_cmds_cache[group.name] = group
         except Exception as e:
-            if os.getenv("SPLENT_DEBUG"):
+            if debug:
                 click.secho(
                     f"  ⚠ Feature commands not loaded: {e}", fg="yellow", err=True
                 )
+        finally:
+            if not debug:
+                logging.disable(logging.NOTSET)
         return self._feature_cmds_cache
 
     def get_command(self, ctx, cmd_name):

{splent_cli-1.23.0 → splent_cli-1.24.0}/src/splent_cli/commands/check/check_env.py

@@ -8,6 +8,8 @@ import sys
 import click
 import importlib.metadata
 
+from splent_cli.utils import forge
+
 
 def _pkg_version(name: str) -> str | None:
     try:
@@ -88,11 +90,12 @@ def check_env():
             f"CLI={'?' if not cli_v else cli_v} / Framework={'?' if not fw_v else fw_v}"
         )
 
-    # Credentials
-    if os.getenv("GITHUB_TOKEN"):
-        _ok("GITHUB_TOKEN set")
+    # Credentials. The forge token is named after the forge in use: asking for
+    # GITHUB_TOKEN on a git.splent.io workspace sent people to the wrong place.
+    if forge.token():
+        _ok(f"{forge.token_env_name()} set ({forge.host()})")
     else:
-        _warn("GITHUB_TOKEN not set")
+        _warn(f"{forge.token_env_name()} not set ({forge.host()})")
 
     if os.getenv("TWINE_PASSWORD") or os.getenv("PYPI_TOKEN"):
         _ok("PyPI token set")

{splent_cli-1.23.0 → splent_cli-1.24.0}/src/splent_cli/commands/check/check_infra.py

@@ -382,17 +382,33 @@ def check_infra():
     else:
         _ok(f"No port conflicts ({len(all_ports)} ports declared)")
 
-    # Check against running containers (query docker ps once, not per-port)
+    # Check against running containers (query docker ps once, not per-port).
+    # The product's own stacks are not conflicts: with the product up, every
+    # declared port is held by exactly the container meant to hold it, and
+    # reporting those as warnings made a healthy product look broken.
+    own_projects = {compose.project_name(product, env)} | {
+        compose.feature_project_name(compose.normalize_feature_ref(f), product, env)
+        for f in features
+    }
     running_conflicts = []
-    ps_result = _run(["docker", "ps", "--format", "{{.ID}}\t{{.Names}}\t{{.Ports}}"])
+    ps_result = _run(
+        [
+            "docker",
+            "ps",
+            "--format",
+            '{{.ID}}\t{{.Names}}\t{{.Label "com.docker.compose.project"}}\t{{.Ports}}',
+        ]
+    )
     if ps_result.returncode == 0:
         ps_lines = ps_result.stdout.splitlines()
         for port in all_ports:
             for line in ps_lines:
-                parts = line.split("\t", 2)
-                if len(parts) < 3:
+                parts = line.split("\t", 3)
+                if len(parts) < 4:
+                    continue
+                cid, name, project, ports_str = parts
+                if project in own_projects:
                     continue
-                cid, name, ports_str = parts
                 if f":{port}->" in ports_str:
                     running_conflicts.append((port, name))
 

{splent_cli-1.23.0 → splent_cli-1.24.0}/src/splent_cli/commands/database/db_migrate.py

@@ -1,4 +1,6 @@
 import os
+import shutil
+import subprocess
 
 import click
 from flask_migrate import migrate as alembic_migrate
@@ -46,10 +48,23 @@ def _is_empty_migration(path: str) -> bool:
     return True
 
 
+def _format_migration(path: str) -> None:
+    """Run ``ruff format`` on a freshly generated migration, if ruff exists.
+
+    Alembic writes single quotes and one long create_table() call, which the
+    release gate's ``ruff format --check`` then rejects: the first release of
+    any feature with a model failed lint on a file nobody wrote by hand.
+    """
+    ruff = shutil.which("ruff")
+    if not ruff:
+        return
+    subprocess.run([ruff, "format", "--quiet", path], check=False)
+
+
 @requires_db
 @click.command(
     "db:migrate",
-    short_help="Generate a new migration from model changes and apply it.",
+    short_help="Generate a new migration from model changes (db:upgrade applies it).",
 )
 @click.argument("feature", required=False, default=None)
 @click.option(
@@ -67,8 +82,8 @@ def _is_empty_migration(path: str) -> bool:
 @context.requires_product
 def db_migrate(feature, message, empty):
     """
-    Generate new migration files for features that have schema changes,
-    then apply all pending migrations.
+    Generate new migration files for features that have schema changes.
+    Nothing is applied: run ``splent db:upgrade`` for that.
 
     Empty migrations (no schema changes detected) are automatically removed,
     unless ``--empty`` is passed, in which case a blank migration is created
@@ -158,10 +173,23 @@ def db_migrate(feature, message, empty):
 
         after = _count_versions(mdir)
 
+        newest = None
+        if after > before:
+            versions_dir = os.path.join(mdir, "versions")
+            newest = max(
+                (
+                    os.path.join(versions_dir, f)
+                    for f in os.listdir(versions_dir)
+                    if f.endswith(".py")
+                ),
+                key=os.path.getmtime,
+            )
+
         # A blank migration requested with --empty is intentional: keep it so the
         # user can fill in upgrade()/downgrade() by hand (e.g. refinement columns).
         if empty:
-            if after > before:
+            if newest:
+                _format_migration(newest)
                 click.echo(
                     click.style(
                         f"  📝 {feat}: blank migration generated — "
@@ -174,20 +202,12 @@ def db_migrate(feature, message, empty):
             continue
 
         # If a new file was generated, check if it's empty (no real schema changes)
-        if after > before:
-            versions_dir = os.path.join(mdir, "versions")
-            newest = max(
-                (
-                    os.path.join(versions_dir, f)
-                    for f in os.listdir(versions_dir)
-                    if f.endswith(".py")
-                ),
-                key=os.path.getmtime,
-            )
+        if newest:
             if _is_empty_migration(newest):
                 os.remove(newest)
                 click.echo(click.style(f"  ✔ {feat}: up to date", fg="green"))
             else:
+                _format_migration(newest)
                 click.echo(
                     click.style(f"  📝 {feat}: new migration generated", fg="cyan")
                 )

{splent_cli-1.23.0 → splent_cli-1.24.0}/src/splent_cli/commands/database/db_status.py

@@ -104,8 +104,10 @@ def db_status():
         mdir = dirs.get(feat)
         fs_head = _get_filesystem_head(mdir) if mdir else None
 
-        db_display = db_rev[:12] if db_rev else "—"
-        fs_display = fs_head[:12] if fs_head else "—"
+        # Cut to the column, not to 12: a hex revision is 12 characters but a
+        # named one is not, and "auth0002_role" showed as "auth0002_rol".
+        db_display = db_rev[:col_rev] if db_rev else "—"
+        fs_display = fs_head[:col_rev] if fs_head else "—"
 
         if db_rev and fs_head and db_rev == fs_head:
             status = click.style("✔ synced", fg="green")

{splent_cli-1.23.0 → splent_cli-1.24.0}/src/splent_cli/commands/export/export_puml.py

@@ -817,7 +817,7 @@ def export_puml(
     if not uvl_path:
         click.secho(
             "❌ No UVL file found.\n"
-            "   Set [tool.splent].spl in pyproject.toml (SPL catalog)\n"
+            "   Set [tool.splent].spl in pyproject.toml (the SPL model)\n"
             "   or [tool.splent.uvl].file (legacy).",
             fg="red",
         )

{splent_cli-1.23.0 → splent_cli-1.24.0}/src/splent_cli/commands/feature/feature_contract.py

@@ -233,6 +233,17 @@ def _print_diff(current: dict, inferred: dict) -> bool:
             diff_lines.append(click.style(f"    - archetype: {old_arch}", fg="red"))
         diff_lines.append(click.style(f"    + archetype: {new_arch}", fg="green"))
 
+    # extensible.routes is a boolean; a flip alone is still a change to write
+    old_routes = bool(current.get("extensible_routes", False))
+    new_routes = bool(inferred.get("extensible_routes", False))
+    if old_routes != new_routes:
+        diff_lines.append(
+            click.style(
+                f"    ~ extensible.routes: {old_routes} → {new_routes}",
+                fg="green" if new_routes else "red",
+            )
+        )
+
     for key, label in FIELDS:
         diff_lines.extend(
             _diff_field(label, current.get(key, []), inferred.get(key, []))

{splent_cli-1.23.0 → splent_cli-1.24.0}/src/splent_cli/commands/feature/feature_impact.py

@@ -65,7 +65,7 @@ def feature_impact(feature_ref):
         click.secho("  pyproject.toml not found.", fg="red")
         raise SystemExit(1)
 
-    uvl = _uvl_path(product_dir)
+    uvl = _uvl_path(product_dir, workspace)
     if not uvl or not os.path.isfile(uvl):
         click.secho("  No UVL file found — cannot compute impact.", fg="red")
         raise SystemExit(1)

{splent_cli-1.23.0 → splent_cli-1.24.0}/src/splent_cli/commands/feature/feature_refine.py

@@ -54,6 +54,53 @@ def _is_stub(content: str) -> bool:
     return any(marker.lower() in lower for marker in _SCAFFOLD_MARKERS)
 
 
+def _scaffold_renderings(path: str) -> set[str]:
+    """What feature:create writes at *path*, for every feature type.
+
+    The refiner is created with feature:create right before the wizard runs,
+    so its models.py, services.py, repositories.py and __init__.py are exactly
+    the scaffold, yet none of them carries a marker. The wizard used to ask
+    whether to overwrite each one, default No, and keeping the old __init__.py
+    left an import of a service the wizard had just replaced, so the app no
+    longer booted. Comparing against the rendered scaffold recognises them
+    without stamping a marker into files developers then edit.
+    """
+    from splent_cli.commands.feature.feature_create import (
+        FEATURE_TYPES,
+        _build_file_map,
+        setup_jinja_env,
+    )
+
+    parts = os.path.normpath(path).split(os.sep)
+    if "src" not in parts:
+        return set()
+    at = len(parts) - 1 - parts[::-1].index("src")
+    if len(parts) < at + 4:
+        return set()
+    org_safe, feature_name = parts[at + 1], parts[at + 2]
+    rel = "/".join(parts[at + 3 :])
+    short_name = feature_name.removeprefix("splent_feature_")
+    ctx = {
+        "feature_name": feature_name,
+        "short_name": short_name,
+        "pascal_name": "".join(w.capitalize() for w in short_name.split("_")),
+        "org_safe": org_safe,
+        "feature_import": f"{org_safe}.{feature_name}",
+        "env_prefix": short_name.upper(),
+        "host_port_ref": "${" + short_name.upper() + "_HOST_PORT}",
+    }
+    env = setup_jinja_env()
+    rendered = set()
+    for feature_type in FEATURE_TYPES:
+        template = _build_file_map(feature_type, short_name)[0].get(rel)
+        if template:
+            try:
+                rendered.add(env.get_template(template).render(ctx).strip())
+            except Exception:
+                continue
+    return rendered
+
+
 def _confirm_overwrite(path: str, label: str) -> bool:
     """Warn before overwriting a non-stub source file. Returns True if it is
     safe to write (file absent, a stub, or the user confirmed)."""
@@ -61,7 +108,7 @@ def _confirm_overwrite(path: str, label: str) -> bool:
         return True
     with open(path, "r", encoding="utf-8") as f:
         existing = f.read()
-    if _is_stub(existing):
+    if _is_stub(existing) or existing.strip() in _scaffold_renderings(path):
         return True
     click.echo()
     click.secho(
@@ -301,17 +348,22 @@ class {mixin_name}:
         with open(models_path, "r") as f:
             content = f.read()
         if mixin_name in content:
-            return
+            click.echo(
+                click.style("  kept:       ", dim=True)
+                + f"models.py ({mixin_name} already there)"
+            )
+            return False
 
     # Warn before clobbering developer-authored models.py
     if not _confirm_overwrite(models_path, "models.py"):
         click.echo(click.style("  skipped:    ", dim=True) + "models.py (kept)")
-        return
+        return False
 
     # Overwrite — refinement features only need mixins, not db.Model classes
     os.makedirs(os.path.dirname(models_path), exist_ok=True)
     with open(models_path, "w") as f:
         f.write(mixin_code)
+    return True
 
 
 def _scaffold_service(
@@ -348,12 +400,16 @@ def _scaffold_service(
         with open(services_path, "r") as f:
             content = f.read()
         if replacement_name in content:
-            return
+            click.echo(
+                click.style("  kept:       ", dim=True)
+                + f"services.py ({replacement_name} already there)"
+            )
+            return False
 
     # Warn before clobbering developer-authored services.py
     if not _confirm_overwrite(services_path, "services.py"):
         click.echo(click.style("  skipped:    ", dim=True) + "services.py (kept)")
-        return
+        return False
 
     # Overwrite — refinement features only need replacement classes
     os.makedirs(os.path.dirname(services_path), exist_ok=True)
@@ -370,6 +426,7 @@ def _scaffold_service(
                 "# Refinement features do not need their own repository.\n"
                 "# The base feature's repository is used via the service locator.\n"
             )
+    return True
 
 
 def _scaffold_init(
@@ -436,14 +493,23 @@ def _scaffold_init(
         + "    return {}\n"
     )
 
+    # Running the wizard again finds the file it wrote last time; asking
+    # whether to overwrite it with the very same text only invites a "no".
+    if os.path.isfile(init_path):
+        with open(init_path, "r", encoding="utf-8") as f:
+            if f.read().strip() == code.strip():
+                click.echo(click.style("  unchanged:  ", dim=True) + "__init__.py")
+                return False
+
     # Warn before clobbering a developer-authored __init__.py
     if not _confirm_overwrite(init_path, "__init__.py"):
         click.echo(click.style("  skipped:    ", dim=True) + "__init__.py (kept)")
-        return
+        return False
 
     os.makedirs(os.path.dirname(init_path), exist_ok=True)
     with open(init_path, "w") as f:
         f.write(code)
+    return True
 
 
 def _update_env_py(
@@ -503,7 +569,9 @@ def _scaffold_hooks(
     for hook in fill_hooks:
         # notes.index.before_list → notes_index_before_list
         func_name = hook.replace(".", "_")
-        func_lines.append(f"def {func_name}():")
+        # Slots pass their context (notes.index.note_extra passes the note),
+        # so a stub that takes nothing raised TypeError the first time it ran.
+        func_lines.append(f"def {func_name}(*args, **kwargs):")
         func_lines.append(f'    """Fill the {hook} slot."""')
         func_lines.append(f'    return render_template("hooks/{func_name}.html")')
         func_lines.append("")
@@ -516,22 +584,41 @@ def _scaffold_hooks(
         "\n\n" + "\n".join(func_lines) + "\n".join(register_lines) + "\n"
     )
 
-    # Don't overwrite if hooks.py already has content
+    # Don't overwrite a hooks.py that already registers something. The
+    # scaffold only mentions register_template_hook inside its docstring, so a
+    # plain substring test mistook it for real content, skipped the write and
+    # still reported the hooks as scaffolded.
     if os.path.isfile(hooks_path):
         with open(hooks_path, "r") as f:
             existing = f.read()
-        if "register_template_hook" in existing:
-            return
+        if re.search(r"^register_template_hook\(", existing, re.MULTILINE):
+            click.echo(
+                click.style("  kept:       ", dim=True)
+                + "hooks.py (already registers hooks)"
+            )
+            return False
 
     # Warn before clobbering developer-authored hooks.py
     if not _confirm_overwrite(hooks_path, "hooks.py"):
         click.echo(click.style("  skipped:    ", dim=True) + "hooks.py (kept)")
-        return
+        return False
 
     os.makedirs(os.path.dirname(hooks_path), exist_ok=True)
     with open(hooks_path, "w") as f:
         f.write(code)
 
+    # The stubs render hooks/<name>.html. Without those files every page
+    # holding one of the slots failed with TemplateNotFound until each stub
+    # was rewritten, so an empty template goes with each stub.
+    tpl_dir = os.path.join(os.path.dirname(hooks_path), "templates", "hooks")
+    os.makedirs(tpl_dir, exist_ok=True)
+    for hook in fill_hooks:
+        tpl = os.path.join(tpl_dir, f"{hook.replace('.', '_')}.html")
+        if not os.path.exists(tpl):
+            with open(tpl, "w", encoding="utf-8") as f:
+                f.write(f"{{# Fills the {hook} slot. #}}\n")
+    return True
+
 
 def _clean_scaffold_for_refinement(feature_path: str, ns: str, feature_name: str):
     """Clean up scaffold files that cause false positives in refinement features.
@@ -906,31 +993,36 @@ def feature_refinement(refiner_name):
                 ns = d
                 break
 
+    # Each helper says itself why it left a file alone; "scaffolded" is only
+    # claimed for what was actually written.
     for model, mixin in extend_models:
-        _scaffold_mixin(refiner_path, ns, refiner_name, model, mixin)
-        click.echo(click.style("  scaffolded: ", dim=True) + f"models.py <- {mixin}")
+        if _scaffold_mixin(refiner_path, ns, refiner_name, model, mixin):
+            click.echo(
+                click.style("  scaffolded: ", dim=True) + f"models.py <- {mixin}"
+            )
 
     for target, replacement in override_services:
-        _scaffold_service(refiner_path, ns, refiner_name, target, replacement)
-        click.echo(
-            click.style("  scaffolded: ", dim=True) + f"services.py <- {replacement}"
-        )
+        if _scaffold_service(refiner_path, ns, refiner_name, target, replacement):
+            click.echo(
+                click.style("  scaffolded: ", dim=True)
+                + f"services.py <- {replacement}"
+            )
 
-    _scaffold_init(
+    if _scaffold_init(
         refiner_path,
         ns,
         refiner_name,
         base_short,
         extend_models,
         override_services,
-    )
-    click.echo(click.style("  scaffolded: ", dim=True) + "__init__.py")
+    ):
+        click.echo(click.style("  scaffolded: ", dim=True) + "__init__.py")
 
-    if fill_hooks:
-        _scaffold_hooks(refiner_path, ns, refiner_name, fill_hooks)
+    if fill_hooks and _scaffold_hooks(refiner_path, ns, refiner_name, fill_hooks):
         click.echo(
             click.style("  scaffolded: ", dim=True)
-            + f"hooks.py <- {len(fill_hooks)} hook slot(s)"
+            + f"hooks.py <- {len(fill_hooks)} hook slot(s), with empty "
+            "templates/hooks/*.html"
         )
 
     # Clean up scaffold files that are not needed for refinement features