Metadata-Version: 2.1
Name: checkstyle_cli
Version: 0.2.3
Summary: "A command-line tool for checkstyle."
Home-page: https://github.com/junghoon-vans/checkstyle-cli
Author: junghoon-vans
Author-email: junghoon.ban@gmail.com
License: MIT
Classifier: Environment :: Console
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE

checkstyle-cli
===

[![PyPI version](https://img.shields.io/pypi/v/checkstyle-cli?style=flat-square)](https://pypi.org/project/checkstyle-cli/)
![python versions](https://img.shields.io/pypi/pyversions/checkstyle-cli?style=flat-square)

A command-line tool for checkstyle.

Installation
---

```bash
> pip install checkstyle-cli
```

Usage
---

```bash
> checkstyle -h
usage: checkstyle [-h] [-c CONFIG] [-v VERSION]
                  [files ...]

> checkstyle -c /sun_checks.xml -v 10.3.2 .
```

### Positional Arguments

- `files`
  - files to verify 

### Optional Arguments

- `-c`, `--config`
  - configuration XML file path
  - default: `/google_checks.xml`
    - `/sun_checks.xml` and `/google_checks.xml` are embedded options.
- `-v`, `--version`
  - version to run checkstyle
  - default: `10.3.2`

License
---

[MIT Licencse](https://github.com/junghoon-vans/checkstyle-cli/blob/main/LICENSE)
