CPPLINT.cfg

# This is a sample CPPLINT.cfg file.
# Lines starting with '#' are comments and are ignored.
# You can put this file in your project's root directory or in any subdirectory.
# cpplint will automatically find the closest CPPLINT.cfg file in the directory hierarchy.

# --- Global Settings ---

# The 'set noparent' option prevents cpplint from looking for configuration
# files in parent directories. This is useful for ensuring that only the
# current directory's configuration is used.
set noparent

# --- Check Control ---

# 'filter=-' is a powerful way to disable a specific check or a group of checks.
# You can add or subtract checks from the default set.
# The format is 'filter=-<category>'.

# Disables a specific check for a specific issue.
# This check prevents a common error with using `new` and `delete` in header files.
# filter=-build/class

# Disables a group of checks.
# For example, checks related to include order and style are often
# customized or disabled.
# filter=-readability/todo,-readability/casting,-readability/braces,-readability/namespace
# filter=-runtime/casting
# filter=-build/include_order

filter=-legal/copyright

filter=-readability/alt_tokens
filter=-build/c++11

# You can also enable checks that are disabled by default.
# The format is 'filter=+<category>'.
# This check is for specific formatting issues with forward declarations.
# filter=+readability/braces
filter=-readability/inheritance
filter=-build/header_guard
filter=-readability/nolint
# --- Line Length ---

# 'linelength' sets the maximum number of characters per line. The default is 80.
# You can increase this value if your project has a different style guide.
# A common alternative is 100 or 120.
linelength=100

# --- File Extensions ---

# 'extensions' specifies which file extensions cpplint should analyze.
# The default includes .h, .cc, .cpp, .cxx, etc.
# You can add or remove extensions as needed.
# For example, adding .cu for CUDA files or .tpp for template implementation files.
extensions=cpp,cc,cxx,hpp,tpp,cu

# --- Project-Specific Paths ---

# 'root' is used to define the root directory of your project.
# It helps in enforcing include path checks, such as forbidding `..` in includes.
root=src/
# filter=-src/bcrypt/
# exclude_files=tests/*

# You can define a list of ignored files or directories.
# The 'exclude_files' and 'exclude_dirs' options allow for this.
# This is useful for third-party libraries or generated code.
# exclude_dirs=third_party,generated_files
# exclude_files=test_*.cc,my_script.cpp

# Example of using a wildcard for excluding multiple files.
# exclude_files=third_party/*.cc,generated_code/*