# cppstyle

**Repository Path**: hugh13245/cppstyle

## Basic Information

- **Project Name**: cppstyle
- **Description**: A style checker for C/C++ based on clang
- **Primary Language**: Python
- **License**: GPL-3.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2018-01-18
- **Last Updated**: 2024-06-20

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# cppstyle

A style checker for C/C++ based on clang Edit

## Usage

### Local

First, you need a proper version of libclang and it's python bindings.

- Arch: `yaourt -S python-clang`
- Ubuntu Xenial: `apt-get install python-pip python-clang-3.8 libclang-3.8-dev`

Then just install it using pip:

`pip install cppstyle`

Run it!

`cppstyle --config /path/to/.cppstyle -i /path/to/[YourCFile]`

### Docker

Run it!

`docker run -v /path/to/code:/code gfelbing/cppstyle cppstyle --config /code/.cppstyle -i /code/[YourCFile]`

## Configuration

cppstyle is configured using a yaml file. By default, it uses the .cppstyle in your current directory.

You can specify another path using the `--config` option.

For a full example, see `.cppstyle` in this repository.
Every configuration is optional, a missing configuration means no checks on it.