scip-cli 2.3.0__tar.gz → 2.4.0__tar.gz

{scip_cli-2.3.0 → scip_cli-2.4.0}/.cursor/rules/agent.mdc

@@ -33,8 +33,9 @@ Node.js + `npx` required for integration tests (`scip-typescript`). Optional: `S
 | Full suite | `pytest` |
 | E2e loop | `pytest tests/test_e2e.py tests/test_e2e_analyze_patterns.py` |
 | Lint / format | `ruff check .` / `ruff format .` |
+| Typecheck | `basedpyright scip_cli/` |
 
-Pre-commit: ruff + ruff-format + full pytest. E2e before commit on command changes.
+Pre-commit: ruff + ruff-format + basedpyright + full pytest. E2e before commit on command changes.
 
 ## Improving this repo (do this before review subagents)
 

{scip_cli-2.3.0 → scip_cli-2.4.0}/.pre-commit-config.yaml

@@ -5,6 +5,10 @@ repos:
       - id: ruff
         args: [--fix]
       - id: ruff-format
+  - repo: https://github.com/DetachHead/basedpyright-pre-commit-mirror
+    rev: 1.39.9
+    hooks:
+      - id: basedpyright
   - repo: local
     hooks:
       - id: pytest

{scip_cli-2.3.0 → scip_cli-2.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: scip-cli
-Version: 2.3.0
+Version: 2.4.0
 Summary: Fast code intelligence via SCIP indexes
 Project-URL: Homepage, https://github.com/flesler/scip-cli
 Author: Ariel Flesler
@@ -12,6 +12,7 @@ Classifier: Programming Language :: Python :: 3
 Classifier: Topic :: Software Development :: Code Generators
 Requires-Python: >=3.9
 Provides-Extra: dev
+Requires-Dist: basedpyright>=1.39.9; extra == 'dev'
 Requires-Dist: build>=1; extra == 'dev'
 Requires-Dist: pre-commit>=4.0; extra == 'dev'
 Requires-Dist: pytest>=7; extra == 'dev'
@@ -79,7 +80,7 @@ python -m venv .venv && source .venv/bin/activate
 pip install -e ".[dev]"
 ```
 
-Tests and lint: `pytest`, `ruff check .` from the same environment.
+Tests and lint: `pytest`, `ruff check .`, `basedpyright scip_cli/` from the same environment (or `scripts/test.sh` for the publish gate).
 
 ### 2. Install prerequisites (optional)
 

{scip_cli-2.3.0 → scip_cli-2.4.0}/README.md

@@ -59,7 +59,7 @@ python -m venv .venv && source .venv/bin/activate
 pip install -e ".[dev]"
 ```
 
-Tests and lint: `pytest`, `ruff check .` from the same environment.
+Tests and lint: `pytest`, `ruff check .`, `basedpyright scip_cli/` from the same environment (or `scripts/test.sh` for the publish gate).
 
 ### 2. Install prerequisites (optional)
 

{scip_cli-2.3.0 → scip_cli-2.4.0}/pyproject.toml

@@ -32,6 +32,7 @@ packages = ["scip_cli"]
 [project.optional-dependencies]
 dev = [
     "ruff>=0.11",
+    "basedpyright>=1.39.9",
     "pytest>=7",
     "pre-commit>=4.0",
     "build>=1",
@@ -57,3 +58,20 @@ addopts = "-q --tb=line --no-header"
 markers = [
     "integration: uses the shared indexed TS fixture (requires npx / scip-typescript)",
 ]
+
+[tool.basedpyright]
+pythonVersion = "3.10"
+venvPath = "."
+venv = ".venv"
+include = ["scip_cli"]
+exclude = ["tests"]
+
+# Gradual typing: basedpyright's unknown* rules fire hundreds of times on CLI/SQL glue
+# pythonVersion=3.10 matches union syntax in annotations; package still supports 3.9 via __future__ annotations
+reportAny = "none"
+reportUnknownParameterType = "none"
+reportUnknownArgumentType = "none"
+reportUnknownVariableType = "none"
+reportUnknownMemberType = "none"
+reportMissingParameterType = "none"
+reportUnusedCallResult = "none"

{scip_cli-2.3.0 → scip_cli-2.4.0}/scip_cli/__init__.py

@@ -1,3 +1,3 @@
 """scip-cli: Fast code intelligence via SCIP indexes."""
 
-__version__ = "2.3.0"
+__version__ = "2.4.0"

{scip_cli-2.3.0 → scip_cli-2.4.0}/scip_cli/__main__.py

@@ -1,11 +1,14 @@
 """CLI entry point for scip-cli."""
 
+from __future__ import annotations
+
 import argparse
 import logging
 import os
 import shutil
 import sqlite3
 import sys
+from collections.abc import Callable
 
 from . import __version__
 from .cli_args import add_limit_argument, add_names_only_argument, add_path_argument, add_paths_only_argument
@@ -19,7 +22,7 @@ else:
     logging.disable(logging.DEBUG)
 
 
-def main():
+def main() -> None:
     parser = argparse.ArgumentParser(
         prog="scip-cli",
         description="Fast code intelligence via SCIP indexes",
@@ -45,7 +48,7 @@ def main():
         type=int,
         default=None,
         metavar="N",
-        help=("Max source lines per definition body (default: 80, env SCIP_CLI_MAX_DEF_LINES). Use 0 for unlimited."),
+        help="Max source lines per definition body (default: 80, env SCIP_CLI_MAX_DEF_LINES). Use 0 for unlimited.",
     )
     code_parser.add_argument(
         "--full",
@@ -151,7 +154,7 @@ def main():
         return
 
     # Dispatch to command handlers
-    dispatch = {
+    dispatch: dict[str, Callable[..., None]] = {
         "refs": refs.main,
         "code": code.main,
         "search": search.main,

{scip_cli-2.3.0 → scip_cli-2.4.0}/scip_cli/analyze/common.py

@@ -16,7 +16,7 @@ SYM_DEF_JOIN = """
 """
 
 
-def fetch_all(db, sql: str, params=()) -> list:
+def fetch_all(db, sql: str, params=()):
     return debug_execute(db, sql, params).fetchall()
 
 

{scip_cli-2.3.0 → scip_cli-2.4.0}/scip_cli/analyze/file.py

@@ -298,7 +298,7 @@ def top_symbol_pressure(db, relative_path: str, limit: int = DEFAULT_LIMIT) -> l
 
 
 def _bind_path(fn, relative_path: str):
-    def run(db, limit: int, **kwargs):
+    def run(db, limit: int, **_kwargs):
         return fn(db, relative_path, limit)
 
     return run

{scip_cli-2.3.0 → scip_cli-2.4.0}/scip_cli/analyze/live.py

@@ -15,7 +15,7 @@ _EXTERNAL_MENTION = """
 """
 
 
-def _fetch_all(db, sql: str, params=()) -> list:
+def _fetch_all(db, sql: str, params=()):
     return debug_execute(db, sql, params).fetchall()
 
 

{scip_cli-2.3.0 → scip_cli-2.4.0}/scip_cli/analyze/project.py

@@ -416,7 +416,6 @@ def run_all(
     budget=None,
 ) -> list[tuple[str, list[str], str | None]]:
     suffix = _scope_suffix(scope)
-    opts = {"include_tests": include_tests, "scope": scope, "budget": budget}
     checks = [
         Check("cycles", Priority.HIGH, f"Cycles (file dependencies){suffix}", cycles),
         Check("unreferenced", Priority.HIGH, f"Unreferenced symbols (no refs){suffix}", unreferenced_symbols),
@@ -438,4 +437,12 @@ def run_all(
         Check("bottlenecks", Priority.LOW, f"Bottlenecks (fan-in x fan-out){suffix}", bottlenecks),
         Check("hotspots", Priority.LOW, f"Hotspots (most referenced){suffix}", hotspots),
     ]
-    return run_checks(checks, db, limit, priorities, **opts)
+    return run_checks(
+        checks,
+        db,
+        limit,
+        priorities,
+        include_tests=include_tests,
+        scope=scope,
+        budget=budget,
+    )

{scip_cli-2.3.0 → scip_cli-2.4.0}/scip_cli/analyze/sections.py

@@ -5,7 +5,6 @@ from __future__ import annotations
 from collections.abc import Callable
 from dataclasses import dataclass
 from enum import Enum
-from typing import Any
 
 from .common import section
 
@@ -101,20 +100,23 @@ def run_checks(
     db,
     limit: int,
     priorities: set[Priority] | None,
-    **kwargs: Any,
+    *,
+    include_tests: bool = False,
+    scope: str | None = None,
+    budget: RowBudget | None = None,
 ) -> list[tuple[str, list[str], str | None]]:
     """Run checks in priority order (high → low), optionally filtered."""
     selected = [check for check in checks if priorities is None or check.priority in priorities]
     selected.sort(key=lambda check: (_ORDER.index(check.priority), check.key))
-    budget: RowBudget = kwargs.pop("budget", None) or RowBudget(remaining=limit)
+    budget_obj: RowBudget = budget or RowBudget(remaining=limit)
     sections: list[tuple[str, list[str], str | None]] = []
     for check in selected:
-        if budget.exhausted():
+        if budget_obj.exhausted():
             break
-        lines = check.run(db, budget.remaining, **kwargs)
+        lines = check.run(db, budget_obj.remaining, include_tests=include_tests, scope=scope)
         if lines != ["(none)"]:
-            lines = lines[: budget.remaining]
-            budget.remaining -= len(lines)
+            lines = lines[: budget_obj.remaining]
+            budget_obj.remaining -= len(lines)
         preface = check.false_positive_preface if check.false_positive_preface else _preface_for(check.key)
         sections.append(section(check.labeled_title(), lines, preface=preface))
     return sections

{scip_cli-2.3.0 → scip_cli-2.4.0}/scip_cli/analyze/symbol.py

@@ -8,14 +8,14 @@ from .sections import Check, Priority, run_checks
 
 
 def _bind_symbol(fn, symbol_id: int):
-    def run(db, limit: int, **kwargs):
+    def run(db, limit: int, **_kwargs):
         return fn(db, symbol_id, limit)
 
     return run
 
 
 def _bind_symbol0(fn, symbol_id: int):
-    def run(db, limit: int, **kwargs):
+    def run(db, _limit: int, **_kwargs):
         return fn(db, symbol_id)
 
     return run

{scip_cli-2.3.0 → scip_cli-2.4.0}/scip_cli/cache.py

@@ -1,5 +1,7 @@
 """Index cache path resolution."""
 
+from __future__ import annotations
+
 import contextlib
 import fcntl
 import hashlib
@@ -78,13 +80,13 @@ def project_cache_slug(project_root: Path) -> str:
     return f"{slug}-{digest}"
 
 
-def get_cache_dir(project_root):
+def get_cache_dir(project_root: Path | str) -> Path:
     """Get the cache directory for a project (one dir per repo root)."""
     root = Path(project_root).resolve()
     return Path.home() / ".cache" / "scip-cli" / "projects" / project_cache_slug(root)
 
 
-def find_db(project_root=None):
+def find_db(project_root: Path | str | None = None) -> Path | None:
     """Find the index.db for the given project (or cwd)."""
     root = project_root or find_project_root()
     if not root:

{scip_cli-2.3.0 → scip_cli-2.4.0}/scip_cli/commands/analyze.py

@@ -1,5 +1,7 @@
 """analyze command — run SQL-based analysis dashboards."""
 
+from __future__ import annotations
+
 import sys
 
 from ..analyze import file as file_checks
@@ -85,8 +87,10 @@ def _dir_sections(
         )
     elif total > MAX_DIR_FILES:
         print(
-            f"Note: {total} indexed files under {scope}; showing first {MAX_DIR_FILES} "
-            f"(analyze one file for full detail)",
+            (
+                f"Note: {total} indexed files under {scope}; showing first {MAX_DIR_FILES} "
+                f"(analyze one file for full detail)"
+            ),
             file=sys.stderr,
         )
         files = files[:MAX_DIR_FILES]
@@ -127,29 +131,28 @@ def main(args):
             )
         else:
             resolved = resolve_analyze_target(db, target, project_root, path_scope)
+            scope = resolved.scope or ""
             if resolved.kind == "dir":
                 sections = _dir_sections(
                     db,
-                    resolved.scope,
+                    scope,
                     limit=limit,
                     include_tests=include_tests,
                     priorities=priorities,
                     budget=budget,
                 )
             elif resolved.kind == "file":
-                file_include = _project_include_tests(include_tests, resolved.scope)
+                file_include = _project_include_tests(include_tests, scope)
                 sections = _project_sections(
                     db,
                     limit=limit,
                     include_tests=file_include,
-                    scope=resolved.scope,
+                    scope=scope,
                     priorities=priorities,
                     budget=budget,
                 )
                 if not budget.exhausted():
-                    sections.extend(
-                        _file_sections(db, resolved.scope, limit=limit, priorities=priorities, budget=budget)
-                    )
+                    sections.extend(_file_sections(db, scope, limit=limit, priorities=priorities, budget=budget))
             else:
                 symbol_id, _symbol_str, _display = resolve_one_symbol(
                     db,
@@ -160,5 +163,4 @@ def main(args):
 
         _print_sections(sections)
     finally:
-        if db is not None:
-            db.close()
+        db.close()

{scip_cli-2.3.0 → scip_cli-2.4.0}/scip_cli/commands/deps.py

@@ -5,8 +5,8 @@ import sys
 from ..cli_args import path_scope_from_args
 from ..output import limit_and_warn
 from ..paths import path_in_scope
-from ..queries import debug_execute
 from ..session import resolve_one_file, resolve_one_symbol, setup
+from ..sql import debug_execute
 from ..symbols import extract_leaf_name
 
 

{scip_cli-2.3.0 → scip_cli-2.4.0}/scip_cli/commands/members.py

@@ -79,7 +79,7 @@ def main(args):
 
                 for i, line in enumerate(source_lines):
                     if any(re.match(p, line) for p in patterns):
-                        start_line = parent_start + i
+                        start_line = (parent_start or 0) + i
                         end_line = start_line
                         break
 

{scip_cli-2.3.0 → scip_cli-2.4.0}/scip_cli/commands/reindex.py

@@ -9,7 +9,7 @@ from ..cache import (
     index_db_path,
     promote_next_index,
 )
-from ..indexing import _index_project, log_index_complete
+from ..indexing import index_project, log_index_complete
 from ..paths import normalize_path_scope
 from ..project import Language, find_project_root_and_language
 from ..scope import save_index_scope
@@ -27,12 +27,20 @@ def main(args):
         sys.exit(1)
 
     if path_args:
-        scope_paths = [normalize_path_scope(path, root) for path in path_args]
+        scope_paths: list[str] = []
+        for path in path_args:
+            normalized = normalize_path_scope(path, root)
+            if normalized is None:
+                print(f"Error: invalid or empty --path: {path!r}", file=sys.stderr)
+                sys.exit(1)
+            scope_paths.append(normalized)
         save_index_scope(root, scope_paths)
         print(f"Index scope: {', '.join(scope_paths)}", file=sys.stderr)
         print(
-            "Warning: scoped reindex replaces the cache with only these projects; "
-            "run reindex with no --path to restore the full index",
+            (
+                "Warning: scoped reindex replaces the cache with only these projects; "
+                "run reindex with no --path to restore the full index"
+            ),
             file=sys.stderr,
         )
     else:
@@ -48,7 +56,7 @@ def main(args):
     with index_build_lock(cache_dir):
         cleanup_in_progress_index(cache_dir)
         try:
-            _output_db, skipped, total = _index_project(root, lang, cache_dir, replace=True, log=False)
+            _output_db, skipped, total = index_project(root, lang, cache_dir, replace=True, log=False)
         except RuntimeError as e:
             cleanup_in_progress_index(cache_dir)
             print(f"Error: {e}", file=sys.stderr)

{scip_cli-2.3.0 → scip_cli-2.4.0}/scip_cli/commands/search.py

@@ -1,5 +1,7 @@
 """search command - search symbols by pattern."""
 
+from __future__ import annotations
+
 import re
 import sys
 
@@ -117,12 +119,12 @@ def _qualified_pattern(pattern: str) -> bool:
 def _search_results_from_symbols(db, project_root, symbols, limit):
     """Turn resolve_symbol rows into search result tuples."""
     symbols = limit_and_warn(symbols, limit, "results")
-    results = []
+    results: list[tuple[str, int | str, str, str]] = []
     for symbol_id, symbol_str, _display_name in symbols:
         loc = resolve_def_location(db, project_root, symbol_id, symbol_str)
         if loc:
             file_path, start_line, _end_line = loc
-            line = start_line + 1
+            line: int | str = start_line + 1
         else:
             file_path = _resolve_file_path(db, symbol_str)
             line = "?"
@@ -229,7 +231,7 @@ def main(args):
             loc = resolve_def_location(db, project_root, symbol_id, symbol_str)
             if loc:
                 file_path, resolved_start, _end = loc
-                line = resolved_start + 1
+                line: int | str = resolved_start + 1
             else:
                 file_path = _resolve_file_path(db, symbol_str, doc_path)
                 line = start_line + 1 if start_line is not None else "?"

{scip_cli-2.3.0 → scip_cli-2.4.0}/scip_cli/discover.py

@@ -23,7 +23,7 @@ _SKIP_DIR_NAMES = frozenset(
 )
 
 
-def _read_json(path: Path) -> dict | None:
+def _read_json(path: Path) -> dict[str, object] | None:
     try:
         return json.loads(path.read_text(encoding="utf-8"))
     except (OSError, json.JSONDecodeError):
@@ -52,7 +52,9 @@ def _tsconfig_covers_subdirectories(tsconfig_path: Path) -> bool:
     if not data:
         return False
     include = data.get("include")
-    if include is None or not include:
+    if isinstance(include, str):
+        include = [include]
+    if not isinstance(include, list) or not include:
         return False
     return any(isinstance(pattern, str) and ("**" in pattern or "/" in pattern) for pattern in include)
 

{scip_cli-2.3.0 → scip_cli-2.4.0}/scip_cli/indexing.py

@@ -1,5 +1,7 @@
 """SCIP index building and SQLite database access."""
 
+from __future__ import annotations
+
 import os
 import re
 import shutil
@@ -9,7 +11,6 @@ import sys
 import tempfile
 from concurrent.futures import ThreadPoolExecutor, as_completed
 from pathlib import Path
-from typing import Optional
 
 from .cache import (
     cleanup_in_progress_index,
@@ -59,7 +60,7 @@ def log_index_complete(
     db_path: Path,
     lang: str,
     *,
-    projects: Optional[int] = None,
+    projects: int | None = None,
     skipped: int = 0,
 ) -> None:
     """One-line stderr summary after a successful index write."""
@@ -188,8 +189,8 @@ def _warn_old_scip(binary):
         _scip_version_warned = True
         print(
             f"Warning: {binary} {'.'.join(map(str, version))} is older than 0.8.0; "
-            "upgrade from "
-            f"{SCIP_INSTALL_URL} if indexing fails.",
+            + "upgrade from "
+            + f"{SCIP_INSTALL_URL} if indexing fails.",
             file=sys.stderr,
         )
 
@@ -388,6 +389,7 @@ def _index_typescript(root, cache_dir, projects, env, *, replace=False):
                     ): index
                     for index, project in enumerate(projects, start=1)
                 }
+                indexed_parts: list[tuple[int, Path]] = []
                 for future in as_completed(futures):
                     label, db_path, error = future.result()
                     completed += 1
@@ -395,10 +397,10 @@ def _index_typescript(root, cache_dir, projects, env, *, replace=False):
                         skipped += 1
                         print(f"Warning: skipped {label}: {error}", file=sys.stderr)
                     else:
-                        part_dbs.append((futures[future], db_path))
+                        indexed_parts.append((futures[future], db_path))
                         if show_progress:
                             print(f"Indexed {completed}/{total}: {label}", file=sys.stderr)
-            part_dbs = [db for _, db in sorted(part_dbs, key=lambda item: item[0])]
+            part_dbs = [db for _, db in sorted(indexed_parts, key=lambda item: item[0])]
         else:
             for index, project in enumerate(projects, start=1):
                 label = "." if project == Path(".") else str(project)
@@ -427,7 +429,7 @@ def _index_typescript(root, cache_dir, projects, env, *, replace=False):
         return output_db, len(part_dbs), skipped, total
 
 
-def _index_project(root, lang, cache_dir, *, replace=False, log=True):
+def index_project(root, lang, cache_dir, *, replace=False, log=True):
     """Run the language-specific indexer and convert to DB."""
     from .project import Language
 
@@ -497,7 +499,7 @@ def get_db(project_root=None):
             else:
                 cleanup_in_progress_index(cache_dir)
                 try:
-                    _output_db, skipped, total = _index_project(root, lang, cache_dir, replace=True, log=False)
+                    _output_db, skipped, total = index_project(root, lang, cache_dir, replace=True, log=False)
                     promote_next_index(cache_dir)
                     log_index_complete(
                         index_db_path(cache_dir),

{scip_cli-2.3.0 → scip_cli-2.4.0}/scip_cli/output.py

@@ -153,7 +153,9 @@ def print_def_truncation_notice(query_name, body_offset, lines_shown, def_body_l
         return
     at_line = body_offset + lines_shown
     print(
-        f"Warning: truncated at line {at_line}/{def_body_lines} of definition. "
-        f"Continue: code --offset {next_offset} {query_name}",
+        (
+            f"Warning: truncated at line {at_line}/{def_body_lines} of definition. "
+            f"Continue: code --offset {next_offset} {query_name}"
+        ),
         file=sys.stderr,
     )

{scip_cli-2.3.0 → scip_cli-2.4.0}/scip_cli/paths.py

@@ -2,6 +2,7 @@
 
 from __future__ import annotations
 
+import sqlite3
 from pathlib import Path
 
 from .sql import debug_execute, escape_like
@@ -33,7 +34,7 @@ def path_in_scope(relative_path: str, scope: str | None) -> bool:
     return relative_path.startswith(scope.rstrip("/") + "/")
 
 
-def path_filter_sql(db, scope: str | None, doc_alias: str = "d") -> tuple[str, list]:
+def path_filter_sql(db: sqlite3.Connection, scope: str | None, doc_alias: str = "d") -> tuple[str, list[str]]:
     """Build a SQL AND-clause that restricts rows to a file or directory scope."""
     if not scope:
         return "", []
@@ -49,13 +50,13 @@ def path_filter_sql(db, scope: str | None, doc_alias: str = "d") -> tuple[str, l
     return f" AND ({col} = ? OR {col} LIKE ? ESCAPE '\\')", [scope, f"{escaped}/%"]
 
 
-def path_filter_sql_any(db, scope: str | None, *doc_aliases: str) -> tuple[str, list]:
+def path_filter_sql_any(db: sqlite3.Connection, scope: str | None, *doc_aliases: str) -> tuple[str, list[str]]:
     """AND-clause: row matches when any document alias column falls in scope."""
     if not scope:
         return "", []
 
     parts: list[str] = []
-    params: list = []
+    params: list[str] = []
     for alias in doc_aliases:
         clause, clause_params = path_filter_sql(db, scope, doc_alias=alias)
         if not clause:
@@ -69,7 +70,7 @@ def path_filter_sql_any(db, scope: str | None, *doc_aliases: str) -> tuple[str,
     return " AND (" + " OR ".join(parts) + ")", params
 
 
-def list_indexed_paths_in_scope(db, scope: str) -> list[str]:
+def list_indexed_paths_in_scope(db: sqlite3.Connection, scope: str) -> list[str]:
     """Repo-relative document paths under scope (file or directory), sorted."""
     clause, params = path_filter_sql(db, scope, doc_alias="d")
     if not clause: