0dedc45e71
- Wire PythonCustomLinter into run_sanity as the pycustomlint check (imports directly from the customlinter package; MAX_WORKERS 4 -> 5) - Use BaseLinter.format_violations_report so every sanity linter (markdownlint, frontmatter_lint, pycustomlint) prints the same TARGET/DEFINITIONS/FILE/SUMMARY format; align summary line order in base.py with the fmlint and mdoctor reports - Remove dead backward-compat shims (src/mdoctor/fmlint.py, src/python_ruff/pycustomlint.py); nothing imported them - Hoist all 45 inline imports in src to module level per the python-tdd skill, fixing the one test mock that relied on the lazy import - Sync SPEC: 4.2/4.4 covers, new 4.9.3 Linter Report Format section, frontmatter version 0.27.9 -> 0.28.0 Generated by Mistral Vibe. Co-Authored-By: Mistral Vibe <vibe@mistral.ai>
158 lines
4.8 KiB
Python
158 lines
4.8 KiB
Python
from __future__ import annotations
|
|
|
|
import argparse
|
|
import json
|
|
import pathlib
|
|
import subprocess
|
|
|
|
import ruff
|
|
|
|
from fiona.logging_config import setup_logging
|
|
|
|
|
|
class PythonRuff:
|
|
|
|
def lint(self, target_path: str | pathlib.Path, fix: bool = False) -> list[dict]:
|
|
resolved_path = pathlib.Path(target_path).resolve()
|
|
ruff_bin = str(ruff.find_ruff_bin())
|
|
|
|
args = [ruff_bin, "check", str(resolved_path), "--output-format=json"]
|
|
if fix:
|
|
args.append("--fix")
|
|
|
|
result = subprocess.run(args, capture_output=True, text=True, check=False)
|
|
|
|
stdout = result.stdout.strip()
|
|
if stdout:
|
|
parsed = json.loads(stdout)
|
|
# Ensure return type is a list of dicts
|
|
return parsed if isinstance(parsed, list) else []
|
|
return []
|
|
|
|
def compress_violations(
|
|
self, violations: list[dict] | str, target_path: str | pathlib.Path
|
|
) -> dict[str, list[dict]]:
|
|
# Handle cases where raw JSON string was passed instead of parsed list
|
|
if isinstance(violations, str):
|
|
violations = json.loads(violations) if violations.strip() else []
|
|
|
|
target_dir = pathlib.Path(target_path).resolve()
|
|
if target_dir.is_file():
|
|
target_dir = target_dir.parent
|
|
|
|
compressed: dict[str, list[dict]] = {}
|
|
|
|
for violation in violations:
|
|
full_path = pathlib.Path(violation["filename"]).resolve()
|
|
try:
|
|
rel_path = str(full_path.relative_to(target_dir))
|
|
except ValueError:
|
|
rel_path = str(full_path)
|
|
|
|
if rel_path not in compressed:
|
|
compressed[rel_path] = []
|
|
|
|
compressed[rel_path].append(
|
|
{
|
|
"line": violation["location"]["row"],
|
|
"column": violation["location"]["column"],
|
|
"code": violation["code"],
|
|
"message": violation["message"],
|
|
}
|
|
)
|
|
|
|
return compressed
|
|
|
|
def format_violations(
|
|
self, violations: list[dict] | dict[str, list[dict]] | str, target_path: str | pathlib.Path
|
|
) -> str:
|
|
target_dir = pathlib.Path(target_path).resolve()
|
|
|
|
# Reuse compressed dict if already compressed, otherwise compress
|
|
if isinstance(violations, dict):
|
|
compressed = violations
|
|
else:
|
|
compressed = self.compress_violations(violations, target_path)
|
|
|
|
if not compressed:
|
|
return f"Ruff Violations\nTARGET: {target_dir}\nNo violations found."
|
|
|
|
# First pass: Collect rule definitions and calculate summary metrics
|
|
rule_definitions: dict[str, str] = {}
|
|
total_violations = 0
|
|
|
|
for file_violations in compressed.values():
|
|
total_violations += len(file_violations)
|
|
for v in file_violations:
|
|
if v["code"] not in rule_definitions:
|
|
rule_definitions[v["code"]] = v["message"]
|
|
|
|
file_count = len(compressed)
|
|
|
|
# Build output buffer
|
|
lines = [
|
|
"Ruff Violations",
|
|
f"TARGET: {target_dir}",
|
|
"",
|
|
"Definitions:",
|
|
]
|
|
|
|
for code in sorted(rule_definitions.keys()):
|
|
lines.append(f" - {code}: {rule_definitions[code]}")
|
|
|
|
lines.append("")
|
|
|
|
for rel_file, file_violations in compressed.items():
|
|
lines.append(f"- FILE: {rel_file}")
|
|
for v in file_violations:
|
|
lines.append(f" - {v['line']}:{v['column']} {v['code']}")
|
|
|
|
lines.append("")
|
|
lines.append("- SUMMARY:")
|
|
lines.append(f" - Total files with violations: {file_count}")
|
|
lines.append(f" - Total violations: {total_violations}")
|
|
|
|
return "\n".join(lines)
|
|
|
|
|
|
def check_ruff(self, target_dir: str):
|
|
raw_json = self.lint(target_dir)
|
|
compressed_violations = self.compress_violations(raw_json, target_dir)
|
|
return self.format_violations(compressed_violations, target_dir)
|
|
|
|
|
|
def main():
|
|
"""Command-line interface for the MDoctor tool."""
|
|
parser = argparse.ArgumentParser(
|
|
description="python-ruff description"
|
|
)
|
|
subparsers = parser.add_subparsers(dest="subcommand", help="Available subcommands")
|
|
|
|
# chklint subcommand
|
|
chklint_parser = subparsers.add_parser("chklint", help="")
|
|
chklint_parser.add_argument(
|
|
"directory",
|
|
nargs="?",
|
|
default=".",
|
|
help=""
|
|
)
|
|
|
|
args = parser.parse_args()
|
|
|
|
|
|
setup_logging()
|
|
|
|
pruff = PythonRuff()
|
|
|
|
if args.subcommand is None:
|
|
# Default to list with current directory
|
|
args.subcommand = "chklint"
|
|
args.directory = "."
|
|
|
|
if args.subcommand == "chklint":
|
|
violations = pruff.check_ruff(args.directory)
|
|
print(violations)
|
|
|
|
|
|
if __name__ == "__main__":
|
|
main() |