codelaw 0.2.0__py3-none-win_amd64.whl

codelaw/__init__.py

@@ -0,0 +1,141 @@
+"""codelaw on PyPI: the Python API over the bundled binary (SR-PACKAGES decision 5).
+
+Each call runs the binary this wheel installed and returns its ``--format json``
+report unchanged, so the results are the binary's results (L6 decision 5).
+"""
+
+from __future__ import annotations
+
+import json
+import os
+import site
+import subprocess
+import sys
+import sysconfig
+from importlib import metadata
+from collections.abc import Sequence
+from typing import Any
+
+__all__ = ["binary_path", "check", "fix", "format", "rules_for"]
+
+
+def binary_path() -> str:
+    """The absolute path of the codelaw binary installed with this package."""
+    override = os.environ.get("CODELAW_BINARY")
+    if override:
+        return override
+    exe = "codelaw.exe" if sys.platform == "win32" else "codelaw"
+    # The file list this distribution installed: never another `codelaw` on the
+    # same bin folder (an npm -g shim, say).
+    try:
+        for f in metadata.files("codelaw") or ():
+            if f.name == exe and f.parent.name in ("bin", "Scripts", "scripts"):
+                path = str(f.locate())
+                if os.path.isfile(path):
+                    return path
+    except metadata.PackageNotFoundError:
+        pass
+    schemes = [sysconfig.get_default_scheme()]
+    if sys.platform == "win32":
+        schemes.append("nt_user")
+    elif sys.platform == "darwin" and sys._framework:  # type: ignore[attr-defined]
+        schemes.append("osx_framework_user")
+    else:
+        schemes.append("posix_user")
+    for scheme in schemes:
+        candidate = os.path.join(sysconfig.get_path("scripts", scheme), exe)
+        if os.path.isfile(candidate):
+            return candidate
+    # pip --target / an unusual layout: <prefix>/bin beside this package's site-packages.
+    here = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
+    for parent in (here, os.path.dirname(here), os.path.dirname(os.path.dirname(here))):
+        for sub in ("bin", "Scripts"):
+            candidate = os.path.join(parent, sub, exe)
+            if os.path.isfile(candidate):
+                return candidate
+    raise FileNotFoundError("codelaw: the binary this package installs is missing; reinstall codelaw")
+
+
+def environment() -> dict[str, str]:
+    """The binary's environment: this interpreter's site-packages, so it finds the
+    codelaw-rules-* packs installed beside this package (SR-RULE-PACKS decision 4)."""
+    paths = list(site.getsitepackages())
+    user = site.getusersitepackages()
+    if isinstance(user, str) and os.path.isdir(user):
+        paths.append(user)
+    env = dict(os.environ)
+    env["CODELAW_SITE_PACKAGES"] = os.pathsep.join(paths)
+    return env
+
+
+def _run(args: list[str]) -> dict[str, Any]:
+    r = subprocess.run([binary_path(), *args], capture_output=True, text=True, encoding="utf-8", env=environment())
+    # 0: clean, 1: diagnostics over the threshold; 2: the run could not start.
+    if r.returncode not in (0, 1):
+        raise RuntimeError(f"codelaw {args[0]} failed (exit {r.returncode}): {r.stderr.strip()}")
+    return json.loads(r.stdout)
+
+
+def _common(lang: Sequence[str] | None, rule: Sequence[str] | None, threads: int | None, no_cache: bool) -> list[str]:
+    a: list[str] = []
+    if lang:
+        a += ["--lang", ",".join(lang)]
+    if rule:
+        a += ["--rule", ",".join(rule)]
+    if threads is not None:
+        a += ["--threads", str(threads)]
+    if no_cache:
+        a.append("--no-cache")
+    return a
+
+
+def check(
+    paths: Sequence[str] = (),
+    *,
+    lang: Sequence[str] | None = None,
+    rule: Sequence[str] | None = None,
+    threads: int | None = None,
+    no_cache: bool = False,
+) -> dict[str, Any]:
+    """``codelaw check --format json``; returns the report."""
+    return _run(["check", "--format", "json", *_common(lang, rule, threads, no_cache), "--", *paths])
+
+
+def fix(
+    paths: Sequence[str] = (),
+    *,
+    unsafe: bool = False,
+    dry_run: bool = False,
+    lang: Sequence[str] | None = None,
+    rule: Sequence[str] | None = None,
+    threads: int | None = None,
+    no_cache: bool = False,
+) -> dict[str, Any]:
+    """``codelaw fix --format json``; returns the report."""
+    a = ["fix", "--format", "json", *_common(lang, rule, threads, no_cache)]
+    if unsafe:
+        a.append("--unsafe")
+    if dry_run:
+        a.append("--dry-run")
+    return _run([*a, "--", *paths])
+
+
+def format(
+    paths: Sequence[str] = (),
+    *,
+    check: bool = False,
+    lang: Sequence[str] | None = None,
+    rule: Sequence[str] | None = None,
+    threads: int | None = None,
+    no_cache: bool = False,
+) -> dict[str, Any]:
+    """``codelaw format --format json`` (``check``: write nothing); returns the report."""
+    a = ["format", "--format", "json", *_common(lang, rule, threads, no_cache)]
+    if check:
+        a.append("--check")
+    return _run([*a, "--", *paths])
+
+
+def rules_for(path: str) -> dict[str, Any]:
+    """``codelaw rules --for <path> --format json``; returns the rules that apply to the file."""
+    return _run(["rules", "--for", path, "--format", "json"])

codelaw/__main__.py

@@ -0,0 +1,20 @@
+"""``python -m codelaw``: run the binary with this interpreter's site-packages,
+so it finds the codelaw-rules-* packs installed beside it."""
+
+import os
+import subprocess
+import sys
+
+from codelaw import binary_path, environment
+
+
+def main() -> int:
+    bin_ = binary_path()
+    if sys.platform == "win32":
+        return subprocess.run([bin_, *sys.argv[1:]], env=environment()).returncode
+    os.execve(bin_, [bin_, *sys.argv[1:]], environment())
+    return 2  # unreachable
+
+
+if __name__ == "__main__":
+    sys.exit(main())

codelaw-0.2.0.dist-info/METADATA

@@ -0,0 +1,84 @@
+Metadata-Version: 2.4
+Name: codelaw
+Version: 0.2.0
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Rust
+Classifier: Topic :: Software Development :: Quality Assurance
+License-File: LICENSE
+Summary: A linter and formatter whose rules are Markdown files
+License-Expression: MIT
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
+Project-URL: Repository, https://github.com/arpitarya/codelaw
+
+# codelaw
+
+A linter and formatter whose rules are Markdown files — for JavaScript,
+TypeScript, Python, JSON, YAML, TOML, Markdown, CSS and HTML, alone or mixed.
+
+**One engine, two registries, identical output.** The same native binary ships
+as `codelaw` on npm and on PyPI; neither needs the other.
+
+## Install
+
+| your repo | engine | rules for its languages |
+|---|---|---|
+| Node | `npm i -D codelaw` | `npx codelaw init` adds the `@codelaw/rules-*` packs |
+| Python | `uv add --dev codelaw` or `pip install codelaw` | `codelaw init` adds the `codelaw-rules-*` packs |
+
+`codelaw` installed alone lints nothing until a rule pack is installed — it
+says so (`codelaw/no-rules`).
+
+**Rule packs** — each registry carries the packs its users install:
+
+<!-- docs-sync:registries -->
+
+| registry | named | packs |
+|---|---|---|
+| npm | `@codelaw/rules-<name>` | `js` · `ts` · `react` · `node` · `stencil` · `html` · `css` · `data` · `tanstack-query` · `redux-toolkit` |
+| PyPI | `codelaw-rules-<name>` | `js` · `react` · `html` · `css` · `python` · `data` |
+
+<!-- /docs-sync:registries -->
+
+## Use
+
+```bash
+codelaw check            # lint the project
+codelaw fix              # apply the safe fixes
+codelaw check --format json
+```
+
+**Programmatic API** — runs the bundled binary and returns its JSON report:
+
+```js
+import { check, fix, format, rulesFor } from "codelaw";
+const report = check(["src"]);
+const rules = rulesFor("src/app.ts");
+```
+
+```python
+import codelaw
+report = codelaw.check(["src"])
+rules = codelaw.rules_for("app/main.py")
+```
+
+| npm | Python | what it returns |
+|---|---|---|
+| `check(paths, options)` | `check(paths, …)` | `codelaw check --format json` |
+| `fix(paths, options)` | `fix(paths, …)` | `codelaw fix --format json`; `unsafe`, `dryRun` / `dry_run` |
+| `format(paths, options)` | `format(paths, …)` | `codelaw format --format json`; `check` writes nothing |
+| `rulesFor(path)` | `rules_for(path)` | the rules that apply to one file, as `codelaw rules --for` lists them |
+| `binaryPath()`, `platformKey()` | `binary_path()` | the bundled binary, and the platform key it was chosen by |
+
+## Platforms
+
+macOS arm64 and x64 · Linux x64 and arm64, glibc and musl · Windows x64 and
+arm64. Any other platform fails with an error naming these — codelaw never
+compiles from source at install time.
+
+## Licence
+
+MIT — <https://github.com/arpitarya/codelaw>
+

codelaw-0.2.0.dist-info/RECORD

@@ -0,0 +1,9 @@
+codelaw/__init__.py,sha256=Il5UHow86oQHj4gsDr3acyB_hDNrlit981j3yZ4H0os,5183
+codelaw/__main__.py,sha256=08N9wWTtc78DiYj5BibVK7K1RGFfIfvRiYz29wXbITM,545
+codelaw/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+codelaw-0.2.0.data/scripts/codelaw.exe,sha256=7U4eSRSnXz_7dL6g5Vt1_PLY6nWChgY-2NANHiltCQI,31650304
+codelaw-0.2.0.dist-info/METADATA,sha256=kdP506TJa_QZSPOj56FhJCuqacpZ451ZDvuLf2LS-FQ,3018
+codelaw-0.2.0.dist-info/WHEEL,sha256=8Aej0W0a6Cz6apA3IzJrTnxLRVLAt-w0Oh8SA3Con_c,94
+codelaw-0.2.0.dist-info/licenses/LICENSE,sha256=zTmq9OahL66ocAprU1NqLgC0pnoZX9h_cQ3HfgBt1Kw,1120
+codelaw-0.2.0.dist-info/sboms/codelaw-cli.cyclonedx.json,sha256=XQ9sH9c18hCXPuUrtB0Jech_Y2hHjMsNCojUZZqUYJc,416246
+codelaw-0.2.0.dist-info/RECORD,,

codelaw-0.2.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: maturin (1.15.0)
+Root-Is-Purelib: false
+Tag: py3-none-win_amd64

codelaw-0.2.0.dist-info/licenses/LICENSE

@@ -0,0 +1,23 @@
+MIT License
+
+Copyright (c) 2026 Arpit Arya
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+SPDX-License-Identifier: MIT