CQ001: RuffCheck

Overview

Property Value
ID CQ001
Name RuffCheck
Group code-quality
Severity WARNING

Description

Runs ruff check on the package and verifies no linting issues are found.

Ruff is an extremely fast Python linter that can catch:

  • Syntax errors
  • Style violations
  • Bug-prone patterns
  • Security issues

What it checks

The check runs ruff check . in the package directory and:

  • PASSED: Ruff exits with code 0 (no issues)
  • FAILED: Ruff finds issues (reports count)
  • NOT_APPLICABLE: Ruff is not installed

How to fix

Install ruff

pip install ruff
# or
uv add --dev ruff

Run ruff to see issues

ruff check .

Auto-fix issues

ruff check --fix .

Configure ruff

Add to pyproject.toml:

[tool.ruff]
line-length = 100
target-version = "py311"

[tool.ruff.lint]
select = ["E", "F", "I", "UP", "B", "SIM"]
ignore = ["E501"]  # Line too long

Configuration

Skip this check

[tool.pycmdcheck]
skip = ["CQ001"]

CLI

pycmdcheck --skip CQ001