coding-convention-reviewer 0.1.0__tar.gz

coding_convention_reviewer-0.1.0/.dockerignore

@@ -0,0 +1,12 @@
+.git/
+.venv/
+env/
+__pycache__/
+.pytest_cache/
+*.pyc
+*.pyo
+node_modules/
+.env
+.env.*
+seireitei/.next/
+seireitei/node_modules/

coding_convention_reviewer-0.1.0/.github/dependabot.yml

@@ -0,0 +1,14 @@
+version: 2
+updates:
+  - package-ecosystem: "pip"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+  - package-ecosystem: "npm"
+    directory: "/seireitei"
+    schedule:
+      interval: "weekly"
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"

coding_convention_reviewer-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,49 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  backend:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.12", "3.13"]
+
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install system deps
+        run: sudo apt-get update && sudo apt-get install -y gcc libffi-dev
+      - name: Install package
+        run: python -m pip install -e ".[test]"
+      - name: Run tests
+        run: python -m pytest -v --tb=short
+      - name: Run reviewer on itself
+        run: reviewer scan src/reviewer/ --json
+
+  frontend:
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        working-directory: seireitei
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: "22"
+          cache: "npm"
+          cache-dependency-path: seireitei/package-lock.json
+      - name: Install dependencies
+        run: npm ci
+      - name: Type check
+        run: npm run typecheck
+      - name: Lint
+        run: npm run lint
+      - name: Build
+        run: npm run build

coding_convention_reviewer-0.1.0/.github/workflows/pr-review.yml

@@ -0,0 +1,20 @@
+name: PR Review
+on: pull_request
+jobs:
+  review:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      - name: Install system deps
+        run: sudo apt-get update && sudo apt-get install -y gcc libffi-dev
+      - name: Install reviewer
+        run: python -m pip install -e ".[test]"
+      - name: Get changed files
+        run: git diff origin/${{ github.base_ref }}...HEAD --name-only > changed.txt
+      - name: Run reviewer
+        run: reviewer scan . --changed-files changed.txt --format github

coding_convention_reviewer-0.1.0/.github/workflows/publish.yml

@@ -0,0 +1,24 @@
+name: Publish to PyPI
+
+on:
+  push:
+    tags:
+      - "v*"
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      - name: Install build tools
+        run: pip install build twine
+      - name: Build package
+        run: python -m build
+      - name: Publish to PyPI
+        env:
+          TWINE_USERNAME: __token__
+          TWINE_PASSWORD: ${{ secrets.PYPI_API_TOKEN }}
+        run: twine upload dist/*

coding_convention_reviewer-0.1.0/.gitignore

@@ -0,0 +1,11 @@
+__pycache__/
+.pytest_cache/
+.ruff_cache/
+.mypy_cache/
+.venv/
+env/
+frontend/node_modules/
+dist/
+build/
+*.egg-info/
+*env

coding_convention_reviewer-0.1.0/.pre-commit-config.yaml

@@ -0,0 +1,5 @@
+repos:
+  - repo: https://github.com/yourorg/coding-convention-reviewer
+    rev: v0.1.0
+    hooks:
+      - id: reviewer-scan

coding_convention_reviewer-0.1.0/.pre-commit-hooks.yaml

@@ -0,0 +1,9 @@
+- id: reviewer-scan
+  name: Coding Convention Review
+  description: Run coding convention review on changed files
+  entry: reviewer scan --changed-files
+  language: python
+  types_or: [python, ts, tsx]
+  args: []
+  require_serial: false
+  pass_filenames: false

coding_convention_reviewer-0.1.0/.vscode/tasks.json

@@ -0,0 +1,107 @@
+{
+  "version": "2.0.0",
+  "tasks": [
+    {
+      "label": "Backend: API Server",
+      "type": "shell",
+      "command": "source env/Scripts/activate && python -m reviewer api --port 8766",
+      "group": "none",
+      "presentation": {
+        "panel": "dedicated",
+        "group": "backend",
+        "reveal": "always"
+      },
+      "problemMatcher": []
+    },
+    {
+      "label": "Frontend: Dev Server",
+      "type": "shell",
+      "command": "npm run dev",
+      "options": {
+        "cwd": "${workspaceFolder}/seireitei"
+      },
+      "group": "none",
+      "presentation": {
+        "panel": "dedicated",
+        "group": "frontend",
+        "reveal": "always"
+      },
+      "problemMatcher": []
+    },
+    {
+      "label": "Backend: Run Tests",
+      "type": "shell",
+      "command": "python -m pytest -v",
+      "group": {
+        "kind": "test",
+        "isDefault": true
+      },
+      "presentation": {
+        "panel": "dedicated",
+        "reveal": "always"
+      },
+      "problemMatcher": []
+    },
+    {
+      "label": "Frontend: Type Check",
+      "type": "shell",
+      "command": "npm run typecheck",
+      "options": {
+        "cwd": "${workspaceFolder}/seireitei"
+      },
+      "group": "none",
+      "presentation": {
+        "panel": "dedicated",
+        "group": "frontend",
+        "reveal": "always"
+      },
+      "problemMatcher": ["$tsc"]
+    },
+    {
+      "label": "Frontend: Lint",
+      "type": "shell",
+      "command": "npm run lint",
+      "options": {
+        "cwd": "${workspaceFolder}/seireitei"
+      },
+      "group": "none",
+      "presentation": {
+        "panel": "dedicated",
+        "group": "frontend",
+        "reveal": "always"
+      },
+      "problemMatcher": ["$eslint-stylish"]
+    },
+    {
+      "label": "Frontend: Build",
+      "type": "shell",
+      "command": "npm run build",
+      "options": {
+        "cwd": "${workspaceFolder}/seireitei"
+      },
+      "group": {
+        "kind": "build",
+        "isDefault": false
+      },
+      "presentation": {
+        "panel": "dedicated",
+        "reveal": "always"
+      },
+      "problemMatcher": []
+    },
+    {
+      "label": "Run All: Backend + Frontend",
+      "dependsOn": ["Backend: API Server", "Frontend: Dev Server"],
+      "dependsOrder": "parallel",
+      "group": {
+        "kind": "build",
+        "isDefault": true
+      },
+      "presentation": {
+        "panel": "dedicated",
+        "reveal": "always"
+      },
+      "problemMatcher": []
+    }
+  ]
+}

coding_convention_reviewer-0.1.0/CLAUDE.md

@@ -0,0 +1,107 @@
+# CLAUDE.md
+
+This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
+
+## Commands
+
+### Backend (Python)
+
+```bash
+# Install in editable mode (required before anything else)
+python -m pip install -e ".[test]"
+
+# Run all tests
+python -m pytest
+
+# Run a single test file
+python -m pytest tests/test_engine_and_plugins.py
+
+# CLI scan
+reviewer scan <path>
+reviewer scan --config reviewer.yaml
+reviewer scan --json
+reviewer scan --format github
+reviewer scan --changed-files changed.txt
+
+# Start API server
+reviewer api --port 8766
+```
+
+### Frontend (`seireitei/`)
+
+```bash
+cd seireitei
+npm install
+npm run dev          # http://localhost:3000
+npm run build
+npm run lint
+npm run typecheck
+npm run format
+```
+
+## Architecture
+
+This is a **deterministic, plugin-based code review engine** with a Python backend and a Next.js dashboard.
+
+### Backend: `src/reviewer/`
+
+The pipeline for every scan:
+
+```
+Config (YAML → Pydantic) → Scanner (glob patterns) → Parser (AST)
+  → Rule Engine (per-file) → Suppressions → Findings → Reporter
+```
+
+**Core packages** (`src/reviewer/core/`):
+- `config/` — YAML loading into `ReviewerConfig` / `ScanConfig` / `RuleConfig` Pydantic models
+- `scanner.py` — file discovery via include/exclude globs; also supports a changed-files list for CI
+- `parser/` — protocol-based adapters: `python_ast.py` (stdlib `ast`) and `typescript.py` (tree-sitter); both produce a unified `ParseResult`
+- `engine/` — `PluginRegistry` registers plugins; `runner.py` executes rules against ParseResults; `suppression.py` strips findings covered by `# reviewer: ignore <rule>` or `// reviewer: ignore-file`
+- `reporting/` — `console_report`, `json_report`, `github_report` formatters; `Finding` and `Severity` models
+
+**Plugins** (`src/reviewer/plugins/`):
+- `fastapi/` — 9 rules, operates on `.py` files via Python AST parser
+- `react/` — 7 rules, operates on `.ts`/`.tsx` files via tree-sitter parser
+- `defaults.py` — registers both plugins into the default `PluginRegistry`
+
+**HTTP API** (`src/reviewer/server/app.py`):
+- `POST /api/scan` — accepts `ScanRequest`, returns `ScanResponse` (findings + summary)
+- `GET /api/health`
+- CORS origin controlled by `ORIGIN` env var (default: `http://localhost:3000`)
+
+**CLI** (`src/reviewer/cli.py`): thin Typer wrapper; exit code 1 when findings exist.
+
+### Frontend: `seireitei/`
+
+Next.js 16 + React 19 + Tailwind CSS 4 + shadcn/ui.
+
+- `app/page.tsx` — single-page dashboard (client component); scan form, filters, stats, findings table
+- `hooks/use-scan.ts` — all scan state; calls `lib/api.ts`
+- `lib/api.ts` — POSTs to `${NEXT_PUBLIC_API_URL}/api/scan`; env var lives in `seireitei/.env`
+- `types/reviewer.ts` — shared `Finding`, `ScanResponse`, `ScanSummary`, `Severity` types
+- `components/dashboard/` — `ScanForm`, `FiltersBar`, `StatsGrid`, `StatusBanner`
+- `components/findings/` — `FindingsTable`, `SeverityBadge`
+
+The frontend expects the Python API running on `http://127.0.0.1:8766` (set in `seireitei/.env`).
+
+### Extending
+
+**New rule:** add a function returning `list[Finding]` in the plugin's rules file, register it as a `Rule(...)` in `plugin.py`.
+
+**New plugin:** create `src/reviewer/plugins/{name}/plugin.py` with a `create_plugin()` function, implement rules and any parser, register in `plugins/defaults.py`.
+
+## Environment Variables
+
+| Variable | Where used | Default |
+|---|---|---|
+| `NEXT_PUBLIC_API_URL` | `seireitei/.env` | `http://127.0.0.1:8766` |
+| `ORIGIN` | API server (CORS) | `http://localhost:3000` |
+
+## Suppressions
+
+```python
+print("x")  # reviewer: ignore no_print_statements   # inline
+```
+```typescript
+// reviewer: ignore-file   // top of file, suppresses all findings
+```

coding_convention_reviewer-0.1.0/Dockerfile

@@ -0,0 +1,34 @@
+# ── Stage 1: build ───────────────────────────────────────────────────────────
+FROM python:3.12-slim AS builder
+
+RUN apt-get update \
+    && apt-get install -y --no-install-recommends gcc libffi-dev \
+    && rm -rf /var/lib/apt/lists/*
+
+WORKDIR /app
+COPY pyproject.toml .
+COPY src/ src/
+
+RUN pip install --no-cache-dir -e ".[test]"
+
+# ── Stage 2: runtime ─────────────────────────────────────────────────────────
+FROM python:3.12-slim AS runtime
+
+RUN apt-get update \
+    && apt-get install -y --no-install-recommends curl \
+    && rm -rf /var/lib/apt/lists/*
+
+WORKDIR /app
+
+# Copy installed packages from builder (includes editable .pth reference to src/)
+COPY --from=builder /usr/local/lib/python3.12/site-packages /usr/local/lib/python3.12/site-packages
+COPY --from=builder /usr/local/bin/reviewer /usr/local/bin/reviewer
+# Editable install resolves imports from /app/src at runtime
+COPY --from=builder /app/src src/
+
+EXPOSE 8766
+
+HEALTHCHECK --interval=30s --timeout=5s --retries=3 \
+    CMD curl -f http://localhost:8766/api/health || exit 1
+
+CMD ["reviewer", "api", "--host", "0.0.0.0", "--port", "8766"]

coding_convention_reviewer-0.1.0/PKG-INFO

@@ -0,0 +1,22 @@
+Metadata-Version: 2.4
+Name: coding-convention-reviewer
+Version: 0.1.0
+Summary: Deterministic, plugin-based coding convention reviewer.
+Requires-Python: >=3.12
+Requires-Dist: cachetools<6,>=5.3
+Requires-Dist: fastapi<1,>=0.115
+Requires-Dist: prometheus-client<1,>=0.20
+Requires-Dist: pydantic<3,>=2.7
+Requires-Dist: python-dotenv<2,>=1.0
+Requires-Dist: pyyaml<7,>=6.0
+Requires-Dist: rich<15,>=13.7
+Requires-Dist: slowapi<1,>=0.1
+Requires-Dist: structlog<26,>=24.0
+Requires-Dist: tree-sitter-typescript<0.24,>=0.20
+Requires-Dist: tree-sitter<0.26,>=0.22
+Requires-Dist: typer<1,>=0.12
+Requires-Dist: uvicorn<1,>=0.30
+Requires-Dist: websockets<15,>=12.0
+Provides-Extra: test
+Requires-Dist: httpx<1,>=0.27; extra == 'test'
+Requires-Dist: pytest<9,>=8.2; extra == 'test'