Skip to main content

A command-line tool for checkstyle.

Project description

checkstyle-cli

pre-commit.ci status PyPI version python versions

A command-line tool for checkstyle.

Requirements

The minimum JRE version required depends on runtime of checkstyle.

checkstyle version JRE version
10.x >= 11
7.x, 8.x 9.x >= 8
6.x >= 6
5.x >= 5

Installation

cli

> pip install checkstyle-cli

pre-commit

Add this to your .pre-commit-config.yaml

repos:
  - repo: https://github.com/junghoon-vans/checkstyle-cli
    rev: v0.4.0 # Use the ref you want
    hooks:
    - id: checkstyle

Usage

> checkstyle [options] [files...]

# run on current path with default options
> checkstyle .

# run with custom options
> checkstyle -c custom_config.xml --runtime-version 10.3.2 ~/workspace/demo

Options

-c, --config

  • configuration XML file path
  • default: google
    • sun and google are embedded options.

-v, --version

  • show program's version number and exit

--runtime-version

  • set runtime version of checkstyle
  • default: 10.3.3

Caching

When you run a checkstyle command, it automatically fetches the required files and saves them in the following path:

  • Linux: ~/.cache/checkstyle
  • Mac OS X: ~/Library/Caches/checkstyle
  • Windows: %LocalAppData%\checkstyle\checkstyle\Cache

License

MIT License

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

checkstyle_cli-0.3.3.tar.gz (6.2 kB view hashes)

Uploaded Source

Built Distribution

checkstyle_cli-0.3.3-py3-none-any.whl (29.4 MB view hashes)

Uploaded Python 3

Supported by

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