Skip to content
/ qlty Public
forked from qltysh/qlty

Multi-language code linter, auto-formatter, and security scanner

License

Notifications You must be signed in to change notification settings

modolabs/qlty

 
 

Repository files navigation

Qlty CLI

Qlty CLI is a multi-language code linter, auto-formatter, and security scanner.

Engineering teams use Qlty CLI for static analysis and auto-formatting of all of their code using a single tool with fast, consistent results.

As a Git-aware tool, Qlty CLI makes adopting linting into the development workflow easy by limiting results to only new issues.

Qlty CLI is implemented in Rust, supported by Qlty Software, free to use, and is published under a Fair Source license.

Features

  • 🐞 Linting (for every programming language)
  • 🖌️ Auto-formatting
  • 🚨 Security scanning (IaC, SAST, SCA, and more)
  • 📊 Complexity metrics and duplication
  • 💩 Maintainability smells

Installation

Qlty CLI is available for MacOS, Linux, and Windows.

Install on MacOS or Linux

curl https://qlty.sh | bash

Install on Windows

powershell -c "iwr https://qlty.sh | iex"

Usage

Setup Qlty within a Git repository:

cd my_repo/
qlty init

View a sample of lint issues:

qlty check --sample=5

Auto-format the codebase:

qlty fmt --all

Scan for code smells like duplication:

qlty smells --all

Review a summary of code quality metrics:

qlty metrics --all --max-depth=2 --sort complexity --limit 10

Configuration

Qlty CLI is configured using a .qlty/qlty.toml file in your Git repository. You can generate a default configuration with qlty init and then customize it.

Read our documentation about configuration for more information.

Development

Developing on Qlty CLI requires a working Rust toolchain.

cargo build
cargo test

Contributing

  1. Read the Guide to Contributing in CONTRIBUTING.md
  2. Fork the repository and
  3. Submit a pull request.

Contributions require agreeing to our Contributor License Agreement (CLA).

Support

License

Qlty CLI is licensed under the Functional Source License (FSL). More details are available in LICENSE.md.

Acknowledgments

We would like to thank all of the developers of code quality tooling like linters and meta-linters as well as everyone who has contributed to the field of open source static analysis. Qlty CLI stands on the shoulders of decades of this excellent work.

Development of Qlty CLI is sponsored by Qlty Software.

About

Multi-language code linter, auto-formatter, and security scanner

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Rust 92.9%
  • TypeScript 2.3%
  • Python 1.0%
  • Java 1.0%
  • Ruby 0.9%
  • JavaScript 0.5%
  • Other 1.4%