Skip to main content

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

Project description

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 according to Google’s C++ style guide.

Cpplint used to be developed and maintained by Google Inc. at google/styleguide. Nowadays, Google is no longer maintaining the public version of cpplint, and pretty much everything in their repo’s PRs and issues about cpplint have gone unimplemented.

This fork aims to update cpplint to modern specifications, and be (somewhat) more open to adding fixes and features to make cpplint usable in wider contexts.

Installation

To install cpplint from PyPI, run:

$ pip install cpplint

Externally managed environments

If you get the “This environment is externally managed” error, try to search and install cpplint with your system’s package manager (e.g. apt, rpm, pacman…). If it doesn’t exist, you can either package cpplint for your distribution or repeat the steps above with the --break-system-packages flag.

Usage

$ cpplint [OPTIONS] files

For full usage instructions, run:

$ cpplint --help

Changes

  • 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 quite a bit more

Acknowledgements

Thanks to Google Inc. for open-sourcing their in-house tool.

Thanks to our contributors.

Maintainers

Former

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-2.0.0.tar.gz (372.8 kB view details)

Uploaded Source

Built Distribution

cpplint-2.0.0-py3-none-any.whl (78.3 kB view details)

Uploaded Python 3

File details

Details for the file cpplint-2.0.0.tar.gz.

File metadata

  • Download URL: cpplint-2.0.0.tar.gz
  • Upload date:
  • Size: 372.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.11.10

File hashes

Hashes for cpplint-2.0.0.tar.gz
Algorithm Hash digest
SHA256 330daf6bf9a9006b9161af6693661df8f8373d54b2ea6527cd515a8e61d41abb
MD5 a78027e55f0e405ef41c9e7ba3926a9f
BLAKE2b-256 e71d6965acf4f85495956ebdb80ab2cafd803e39ba866b8370618a120d72938b

See more details on using hashes here.

Provenance

File details

Details for the file cpplint-2.0.0-py3-none-any.whl.

File metadata

  • Download URL: cpplint-2.0.0-py3-none-any.whl
  • Upload date:
  • Size: 78.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.11.10

File hashes

Hashes for cpplint-2.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 f418e1d76a14b44e0757b39faa8bd47543e352ced697afd35a598a0114aec69f
MD5 63d9ad10e8e436901cc8c76fd626d9f6
BLAKE2b-256 d8e7287512c48685c7b8c3928071a667969447f93fbaa078827eb435a08ce35c

See more details on using hashes here.

Provenance

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