StarMirror/styleguide
1
0
Fork 0
mirror of https://github.com/google/styleguide.git synced 2024-03-22 13:11:43 +08:00
Code Issues Projects Releases Wiki Activity

Add support for hidden config file

Browse Source 
Add optional support for parsing config files named .cpplint.cfg.

Enables hidden config files for cpplint.

Updated documentation/comment to reflect the change.
This commit is contained in:
Sebastian Jegerås 2020-12-15 17:45:08 +01:00
parent d5b5104763
commit b4340c2129
1 changed files with 15 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
cpplint/cpplint.py vendored
View File

@ -153,8 +153,9 @@ Syntax: cpplint.py [--verbose=#] [--output=vs7] [--filter=-x,+y,...]
--headers=hpp,hxx --headers=hpp,hxx
--headers=hpp --headers=hpp
cpplint.py supports per-directory configurations specified in CPPLINT.cfg cpplint.py supports per-directory configurations specified in a config file.
files. CPPLINT.cfg file can contain a number of key=value pairs. Named either "CPPLINT.cfg" or ".cpplint.cfg" if the first doesn't exist.
The config file can contain a number of key=value pairs.
Currently the following options are supported: Currently the following options are supported:
set noparent set noparent
@ -179,12 +180,13 @@ Syntax: cpplint.py [--verbose=#] [--output=vs7] [--filter=-x,+y,...]
"linelength" allows to specify the allowed line length for the project. "linelength" allows to specify the allowed line length for the project.
The "root" option is similar in function to the --root flag (see example The "root" option is similar in function to the --root flag (see example
above). Paths are relative to the directory of the CPPLINT.cfg. above).
Paths are relative to the directory of the config file.
The "headers" option is similar in function to the --headers flag The "headers" option is similar in function to the --headers flag
(see example above). (see example above).
CPPLINT.cfg has an effect on files in the same directory and all The config file has an effect on files in the same directory and all
sub-directories, unless overridden by a nested configuration file. sub-directories, unless overridden by a nested configuration file.
Example file: Example file:
@ -5961,7 +5963,11 @@ def ProcessConfigOverrides(filename):
if not base_name: if not base_name:
break # Reached the root directory. break # Reached the root directory.
# First try to read from "CPPLINT.cfg", if it doesn't exist
# try to read from ".cpplint.cfg"
cfg_file = os.path.join(abs_path, "CPPLINT.cfg") cfg_file = os.path.join(abs_path, "CPPLINT.cfg")
if not os.path.exists(cfg_file):
cfg_file = os.path.join(abs_path, ".cpplint.cfg")
abs_filename = abs_path abs_filename = abs_path
if not os.path.isfile(cfg_file): if not os.path.isfile(cfg_file):
continue continue
@ -5984,9 +5990,9 @@ def ProcessConfigOverrides(filename):
# When matching exclude_files pattern, use the base_name of # When matching exclude_files pattern, use the base_name of
# the current file name or the directory name we are processing. # the current file name or the directory name we are processing.
# For example, if we are checking for lint errors in /foo/bar/baz.cc # For example, if we are checking for lint errors in /foo/bar/baz.cc
# and we found the .cfg file at /foo/CPPLINT.cfg, then the config # and we found the .cfg file at /foo/*.cfg,
# file's "exclude_files" filter is meant to be checked against "bar" # then the config file's "exclude_files" filter is meant to be checked
# and not "baz" nor "bar/baz.cc". # against "bar" and not "baz" nor "bar/baz.cc".
if base_name: if base_name:
pattern = re.compile(val) pattern = re.compile(val)
if pattern.match(base_name): if pattern.match(base_name):
@ -6006,7 +6012,7 @@ def ProcessConfigOverrides(filename):
sys.stderr.write('Line length must be numeric.') sys.stderr.write('Line length must be numeric.')
elif name == 'root': elif name == 'root':
global _root global _root
# root directories are specified relative to CPPLINT.cfg dir. # root directories are specified relative to the dir of the config file.
_root = os.path.join(os.path.dirname(cfg_file), val) _root = os.path.join(os.path.dirname(cfg_file), val)
elif name == 'headers': elif name == 'headers':
ProcessHppHeadersOption(val) ProcessHppHeadersOption(val)