Skip to main content

Automated checker to ensure C++ files follow Google's style guide

Project description

cpplint - static code checker for C++

https://img.shields.io/pypi/v/cpplint.svg https://img.shields.io/pypi/pyversions/cpplint.svg https://img.shields.io/pypi/status/cpplint.svg https://img.shields.io/pypi/l/cpplint.svg https://img.shields.io/pypi/dd/cpplint.svg https://img.shields.io/pypi/dw/cpplint.svg https://img.shields.io/pypi/dm/cpplint.svg

Cpplint is a command-line tool to check C/C++ files for style issues following Google’s C++ style guide. Cpplint is developed and maintained by Google Inc. at google/styleguide, also see the wikipedia entry

While Google maintains cpplint, Google is not (very) responsive to issues and pull requests, this fork aims to be (somewhat) more open to add fixes to cpplint to enable fixes, when those fixes make cpplint usable in wider contexts. Also see discussion here https://github.com/google/styleguide/pull/528.

Installation

To install cpplint from PyPI, run:

$ pip install cpplint

Then run it with:

$ cpplint [OPTIONS] files

For full usage instructions, run:

$ cpplint --help

Changes

The modifications in this fork are minor fixes and cosmetic changes, such as:

  • python 3 compatibility

  • more default file extensions

  • customizable file extensions with the –extensions argument

  • continuous integration on github

  • support for recursive file discovery via the –recursive argument

  • support for excluding files via –exclude

  • JUnit XML output format

  • Overriding repository root auto-detection via –repository

  • Support #pragma once as an alternative to header include guards

  • … and a few more (most of which are open PRs on upstream)

Acknowledgements

Thanks to Google Inc. for open-sourcing their in-house tool. Thanks to maintainers of the fork

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

cpplint-1.6.1.tar.gz (364.5 kB view hashes)

Uploaded source

Built Distribution

cpplint-1.6.1-py3-none-any.whl (77.3 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page