Skip to main content

A unified CLI tool for code formatting, linting, and quality assurance

Project description

Lintro

Lintro Logo

A comprehensive CLI tool that unifies various code formatting, linting, and quality assurance tools under a single command-line interface.

Tests CI Docker Coverage

Release PyPI Python License

CodeQL OpenSSF Scorecard OpenSSF Best Practices SBOM SBOM Status

๐Ÿš€ Quick Start

pip install lintro          # Install
lintro check .              # Find issues
lintro format .             # Fix issues
lintro check --output-format grid   # Beautiful output

โœจ Why Lintro?

  • ๐ŸŽฏ Unified Interface - One command for all your linting and formatting tools
  • ๐Ÿ“Š Consistent Output - Beautiful, standardized output formats across all tools
  • ๐Ÿ”ง Auto-fixing - Automatically fix issues where possible
  • ๐Ÿณ Docker Ready - Run in isolated containers for consistent environments
  • ๐Ÿ“ˆ Rich Reporting - Multiple formats: grid, JSON, HTML, CSV, Markdown
  • โšก Fast - Optimized parallel execution

๐Ÿ”Œ Works With Your Existing Configs

Lintro respects your native tool configurations. If you have a .prettierrc, pyproject.toml [tool.ruff], or .yamllint, Lintro uses them automatically - no migration required.

  • Native configs are detected - Your existing .prettierrc, .eslintrc, etc. work as-is
  • Enforce settings override consistently - Set line_length: 88 once, applied everywhere
  • Fallback defaults when needed - Tools without native configs use sensible defaults

See the Configuration Guide for details on the 4-tier config system.

๐Ÿ› ๏ธ Supported Tools

Tool Language Auto-fix
Ruff ๐Ÿ Python โœ…
Black ๐Ÿ Python โœ…
Mypy ๐Ÿ Python -
Bandit ๐Ÿ Python -
Semgrep ๐Ÿ”’ Multi-language -
Gitleaks ๐Ÿ” Secret Detection -
Prettier ๐ŸŸจ JS/TS ยท ๐Ÿงพ JSON โœ…
Biome ๐ŸŸจ JS/TS ยท ๐Ÿงพ JSON/CSS โœ…
Yamllint ๐Ÿงพ YAML -
Hadolint ๐Ÿณ Dockerfile -
Actionlint โš™๏ธ GitHub Actions -
ShellCheck ๐Ÿš Shell Scripts -
shfmt ๐Ÿš Shell Scripts โœ…
SQLFluff ๐Ÿ—ƒ๏ธ SQL โœ…
Taplo ๐Ÿงพ TOML โœ…
Markdownlint ๐Ÿ“ Markdown -
Clippy ๐Ÿฆ€ Rust โœ…
Darglint ๐Ÿ Python -

๐Ÿ“‹ Requirements

Python Version

Python 3.11+ is required. Lintro uses modern Python features not available in older versions.

Bundled Tools

These Python tools are automatically installed with Lintro:

  • Ruff - Fast Python linter and formatter
  • Black - Python code formatter
  • Bandit - Python security linter
  • Mypy - Python static type checker
  • Yamllint - YAML linter
  • Darglint - Python docstring linter

Optional External Tools

For full functionality, install these additional tools:

  • Prettier - npm install -g prettier
  • Markdownlint-cli2 - npm install -g markdownlint-cli2
  • Hadolint - GitHub Releases
  • Actionlint - GitHub Releases
  • Semgrep - pipx install semgrep, pip install semgrep, or brew install semgrep
  • Gitleaks - brew install gitleaks or GitHub Releases
  • ShellCheck - brew install shellcheck or GitHub Releases
  • shfmt - brew install shfmt or GitHub Releases
  • SQLFluff - pip install sqlfluff
  • Taplo - brew install taplo or GitHub Releases

Check all tool versions with: lintro list-tools

๐Ÿ“ฆ Installation

# PyPI (recommended)
pip install lintro

# Homebrew (macOS binary)
brew tap TurboCoder13/tap && brew install lintro-bin

# Docker (includes all tools)
docker run --rm -v $(pwd):/code ghcr.io/turbocoder13/py-lintro:latest check

See Getting Started for detailed installation options.

๐Ÿ’ป Usage

# Check all files
lintro check .

# Auto-fix issues
lintro format .

# Grid output with grouping
lintro check --output-format grid --group-by file

# Run specific tools
lintro check --tools ruff,prettier,mypy

# Exclude directories
lintro check --exclude "node_modules,dist,venv"

# List available tools
lintro list-tools

๐Ÿณ Docker

# Run from GHCR
docker run --rm -v $(pwd):/code ghcr.io/turbocoder13/py-lintro:latest check

# With formatting
docker run --rm -v $(pwd):/code ghcr.io/turbocoder13/py-lintro:latest check --output-format grid

๐Ÿ“š Documentation

Guide Description
Getting Started Installation, first steps, requirements
Configuration Tool configuration, options, presets
Docker Usage Containerized development
GitHub Integration CI/CD setup, workflows
Contributing Development guide, adding tools
Troubleshooting Common issues and solutions

Advanced: Tool Analysis | Architecture | Security

๐Ÿ”จ Development

# Clone and install
git clone https://github.com/TurboCoder13/py-lintro.git
cd py-lintro
uv sync --dev

# Run tests
./scripts/local/run-tests.sh

# Run lintro on itself
./scripts/local/local-lintro.sh check --output-format grid

๐Ÿค Community

๐Ÿ“„ License

MIT License - see LICENSE for details.

Project details


Release history Release notifications | RSS feed

Download files

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

Source Distribution

lintro-0.37.14.tar.gz (1.7 MB view details)

Uploaded Source

Built Distribution

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

lintro-0.37.14-py3-none-any.whl (390.2 kB view details)

Uploaded Python 3

File details

Details for the file lintro-0.37.14.tar.gz.

File metadata

  • Download URL: lintro-0.37.14.tar.gz
  • Upload date:
  • Size: 1.7 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for lintro-0.37.14.tar.gz
Algorithm Hash digest
SHA256 703b8473c93448b37a72162dbc43c09a07fa4a31d64a70b5f15d953cc5a412a8
MD5 80c0ee4819bfe776245bd92ebef6e7eb
BLAKE2b-256 3fd4a80e3abdebf8617f61c208009eed4705047e96b1e7cb15713b62e7ec6dd8

See more details on using hashes here.

Provenance

The following attestation bundles were made for lintro-0.37.14.tar.gz:

Publisher: publish-pypi-on-tag.yml on TurboCoder13/py-lintro

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

File details

Details for the file lintro-0.37.14-py3-none-any.whl.

File metadata

  • Download URL: lintro-0.37.14-py3-none-any.whl
  • Upload date:
  • Size: 390.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for lintro-0.37.14-py3-none-any.whl
Algorithm Hash digest
SHA256 3e84c1b5e81c3233208afe3b4ed0f723d50fd144174a85930d09f6fd1a9b0e95
MD5 785d1ad4b25f08764fe0caa3f460a595
BLAKE2b-256 aee667813b5a0bd1d63aaf5f31b7addc9ca1421c5dbd037e7426efaec99ce7c3

See more details on using hashes here.

Provenance

The following attestation bundles were made for lintro-0.37.14-py3-none-any.whl:

Publisher: publish-pypi-on-tag.yml on TurboCoder13/py-lintro

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