cpplint - static code checker for C++ - C++ 静态代码审查工具

cpplint - static code checker for C++ - C++ 静态代码审查工具

cpplint
https://github.com/cpplint/cpplint

Google C++ Style Guide
https://google.github.io/styleguide/cppguide.html

Google C++ 风格指南
https://zh-google-styleguide.readthedocs.io/en/latest/google-cpp-styleguide/

Cpplint is a command-line tool to check C/C++ files for style issues following Google’s C++ style guide.
Cpplint 是一个命令行工具，可按照 Google 的 C++ 样式指南检查 C/C++ 文件中的样式问题。

1. Installation

To install cpplint from PyPI, run:

$ pip install cpplint

Then run it with:

$ cpplint [OPTIONS] files

For full usage instructions, run:

$ cpplint --help

(base) yongqiang@yongqiang:~$ pip --version
pip 20.0.2 from /home/yongqiang/miniconda3/lib/python3.7/site-packages/pip (python 3.7)
(base) yongqiang@yongqiang:~$
(base) yongqiang@yongqiang:~$ pip install cpplint
Collecting cpplint
  Downloading cpplint-1.5.4-py3-none-any.whl (76 kB)
     |████████████████████████████████| 76 kB 201 kB/s
Installing collected packages: cpplint
Successfully installed cpplint-1.5.4
(base) yongqiang@yongqiang:~$
(base) yongqiang@yongqiang:~$ cpplint --version
Cpplint fork (https://github.com/cpplint/cpplint)
cpplint 1.5.4
Python 3.7.6 (default, Jan  8 2020, 19:59:22)
[GCC 7.3.0]
(base) yongqiang@yongqiang:~$
(base) yongqiang@yongqiang:~$ pip list | grep cpplint
cpplint                1.5.4
(base) yongqiang@yongqiang:~$

2. usage

2.1 cpplint main.cpp

#include 

int main() {
    std::cout << "Hello, World!" << std::endl;
    return 0;
}

(base) yongqiang@yongqiang:~/CLionProjects/yongqiang$ cpplint main.cpp
main.cpp:0:  No copyright message found.  You should have a line: "Copyright [year] "  [legal/copyright] [5]
Done processing main.cpp
Total errors found: 1
(base) yongqiang@yongqiang:~/CLionProjects/yongqiang$

/*
 * Copyright 2020 Yongqiang Cheng. All Rights Reserved.
 */

#include 

int main() {
    std::cout << "Hello, World!" << std::endl;
    return 0;
}

(base) yongqiang@yongqiang:~/CLionProjects/yongqiang$ cpplint main.cpp
Done processing main.cpp
(base) yongqiang@yongqiang:~/CLionProjects/yongqiang$

2.2 cpplint --linelength=120 main.cpp

每行允许的最长长度，默认是 80 字符。

--linelength=digits
This is the allowed line length for the project. The default value is 80 characters.

Examples: --linelength=120

(base) yongqiang@yongqiang:~/CLionProjects/yongqiang$ cpplint --linelength=120 main.cpp
Done processing main.cpp
(base) yongqiang@yongqiang:~/CLionProjects/yongqiang$

2.3 cpplint --linelength=120 --verbose=3 main.cpp

--verbose=#
Specify a number 0-5 to restrict errors to certain verbosity levels. Errors with lower verbosity levels have lower confidence and are more likely to be false positives.
指定数字 0-5，以将错误限制在某些详细程度上。详细程度较低的错误的置信度较低，更有可能是误报。

指定输出的错误级别。对于发现的每个问题，cpplint 都会给出 1，2，3，4，5 的置信度评分，分数越高就代表问题越肯定，可以通过 --verbose=# 选项控制输出哪些级别。

--verbose=3 置信度评分为 1、2 的将不会再输出。

个人建议不需要使用该参数。

3. cpplint --help

(base) yongqiang@yongqiang:~$ cpplint --help

Syntax: cpplint.py [--verbose=#] [--output=emacs|eclipse|vs7|junit|sed|gsed]
                   [--filter=-x,+y,...]
                   [--counting=total|toplevel|detailed] [--root=subdir]
                   [--repository=path]
                   [--linelength=digits] [--headers=x,y,...]
                   [--recursive]
                   [--exclude=path]
                   [--extensions=hpp,cpp,...]
                   [--includeorder=default|standardcfirst]
                   [--quiet]
                   [--version]
         [file] ...

  Style checker for C/C++ source files.
  This is a fork of the Google style checker with minor extensions.

  The style guidelines this tries to follow are those in
    https://google.github.io/styleguide/cppguide.html

  Every problem is given a confidence score from 1-5, with 5 meaning we are
  certain of the problem, and 1 meaning it could be a legitimate construct.
  This will miss some errors, and is not a substitute for a code review.

  To suppress false-positive errors of a certain category, add a
  'NOLINT(category)' comment to the line.  NOLINT or NOLINT(*)
  suppresses errors of all categories on that line.

  The files passed in will be linted; at least one file must be provided.
  Default linted extensions are ['cu', 'h', 'c++', 'hxx', 'cuh', 'cc', 'cxx', 'hpp', 'cpp', 'h++', 'hh', 'c'].
  Other file types will be ignored.
  Change the extensions with the --extensions flag.

  Flags:

    output=emacs|eclipse|vs7|junit|sed|gsed
      By default, the output is formatted to ease emacs parsing.  Visual Studio
      compatible output (vs7) may also be used.  Further support exists for
      eclipse (eclipse), and JUnit (junit). XML parsers such as those used
      in Jenkins and Bamboo may also be used.
      The sed format outputs sed commands that should fix some of the errors.
      Note that this requires gnu sed. If that is installed as gsed on your
      system (common e.g. on macOS with homebrew) you can use the gsed output
      format. Sed commands are written to stdout, not stderr, so you should be
      able to pipe output straight to a shell to run the fixes.

    verbose=#
      Specify a number 0-5 to restrict errors to certain verbosity levels.
      Errors with lower verbosity levels have lower confidence and are more
      likely to be false positives.

    quiet
      Don't print anything if no errors are found.

    filter=-x,+y,...
      Specify a comma-separated list of category-filters to apply: only
      error messages whose category names pass the filters will be printed.
      (Category names are printed with the message and look like
      "[whitespace/indent]".)  Filters are evaluated left to right.
      "-FOO" and "FOO" means "do not print categories that start with FOO".
      "+FOO" means "do print categories that start with FOO".

      Examples: --filter=-whitespace,+whitespace/braces
                --filter=whitespace,runtime/printf,+runtime/printf_format
                --filter=-,+build/include_what_you_use

      To see a list of all the categories used in cpplint, pass no arg:
         --filter=

    counting=total|toplevel|detailed
      The total number of errors found is always printed. If
      'toplevel' is provided, then the count of errors in each of
      the top-level categories like 'build' and 'whitespace' will
      also be printed. If 'detailed' is provided, then a count
      is provided for each category like 'build/class'.

    repository=path
      The top level directory of the repository, used to derive the header
      guard CPP variable. By default, this is determined by searching for a
      path that contains .git, .hg, or .svn. When this flag is specified, the
      given path is used instead. This option allows the header guard CPP
      variable to remain consistent even if members of a team have different
      repository root directories (such as when checking out a subdirectory
      with SVN). In addition, users of non-mainstream version control systems
      can use this flag to ensure readable header guard CPP variables.

      Examples:
        Assuming that Alice checks out ProjectName and Bob checks out
        ProjectName/trunk and trunk contains src/chrome/ui/browser.h, then
        with no --repository flag, the header guard CPP variable will be:

        Alice => TRUNK_SRC_CHROME_BROWSER_UI_BROWSER_H_
        Bob   => SRC_CHROME_BROWSER_UI_BROWSER_H_

        If Alice uses the --repository=trunk flag and Bob omits the flag or
        uses --repository=. then the header guard CPP variable will be:

        Alice => SRC_CHROME_BROWSER_UI_BROWSER_H_
        Bob   => SRC_CHROME_BROWSER_UI_BROWSER_H_

    root=subdir
      The root directory used for deriving header guard CPP variable.
      This directory is relative to the top level directory of the repository
      which by default is determined by searching for a directory that contains
      .git, .hg, or .svn but can also be controlled with the --repository flag.
      If the specified directory does not exist, this flag is ignored.

      Examples:
        Assuming that src is the top level directory of the repository (and
        cwd=top/src), the header guard CPP variables for
        src/chrome/browser/ui/browser.h are:

        No flag => CHROME_BROWSER_UI_BROWSER_H_
        --root=chrome => BROWSER_UI_BROWSER_H_
        --root=chrome/browser => UI_BROWSER_H_
        --root=.. => SRC_CHROME_BROWSER_UI_BROWSER_H_

    linelength=digits
      This is the allowed line length for the project. The default value is
      80 characters.

      Examples:
        --linelength=120

    recursive
      Search for files to lint recursively. Each directory given in the list
      of files to be linted is replaced by all files that descend from that
      directory. Files with extensions not in the valid extensions list are
      excluded.

    exclude=path
      Exclude the given path from the list of files to be linted. Relative
      paths are evaluated relative to the current directory and shell globbing
      is performed. This flag can be provided multiple times to exclude
      multiple files.

      Examples:
        --exclude=one.cc
        --exclude=src/*.cc
        --exclude=src/*.cc --exclude=test/*.cc

    extensions=extension,extension,...
      The allowed file extensions that cpplint will check

      Examples:
        --extensions=cu,h,c++,hxx,cuh,cc,cxx,hpp,cpp,h++,hh,c

    includeorder=default|standardcfirst
      For the build/include_order rule, the default is to blindly assume angle
      bracket includes with file extension are c-system-headers (default),
      even knowing this will have false classifications.
      The default is established at google.
      standardcfirst means to instead use an allow-list of known c headers and
      treat all others as separate group of "other system headers". The C headers
      included are those of the C-standard lib and closely related ones.

    headers=x,y,...
      The header extensions that cpplint will treat as .h in checks. Values are
      automatically added to --extensions list.
     (by default, only files with extensions {'h', 'hxx', 'cuh', 'hpp', 'h++', 'hh'} will be assumed to be headers)

      Examples:
        --headers=h,hxx,cuh,hpp,h++,hh
        --headers=hpp,hxx
        --headers=hpp

    cpplint.py supports per-directory configurations specified in CPPLINT.cfg
    files. CPPLINT.cfg file can contain a number of key=value pairs.
    Currently the following options are supported:

      set noparent
      filter=+filter1,-filter2,...
      exclude_files=regex
      linelength=80
      root=subdir
      headers=x,y,...

    "set noparent" option prevents cpplint from traversing directory tree
    upwards looking for more .cfg files in parent directories. This option
    is usually placed in the top-level project directory.

    The "filter" option is similar in function to --filter flag. It specifies
    message filters in addition to the |_DEFAULT_FILTERS| and those specified
    through --filter command-line flag.

    "exclude_files" allows to specify a regular expression to be matched against
    a file name. If the expression matches, the file is skipped and not run
    through the linter.

    "linelength" allows to specify the allowed line length for the project.

    The "root" option is similar in function to the --root flag (see example
    above). Paths are relative to the directory of the CPPLINT.cfg.

    The "headers" option is similar in function to the --headers flag
    (see example above).

    CPPLINT.cfg has an effect on files in the same directory and all
    sub-directories, unless overridden by a nested configuration file.

      Example file:
        filter=-build/include_order,+build/include_alpha
        exclude_files=.*\.cc

    The above example disables build/include_order warning and enables
    build/include_alpha as well as excludes all .cc from being
    processed by linter, in the current directory (where the .cfg
    file is located) and all sub-directories.
(base) yongqiang@yongqiang:~$