bmsdna-devtools 0.31.0__tar.gz → 0.32.0__tar.gz

bmsdna_devtools-0.31.0/README.md → bmsdna_devtools-0.32.0/PKG-INFO

@@ -1,3 +1,17 @@
+Metadata-Version: 2.5
+Name: bmsdna-devtools
+Version: 0.32.0
+Summary: Shared Azure DevOps / GitHub / git / Azure Monitor developer tooling for BMS projects
+Requires-Python: >=3.14
+Requires-Dist: pgdevkit[db]>=0.7.1
+Requires-Dist: requests>=2.32.0
+Requires-Dist: rich>=13.0.0
+Requires-Dist: tomli-w>=1.0.0
+Requires-Dist: typer>=0.26.7
+Provides-Extra: lint
+Requires-Dist: sqlglot>=27.0.0; extra == 'lint'
+Description-Content-Type: text/markdown
+
 # bmsdna-devtools
 
 Shared developer tooling for BMS projects: PR build/check status and a
@@ -329,6 +343,13 @@ branch's PR closes (`Fixes #N`, or an issue/work-item URL in the PR body); it re
 that is none or several. If the issue's newest comment already is a "Taken by ..." claim (by anyone) it
 says so and posts nothing, so it's safe to run repeatedly -- including before `bdt issue do`.
 
+## `bdt env get-keys`
+
+Lists the variable **names** (never the values) defined in `.env`, `*.env` and `.env.*` files under the
+current directory (recursively, skipping `node_modules`, `.git`, `.venv`, `.worktrees` and `.claude`) and directly in `~`, so you (or an agent) can see which variables exist without `cat .env`.
+`--search TEXT` filters by key name (case-insensitive); `--no-home` leaves out the files in `~`. Files in `~` -- and any file using
+`export VAR=VALUE` -- are bash syntax, so the output adds a `source <file>` hint. Exits 1 if nothing matches.
+
 ## `bdt translate`
 
 One `translations.toml` is the source of truth for all UI translations; `bdt translate` generates the

bmsdna_devtools-0.31.0/PKG-INFO → bmsdna_devtools-0.32.0/README.md

@@ -1,17 +1,3 @@
-Metadata-Version: 2.5
-Name: bmsdna-devtools
-Version: 0.31.0
-Summary: Shared Azure DevOps / GitHub / git / Azure Monitor developer tooling for BMS projects
-Requires-Python: >=3.14
-Requires-Dist: pgdevkit[db]>=0.7.1
-Requires-Dist: requests>=2.32.0
-Requires-Dist: rich>=13.0.0
-Requires-Dist: tomli-w>=1.0.0
-Requires-Dist: typer>=0.26.7
-Provides-Extra: lint
-Requires-Dist: sqlglot>=27.0.0; extra == 'lint'
-Description-Content-Type: text/markdown
-
 # bmsdna-devtools
 
 Shared developer tooling for BMS projects: PR build/check status and a
@@ -343,6 +329,13 @@ branch's PR closes (`Fixes #N`, or an issue/work-item URL in the PR body); it re
 that is none or several. If the issue's newest comment already is a "Taken by ..." claim (by anyone) it
 says so and posts nothing, so it's safe to run repeatedly -- including before `bdt issue do`.
 
+## `bdt env get-keys`
+
+Lists the variable **names** (never the values) defined in `.env`, `*.env` and `.env.*` files under the
+current directory (recursively, skipping `node_modules`, `.git`, `.venv`, `.worktrees` and `.claude`) and directly in `~`, so you (or an agent) can see which variables exist without `cat .env`.
+`--search TEXT` filters by key name (case-insensitive); `--no-home` leaves out the files in `~`. Files in `~` -- and any file using
+`export VAR=VALUE` -- are bash syntax, so the output adds a `source <file>` hint. Exits 1 if nothing matches.
+
 ## `bdt translate`
 
 One `translations.toml` is the source of truth for all UI translations; `bdt translate` generates the

{bmsdna_devtools-0.31.0 → bmsdna_devtools-0.32.0}/bmsdna/devtools/cli.py

@@ -17,6 +17,7 @@ from pgdevkit.testdb import constants as pgdevkit_constants
 
 from . import ado_issue, api_usage as api_usage_mod, app_service_logs, commit as commit_mod, dead_code as dead_code_mod
 from . import env_config
+from . import env_files as env_files_mod
 from . import find_repo as find_repo_mod
 from . import issue_do as issue_do_mod
 from . import gh_issue, gh_pr
@@ -74,6 +75,9 @@ app.add_typer(pr_app, name="pr")
 translate_app = typer.Typer(name="translate", help="Generate <lng>.json files from translations.toml")
 app.add_typer(translate_app, name="translate")
 
+env_app = typer.Typer(name="env", help="Inspect .env files without exposing their values")
+app.add_typer(env_app, name="env")
+
 issue_app = typer.Typer(name="issue", help="Issue / work item commands (Azure DevOps or GitHub, auto-detected from the git remote)")
 app.add_typer(issue_app, name="issue")
 
@@ -1209,6 +1213,24 @@ def translate_cmd(
         typer.echo(f"Wrote {len(res.written)} file(s)")
 
 
+@env_app.command("get-keys")
+def env_get_keys(
+    search: str | None = typer.Option(None, "--search", "-s", help="Only keys containing this text (case-insensitive)"),
+    no_home: bool = typer.Option(False, "--no-home", help="Don't also list the env files directly in ~"),
+) -> None:
+    """List variable names (never values) from .env, *.env and .env.* files under the current directory (and in ~).
+
+    Skips node_modules, .git, .venv, .worktrees and .claude.
+    """
+    home = None if no_home else Path.home()
+    cwd = Path.cwd()
+    files = env_files_mod.get_keys(cwd, home, search)
+    if not files:
+        typer.echo("No matching env files/keys found.", err=True)
+        raise typer.Exit(1)
+    typer.echo(env_files_mod.format_keys(files, home, cwd))
+
+
 @translate_app.command("add")
 def translate_add(
     key: str = typer.Argument(..., help="Translation key, e.g. ADD_BUTTON"),

bmsdna_devtools-0.32.0/bmsdna/devtools/env_files.py

@@ -0,0 +1,123 @@
+"""List the variable *names* defined in dotenv-style files, never their values.
+
+Lets an agent (or human) find out which variables exist without `cat .env` /
+`printenv` putting secrets into the transcript.
+"""
+
+from __future__ import annotations
+
+import os
+import re
+from dataclasses import dataclass, field
+from pathlib import Path
+
+_KEY_RE = re.compile(r"^\s*(?:export\s+)?([A-Za-z_][A-Za-z0-9_.-]*)\s*=")
+# Never descended into: dependency/VCS/tooling trees that are huge and never hold project env files.
+SKIP_DIRS = frozenset({"node_modules", ".git", ".venv", ".worktrees", ".claude"})
+
+_EXPORT_RE = re.compile(r"^\s*export\s+[A-Za-z_]")
+
+
+@dataclass
+class EnvFile:
+    path: Path
+    keys: list[str] = field(default_factory=list)
+    uses_export: bool = False  # bash syntax (`export VAR=VALUE`): meant to be sourced
+    in_home: bool = False
+
+
+def _is_env_name(name: str) -> bool:
+    return name == ".env" or name.endswith(".env") or name.startswith(".env.")
+
+
+def _walk_env_files(root: Path) -> list[Path]:
+    """Env files under root, pruning SKIP_DIRS (and not following symlinked dirs) so big trees stay fast."""
+    found: list[Path] = []
+    for dirpath, dirnames, filenames in os.walk(root):
+        dirnames[:] = sorted(d for d in dirnames if d not in SKIP_DIRS)
+        base = Path(dirpath)
+        found.extend(base / n for n in sorted(filenames) if _is_env_name(n) and (base / n).is_file())
+    return found
+
+
+def find_env_files(cwd: Path, home: Path | None = None) -> list[tuple[Path, bool]]:
+    """`.env`, `*.env` and `.env.*` under cwd (recursive, skipping SKIP_DIRS) and directly in home.
+
+    Returns (path, in_home). When cwd is home itself it is not walked recursively.
+    """
+    found: list[tuple[Path, bool]] = []
+    seen: set[Path] = set()
+
+    def add(p: Path, in_home: bool) -> None:
+        real = p.resolve()
+        if real not in seen:
+            seen.add(real)
+            found.append((p, in_home))
+
+    if home is not None and cwd.resolve() == home.resolve():
+        cwd_files = [p for p in sorted(cwd.iterdir()) if _is_env_name(p.name) and p.is_file()]
+    else:
+        cwd_files = _walk_env_files(cwd)
+    for p in cwd_files:
+        add(p, False)
+    if home is not None:
+        for p in sorted(home.iterdir()):
+            if _is_env_name(p.name) and p.is_file():
+                add(p, True)
+    return found
+
+
+def parse_env_file(path: Path, in_home: bool = False) -> EnvFile:
+    res = EnvFile(path=path, in_home=in_home)
+    try:
+        text = path.read_text(encoding="utf-8", errors="replace")
+    except OSError:
+        return res
+    for line in text.splitlines():
+        if line.lstrip().startswith("#"):
+            continue
+        m = _KEY_RE.match(line)
+        if m:
+            if m.group(1) not in res.keys:
+                res.keys.append(m.group(1))
+            if _EXPORT_RE.match(line):
+                res.uses_export = True
+    return res
+
+
+def get_keys(cwd: Path, home: Path | None = None, search: str | None = None) -> list[EnvFile]:
+    """Env files with their key names; with `search`, only keys containing it (case-insensitive)."""
+    out: list[EnvFile] = []
+    for path, in_home in find_env_files(cwd, home):
+        ef = parse_env_file(path, in_home)
+        if search:
+            ef.keys = [k for k in ef.keys if search.lower() in k.lower()]
+            if not ef.keys:
+                continue
+        out.append(ef)
+    return out
+
+
+def _display(path: Path, cwd: Path | None, home: Path | None) -> Path:
+    for base, prefix in ((cwd, None), (home, Path("~"))):
+        if base is None:
+            continue
+        try:
+            rel = path.relative_to(base)
+        except ValueError:
+            continue
+        return prefix / rel if prefix else rel
+    return path
+
+
+def format_keys(files: list[EnvFile], home: Path | None = None, cwd: Path | None = None) -> str:
+    """Paths under cwd are shown relative to it, home files as ~/..., so the `source` hint works as printed."""
+    lines: list[str] = []
+    for ef in files:
+        shown = _display(ef.path, None if ef.in_home else cwd, home if ef.in_home else None)
+        lines.append(f"{shown}:")
+        if ef.in_home or ef.uses_export:
+            src = f"./{shown}" if not shown.is_absolute() and not str(shown).startswith("~") else shown
+            lines.append(f"  # bash syntax, load with: source {src}")
+        lines.extend(f"  {k}" for k in ef.keys)
+    return "\n".join(lines)

{bmsdna_devtools-0.31.0 → bmsdna_devtools-0.32.0}/pyproject.toml

@@ -10,7 +10,7 @@ packages = ["bmsdna"]
 
 [project]
 name = "bmsdna-devtools"
-version = "0.31.0"
+version = "0.32.0"
 description = "Shared Azure DevOps / GitHub / git / Azure Monitor developer tooling for BMS projects"
 readme = "README.md"
 requires-python = ">=3.14"  # pgdevkit>=0.7.1 requires 3.14; was >=3.11 before adding it as a dependency

{bmsdna_devtools-0.31.0 → bmsdna_devtools-0.32.0}/skills/bmsdna-devtools/SKILL.md

@@ -6,11 +6,11 @@ description: >
   a PR, creating a git worktree, committing and pushing files (with pre-flight
   checks), claiming an issue / work item (`bdt issue take`), a one-shot PR summary
   (`bdt pr info`: link, build state, closed issues), querying Azure logs, and static checks (`bdt lint`: SQL/psycopg rules, pydantic placement, tooling; `bdt dead-code`:
-  unreferenced .sql files and backend routes nothing calls). `bdt pr *` works against both Azure DevOps
+  unreferenced .sql files and backend routes nothing calls), listing which env vars a repo defines (`bdt env get-keys`, names only). `bdt pr *` works against both Azure DevOps
   and GitHub — it auto-detects which one from the `origin` remote. Trigger
   whenever the user asks to check a build/PR status, create a PR, make a
   worktree, commit changes, fetch/tail application logs, lint a repo, find dead API routes /
-  unused .sql files, or start working on / take an issue ("work on issue #N"), in a repo that has
+  unused .sql files, find out which environment variables exist, or start working on / take an issue ("work on issue #N"), in a repo that has
   bmsdna-devtools installed (check for `bdt` on PATH, or `bmsdna-devtools` in
   pyproject.toml, before assuming it applies).
 ---
@@ -130,6 +130,12 @@ vendor a git submodule under that path.
   adopt with `--update-baseline`). `--only sql|routes` runs one check. The routes check imports the app, so run it with
   the repo's own interpreter (`uv run`). Generated API-client code and tests never count as callers.
 
+## Environment variables
+
+`bdt env get-keys [--search TEXT] [--no-home]` lists the variable **names** (never values) from `.env`, `*.env` and `.env.*`
+files under the current directory (recursive; skips node_modules/.git/.venv/.worktrees/.claude) and in `~` (`--no-home` skips those). Use it instead of `cat .env` / `printenv` to find out which variables exist;
+files in `~` (and ones using `export VAR=...`) are bash syntax, so the output says to `source` them.
+
 ## Application Insights logs
 
 ```bash

bmsdna_devtools-0.32.0/tests/test_env_files.py

@@ -0,0 +1,92 @@
+from pathlib import Path
+
+from typer.testing import CliRunner
+
+from bmsdna.devtools.cli import app
+from bmsdna.devtools.env_files import format_keys, get_keys
+
+
+def _setup(tmp_path: Path) -> tuple[Path, Path]:
+    cwd = tmp_path / "proj"
+    home = tmp_path / "home"
+    cwd.mkdir()
+    home.mkdir()
+    (cwd / ".env").write_text("# comment\nDB_URL=postgres://u:secret@h/db\n\nAPI_KEY = 'topsecret'\nDB_URL=dup\n")
+    (cwd / "ci.env").write_text("export TOKEN=abc\n")
+    (cwd / "notes.txt").write_text("NOT_AN_ENV=1\n")
+    (home / "work.env").write_text("export HOME_VAR=hunter2\n")
+    return cwd, home
+
+
+def test_lists_keys_only_never_values(tmp_path):
+    cwd, home = _setup(tmp_path)
+    out = format_keys(get_keys(cwd, home), home, cwd)
+    assert "DB_URL" in out and "API_KEY" in out and "TOKEN" in out and "HOME_VAR" in out
+    assert "secret" not in out and "hunter2" not in out and "abc" not in out
+    assert "NOT_AN_ENV" not in out
+    assert out.count("DB_URL") == 1
+
+
+def test_bash_syntax_hint_for_home_and_export_files(tmp_path):
+    cwd, home = _setup(tmp_path)
+    out = format_keys(get_keys(cwd, home), home, cwd)
+    assert "source ~/work.env" in out
+    assert "source ./ci.env" in out
+    assert "source ./.env" not in out
+
+
+def test_search_filters_keys_and_drops_empty_files(tmp_path):
+    cwd, home = _setup(tmp_path)
+    files = get_keys(cwd, home, "api")
+    assert [f.keys for f in files] == [["API_KEY"]]
+
+
+def test_cli_exit_1_when_nothing_found(tmp_path, monkeypatch):
+    monkeypatch.chdir(tmp_path)
+    monkeypatch.setenv("HOME", str(tmp_path))
+    res = CliRunner().invoke(app, ["env", "get-keys"])
+    assert res.exit_code == 1
+
+
+def test_cli_prints_keys(tmp_path, monkeypatch):
+    cwd, home = _setup(tmp_path)
+    monkeypatch.chdir(cwd)
+    monkeypatch.setenv("HOME", str(home))
+    res = CliRunner().invoke(app, ["env", "get-keys", "--search", "token"])
+    assert res.exit_code == 0
+    assert "TOKEN" in res.output and "abc" not in res.output
+
+
+def test_scans_subdirectories_but_skips_excluded_dirs(tmp_path):
+    cwd, home = _setup(tmp_path)
+    (cwd / "app").mkdir()
+    (cwd / "app" / ".env").write_text("SUB_VAR=1\n")
+    for d in ("node_modules", ".git", ".venv", ".worktrees", ".claude"):
+        (cwd / d / "pkg").mkdir(parents=True)
+        (cwd / d / "pkg" / ".env").write_text(f"SKIPPED_{d.strip('.').upper()}=1\n")
+    out = format_keys(get_keys(cwd, home), home, cwd)
+    assert "app/.env:" in out and "SUB_VAR" in out
+    assert "SKIPPED_" not in out
+
+
+def test_no_home_omits_home_files(tmp_path):
+    cwd, home = _setup(tmp_path)
+    out = format_keys(get_keys(cwd, None), None, cwd)
+    assert "HOME_VAR" not in out and "DB_URL" in out
+
+
+def test_cwd_equal_home_is_not_walked_recursively(tmp_path):
+    cwd, home = _setup(tmp_path)
+    (home / "deep").mkdir()
+    (home / "deep" / ".env").write_text("DEEP=1\n")
+    out = format_keys(get_keys(home, home), home, home)
+    assert "HOME_VAR" in out and "DEEP" not in out
+
+
+def test_cli_no_home_flag(tmp_path, monkeypatch):
+    cwd, home = _setup(tmp_path)
+    monkeypatch.chdir(cwd)
+    monkeypatch.setenv("HOME", str(home))
+    res = CliRunner().invoke(app, ["env", "get-keys", "--no-home"])
+    assert res.exit_code == 0
+    assert "DB_URL" in res.output and "HOME_VAR" not in res.output

{bmsdna_devtools-0.31.0 → bmsdna_devtools-0.32.0}/uv.lock

@@ -22,7 +22,7 @@ wheels = [
 
 [[package]]
 name = "bmsdna-devtools"
-version = "0.31.0"
+version = "0.32.0"
 source = { editable = "." }
 dependencies = [
     { name = "pgdevkit", extra = ["db"] },