devready-cli 0.2.0__py3-none-any.whl → 1.0.0__py3-none-any.whl

devready/__init__.py

@@ -1 +1 @@
-__version__ = "0.2.0"
+__version__ = "1.0.0"

devready/checks/platform_checks.py

@@ -0,0 +1,108 @@
+"""OS-specific pain points, each checked only when the project makes it relevant.
+
+Windows: long paths, PowerShell execution policy (blocks npm.ps1), git line endings.
+macOS/Linux: a compiler toolchain when the project looks like it builds native code.
+Read-only; fixed argv only.
+"""
+
+from __future__ import annotations
+
+import shutil
+import sys
+from collections.abc import Callable
+from pathlib import Path
+
+from devready.checks.extras import _run
+from devready.models import Result, Status
+
+NATIVE_HINTS = ("binding.gyp", "setup.py", "Gemfile", "Cargo.toml")
+BLOCKING_POLICIES = {"Restricted", "AllSigned"}
+KNOWN_POLICIES = BLOCKING_POLICIES | {"RemoteSigned", "Unrestricted", "Bypass", "Undefined"}
+
+
+def _long_paths_enabled() -> bool | None:
+    try:
+        import winreg
+
+        with winreg.OpenKey(
+            winreg.HKEY_LOCAL_MACHINE, r"SYSTEM\CurrentControlSet\Control\FileSystem"
+        ) as key:
+            return bool(winreg.QueryValueEx(key, "LongPathsEnabled")[0])
+    except (ImportError, OSError):
+        return None
+
+
+def _windows(root: Path, run: Callable, which: Callable, long_paths: Callable) -> list[Result]:
+    out: list[Result] = []
+    if (root / "package.json").is_file():
+        if long_paths() is False:
+            out.append(
+                Result(
+                    "platform.long_paths",
+                    "Long paths",
+                    Status.WARN,
+                    "Windows long path support is off; deep node_modules trees can fail",
+                    "Enable LongPathsEnabled (administrator) and git's core.longpaths.",
+                )
+            )
+        ps = which("powershell")
+        p = (
+            run([ps, "-NoProfile", "-NonInteractive", "-Command", "Get-ExecutionPolicy"])
+            if ps
+            else None
+        )
+        policy = p.stdout.strip() if p is not None and p.returncode == 0 else ""
+        if policy in BLOCKING_POLICIES:
+            out.append(
+                Result(
+                    "platform.exec_policy",
+                    "PowerShell policy",
+                    Status.WARN,
+                    f"PowerShell policy is {policy}; npm/pnpm .ps1 scripts will be blocked",
+                    "Use cmd, or allow local scripts for your user: "
+                    "Set-ExecutionPolicy -Scope CurrentUser RemoteSigned",
+                )
+            )
+    git = which("git")
+    if git and (root / ".git").exists() and not (root / ".gitattributes").is_file():
+        p = run([git, "-C", str(root), "config", "--get", "core.autocrlf"])
+        if p is not None and not p.stdout.strip():
+            out.append(
+                Result(
+                    "platform.autocrlf",
+                    "Line endings",
+                    Status.WARN,
+                    "core.autocrlf is unset and the repo has no .gitattributes",
+                    "Add a .gitattributes with line-ending rules, or set core.autocrlf.",
+                )
+            )
+    return out
+
+
+def _build_tools(root: Path, plat: str, run: Callable, which: Callable) -> list[Result]:
+    if not any((root / n).is_file() for n in NATIVE_HINTS):
+        return []
+    cid, title = "platform.build_tools", "Build tools"
+    if plat == "darwin":
+        xs = which("xcode-select")
+        p = run([xs, "-p"]) if xs else None
+        ok = p is not None and p.returncode == 0
+        fix = "Install the Xcode Command Line Tools: xcode-select --install"
+    else:
+        ok = any(which(c) for c in ("cc", "gcc", "clang")) and bool(which("make"))
+        fix = "Install a C compiler and make (for example your distro's build-essential)."
+    if ok:
+        return [Result(cid, title, Status.PASS, "compiler toolchain found")]
+    return [Result(cid, title, Status.WARN, "no compiler toolchain found for native builds", fix)]
+
+
+def check_platform(
+    root: Path,
+    plat: str = sys.platform,
+    run: Callable = _run,
+    which: Callable = shutil.which,
+    long_paths: Callable = _long_paths_enabled,
+) -> list[Result]:
+    if plat == "win32":
+        return _windows(root, run, which, long_paths)
+    return _build_tools(root, plat, run, which)

devready/checks/project.py

@@ -11,7 +11,7 @@ import re
 from pathlib import Path
 
 from devready.models import Result, Status
-from devready.versions import SAFE_SPEC, Version, parse_version, satisfies
+from devready.versions import Version, parse_version, satisfies
 
 MAX_BYTES = 1_000_000
 
@@ -25,7 +25,8 @@ def _read(path: Path) -> str | None:
 def _compare(
     check_id: str, title: str, source: str, spec: str, installed: Version | None, miss: Status
 ) -> Result:
-    shown = spec if SAFE_SPEC.match(spec) else "(unrecognized)"
+    # Echo only specs the matcher fully parses: plain words can pass SAFE_SPEC but are not versions.
+    shown = spec if satisfies((0, 0, 0), spec) is not None else "(unrecognized)"
     if installed is None:
         return Result(check_id, title, Status.SKIP, f"{source} wants {shown}; tool not found")
     ok = satisfies(installed, spec)

devready/cli.py

@@ -16,7 +16,10 @@ EXIT_OK, EXIT_FAILED, EXIT_USAGE, EXIT_INTERNAL = 0, 1, 2, 3
 
 def _text(results: list[Result]) -> str:
     lines = ["DevReady - Environment Check", ""]
-    lines += [f"[{r.status.value.upper():<5}] {r.title:<12} {r.summary}" for r in results]
+    for r in results:
+        lines.append(f"[{r.status.value.upper():<5}] {r.title:<12} {r.summary}")
+        if r.status is not Status.PASS and r.suggestion:
+            lines.append(f"    {r.suggestion}")
     lines += ["", "No changes were made to your system."]
     return "\n".join(lines)
 

devready/explain.py

@@ -47,4 +47,8 @@ EXPLANATIONS = {
     "project.node.config": "require.node in .devready.json is a hard requirement (fails when unmet).",
     "project.python.config": "require.python in .devready.json is a hard requirement (fails when unmet).",
     "project.env.required": "Variable NAMES listed under env in .devready.json must be set in the environment. Values are never read.",
+    "platform.long_paths": "Windows only, when package.json exists. Without LongPathsEnabled, deeply nested node_modules paths can exceed 260 characters and installs fail.",
+    "platform.exec_policy": "Windows only, when package.json exists. A Restricted or AllSigned PowerShell policy blocks npm.ps1 ('running scripts is disabled'). Use cmd or relax the policy for your user.",
+    "platform.autocrlf": "Windows only, in a git repo without .gitattributes. Unset core.autocrlf can flip line endings between Windows and Linux/macOS contributors.",
+    "platform.build_tools": "macOS/Linux, when the project has binding.gyp, setup.py, Gemfile or Cargo.toml. Native dependencies need a compiler (Xcode CLT on macOS, cc/gcc/clang and make on Linux).",
 }

devready/runner.py

@@ -6,6 +6,7 @@ from pathlib import Path
 from devready.checks.config import check_config, load_config
 from devready.checks.extras import check_disk, check_docker, check_git_identity
 from devready.checks.health import check_health
+from devready.checks.platform_checks import check_platform
 from devready.checks.project import check_project
 from devready.checks.python_check import check_python
 from devready.checks.runtimes import check_runtimes
@@ -27,7 +28,7 @@ def run_checks(root: Path) -> list[Result]:
     results += check_git_identity()
     results += check_project(root, versions["node"], platform.python_version())
     results += check_runtimes(root) + check_health(root)
-    results += check_docker(root) + check_disk(root)
+    results += check_docker(root) + check_platform(root) + check_disk(root)
     results += (
         [cfg_error] if cfg_error else check_config(cfg, versions["node"], platform.python_version())
     )

{devready_cli-0.2.0.dist-info → devready_cli-1.0.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: devready-cli
-Version: 0.2.0
+Version: 1.0.0
 Summary: A local-first, read-only CLI that checks a project's environment requirements against what is installed.
 Project-URL: Homepage, https://devready-ten.vercel.app/
 Project-URL: Repository, https://github.com/Evalogical-Inc/devReady
@@ -9,7 +9,7 @@ Author: Evalogical Inc
 License-Expression: MIT
 License-File: LICENSE
 Keywords: ai-agents,claude-code,cli,codex,developer-tools,doctor,environment,mcp,nvmrc,onboarding,preflight
-Classifier: Development Status :: 3 - Alpha
+Classifier: Development Status :: 5 - Production/Stable
 Classifier: Environment :: Console
 Classifier: Intended Audience :: Developers
 Classifier: Operating System :: OS Independent
@@ -37,7 +37,7 @@ Built for humans, CI, and AI coding agents (Claude Code, Codex, any MCP client).
 [![License: MIT](https://img.shields.io/badge/license-MIT-green.svg)](LICENSE)
 ![Python 3.10+](https://img.shields.io/badge/python-3.10%2B-blue)
 ![Dependencies: 0](https://img.shields.io/badge/dependencies-0-brightgreen)
-![Status: alpha](https://img.shields.io/badge/status-alpha-orange)
+![Status: stable](https://img.shields.io/badge/status-stable-green)
 
 </div>
 
@@ -193,9 +193,9 @@ args = ["--from", "devready-cli", "devready", "mcp"]
 - Environment variable values are never read into output. Nothing leaves your machine.
 - A passing report does **not** guarantee your project builds.
 
-See [SECURITY.md](SECURITY.md) to report a vulnerability.
+See [docs/security.md](docs/security.md) for the model, [docs/versioning.md](docs/versioning.md) for what stays stable, [docs/checks.md](docs/checks.md) for every check, and [SECURITY.md](SECURITY.md) to report a vulnerability.
 
-## Limitations (alpha)
+## Limitations
 
 - Checks today: Python, Git (+ identity set), Node.js, npm, project pins (`.nvmrc`, `.node-version`, `.python-version`, `.tool-versions`, `package.json` engines, `pyproject.toml` requires-python), `.env.example` vs `.env` key names, Docker CLI + daemon (only when the project has a Dockerfile/compose file), free disk space, and (only when the project declares them) Go, Ruby, Java, Rust, .NET, pnpm, Yarn and Bun pins, `.env` not git-ignored, `node_modules` vs lockfile, and declared ports already in use.
 - The version-range matcher covers common npm/PEP 440 syntax; pre-releases and exotic ranges report `skip` rather than guess.

{devready_cli-0.2.0.dist-info → devready_cli-1.0.0.dist-info}/RECORD

@@ -1,23 +1,24 @@
-devready/__init__.py,sha256=Zn1KFblwuFHiDRdRAiRnDBRkbPttWh44jKa5zG2ov0E,22
+devready/__init__.py,sha256=J-j-u0itpEFT6irdmWmixQqYMadNl1X91TxUmoiLHMI,22
 devready/__main__.py,sha256=c-4qpm2SKZs1nENGzSnPnChNTo8iMwjY0XaPyAApn4I,60
 devready/baseline.py,sha256=pfVzZ695bLEiSWKUBK0PNDp1S2UWTWj9lfUCDAsVS4g,1524
-devready/cli.py,sha256=RPijit2MT_ouZgD2TOUu1x-6YJevRIkh_a1wTWbMeuY,4619
-devready/explain.py,sha256=nYzzwtZGpn-FQQR8_KxC61_FLf7jCuQEv4iX-Fvqqr0,5140
+devready/cli.py,sha256=oetC_jJlXk4SlyB_oKqi5XYwDouFBjeT5Ya9vUmSfXc,4736
+devready/explain.py,sha256=zVRUNzqtVdO-EcC6rUCLPuwswbMlo59xzncCBiSvi1M,5889
 devready/formats.py,sha256=akN62ouKLeZQB6POcXNzINYKHwpUd4im0n2-9rtB8eE,3129
 devready/mcp_server.py,sha256=zVm89kZL_-pZwTSWkt6rxKonytNklUSa0RCQkX0lzFk,3177
 devready/models.py,sha256=KyGp3ie2LVQmuSfzLV8tbEH_hJyU5-Vi11d0JcQPAuE,646
-devready/runner.py,sha256=MVQh-dlsXnihWSbvbF4XKuFxgIyoywtL-9I-y0XrPpc,1456
+devready/runner.py,sha256=yjd7cdH0G-ksUD9viJ6coEB0iug7CazqWBQPlIW2lLU,1538
 devready/versions.py,sha256=dXKIl1-qvcfadRNaCURMoftwx7YtadDZ-YfUp-85XZc,2112
 devready/checks/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 devready/checks/config.py,sha256=SGyIot_QXmZtPLIybtxnyJEFL2aV1NemSqX_fXbFI6A,3471
 devready/checks/extras.py,sha256=pDJbFaAwjkLc92tcFagOmj-5c_vMx32_MtYa_DBfCz8,3428
 devready/checks/health.py,sha256=woaaUL2TJ_biRuiStXqJtnvPua_y69bW2quNPlwd7tQ,4235
-devready/checks/project.py,sha256=UnnjuZmG2aXXBAY45wTEP-bj4CWODMv3DPfEi1V_QDE,5983
+devready/checks/platform_checks.py,sha256=_ayTrJalFf4k5As0jq-t8GDh4IOMmgZJJdhKU4rIujQ,4113
+devready/checks/project.py,sha256=JTeSmkuz4Z7Jy5aQnP4o4TcdhQYRZfGaGhj6f0NslXw,6090
 devready/checks/python_check.py,sha256=uQCd-N0LEwt9R5gwZm5mlYiPMST1JXVDNQOdZ5xpako,328
 devready/checks/runtimes.py,sha256=OiC5LEhmfkiMseP2PbQS6Dc6TC2JhYNICU6LmdFFvqk,4446
 devready/checks/tools.py,sha256=AiL9TdIREmY7tEkkpt62DELKuJ2lhu3XcA2yGak9QkA,1616
-devready_cli-0.2.0.dist-info/METADATA,sha256=b76wbK0qZnoG8aNy66wxg8QmFDPENvL3GhzAwa2-RMQ,10533
-devready_cli-0.2.0.dist-info/WHEEL,sha256=W3fkpkm7-wf9vBI5Z-7s0eWkeM-spu78I8Neb98DeEg,87
-devready_cli-0.2.0.dist-info/entry_points.txt,sha256=7oAecSWtsIt7qLOP8PipOeDqhXCkEJat0oxhD4T1RpY,47
-devready_cli-0.2.0.dist-info/licenses/LICENSE,sha256=S_AQsEw289FIsOgT-OPWL5JZeV8nn5kicwEq0r9qu7s,1071
-devready_cli-0.2.0.dist-info/RECORD,,
+devready_cli-1.0.0.dist-info/METADATA,sha256=Bl4J-zxCaKppIWKFH-iFOxw0WNCOxXMYM_LgYuUhJVk,10708
+devready_cli-1.0.0.dist-info/WHEEL,sha256=W3fkpkm7-wf9vBI5Z-7s0eWkeM-spu78I8Neb98DeEg,87
+devready_cli-1.0.0.dist-info/entry_points.txt,sha256=7oAecSWtsIt7qLOP8PipOeDqhXCkEJat0oxhD4T1RpY,47
+devready_cli-1.0.0.dist-info/licenses/LICENSE,sha256=S_AQsEw289FIsOgT-OPWL5JZeV8nn5kicwEq0r9qu7s,1071
+devready_cli-1.0.0.dist-info/RECORD,,