Skip to main content

CLI tool to assert that no linter config files exist

Project description

assert-no-linter-config-files

A command-line tool that asserts there are no configuration files (or embedded configuration sections) for common linters in your codebase. This is useful for enforcing that linter configurations are managed centrally rather than in individual repositories.

Installation

pip install assert-no-linter-config-files

Or install from source:

pip install -e .

Usage

assert-no-linter-config-files --linters LINTERS [OPTIONS] DIRECTORY [DIRECTORY ...]

Required Arguments

  • --linters LINTERS - Comma-separated linters to check: pylint,mypy,pytest,yamllint,jscpd
  • DIRECTORY - One or more directories to scan

Optional Arguments

  • --exclude PATTERN - Glob pattern to exclude paths (repeatable)
  • --quiet - Suppress output, exit code only
  • --count - Print finding count only
  • --json - Output findings as JSON
  • --fail-fast - Exit on first finding
  • --warn-only - Always exit 0, report only

Exit Codes

  • 0 - No linter configuration found (or --warn-only)
  • 1 - One or more linter configurations found
  • 2 - Usage/runtime error (invalid args, unreadable files)

Examples

Check for pylint and mypy configs in the current directory:

assert-no-linter-config-files --linters pylint,mypy .

Check specific directories:

assert-no-linter-config-files --linters pylint,mypy src/ tests/

Check all linters:

assert-no-linter-config-files --linters pylint,mypy,pytest,yamllint,jscpd .

Exclude vendor directories:

assert-no-linter-config-files --linters pylint,mypy \
  --exclude "*vendor*" --exclude "*node_modules*" .

Get JSON output for CI integration:

assert-no-linter-config-files --linters pylint --json . | jq .

Use in CI to enforce no local linter configs:

assert-no-linter-config-files --linters pylint,mypy . || exit 1

What It Checks

Dedicated Config Files

The tool flags the presence of these files anywhere in the scanned tree:

pylint: .pylintrc, pylintrc, .pylintrc.toml

pytest: pytest.ini

mypy: mypy.ini, .mypy.ini

yamllint: .yamllint, .yamllint.yml, .yamllint.yaml

jscpd: .jscpd.json, .jscpd.yml, .jscpd.yaml, .jscpd.toml, .jscpdrc, .jscpdrc.json, .jscpdrc.yml, .jscpdrc.yaml

Embedded Config Sections

The tool also checks shared config files for tool-specific sections:

pyproject.toml:

  • [tool.pylint] or [tool.pylint.*]
  • [tool.mypy]
  • [tool.pytest.ini_options]
  • [tool.jscpd]
  • [tool.yamllint]

setup.cfg:

  • [mypy]
  • [tool:pytest]
  • Any section containing "pylint"

tox.ini:

  • [pytest] or [tool:pytest]
  • [mypy]
  • Any section containing "pylint"

Output Format

When findings are detected, each is printed on a separate line:

<path>:<tool>:<reason>

Examples:

./pytest.ini:pytest:config file
./pyproject.toml:mypy:tool.mypy section
./setup.cfg:pylint:pylint.messages_control section

With --json:

[{"path": "./pytest.ini", "tool": "pytest", "reason": "config file"}]

CI Checks

The following checks run on every push and pull request:

  • yamllint - YAML linting for workflow files
  • markdownlint - Markdown linting
  • pylint - Python linting for source and test code
  • mypy - Static type checking for source code
  • jscpd - Duplicate code detection
  • pytest - Unit, integration, and E2E tests

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

File details

Details for the file assert_no_linter_config_files-20260103051409.tar.gz.

File metadata

File hashes

Hashes for assert_no_linter_config_files-20260103051409.tar.gz
Algorithm Hash digest
SHA256 831174b34d14cc109e11de54a49a00824960f62e1da5d38399d2c7ff6a2d53ba
MD5 33f5b1a3b7bb8a7547ca24d22c226ef3
BLAKE2b-256 7f28abfad29040948ca4790a3c1e420dd311f4af3d2096dd6890dd3a45361785

See more details on using hashes here.

Provenance

The following attestation bundles were made for assert_no_linter_config_files-20260103051409.tar.gz:

Publisher: release.yml on 10U-Labs-LLC/assert-no-linter-config-files

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file assert_no_linter_config_files-20260103051409-py3-none-any.whl.

File metadata

File hashes

Hashes for assert_no_linter_config_files-20260103051409-py3-none-any.whl
Algorithm Hash digest
SHA256 9fdd8088315e6a6568ea36bff6a5e694379e1e83739b39d51cc7158b5c4c4220
MD5 804d3c67096c41b2fab3a666b6b0936a
BLAKE2b-256 63771450f12a1a1df27238580e84530163d85e049f35ce0d86903780b6712bda

See more details on using hashes here.

Provenance

The following attestation bundles were made for assert_no_linter_config_files-20260103051409-py3-none-any.whl:

Publisher: release.yml on 10U-Labs-LLC/assert-no-linter-config-files

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page