-
Notifications
You must be signed in to change notification settings - Fork 579
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
CPPLintBear.py: Verify indentation and spaces #2105
Open
swapagarwal
wants to merge
1
commit into
coala:master
Choose a base branch
from
swapagarwal:checkstyle
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -3,6 +3,12 @@ | |
from coalib.settings.Setting import typed_list | ||
|
||
|
||
def check_invalid_configuration(indent_size, use_spaces): | ||
if indent_size != 2 or not use_spaces: | ||
raise ValueError('CPPLint only supports an indentation size of 2, ' | ||
'using only spaces.') | ||
|
||
|
||
@linter(executable='cpplint', | ||
use_stdout=False, | ||
use_stderr=True, | ||
|
@@ -26,12 +32,17 @@ class CPPLintBear: | |
def create_arguments(filename, file, config_file, | ||
max_line_length: int=79, | ||
cpplint_ignore: typed_list(str)=(), | ||
cpplint_include: typed_list(str)=()): | ||
cpplint_include: typed_list(str)=(), | ||
indent_size: int=2, | ||
use_spaces: bool=True): | ||
""" | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Is there any other way to check what kind of indent_size the user is using than relying on the user himself to give that information? Also does this fix it in case the indent_size is not matching or the user is using tabs? |
||
:param max_line_length: Maximum number of characters for a line. | ||
:param cpplint_ignore: List of checkers to ignore. | ||
:param cpplint_include: List of checkers to explicitly enable. | ||
:param indent_size: Only an indent size of 2 is permitted. | ||
:param use_spaces: Only the value `True` is permitted. | ||
""" | ||
check_invalid_configuration(indent_size, use_spaces) | ||
ignore = ','.join('-'+part.strip() for part in cpplint_ignore) | ||
include = ','.join('+'+part.strip() for part in cpplint_include) | ||
return ('--filter=' + ignore + ',' + include, | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do we want these as defaults or do we want the user to fail without any given argument. With a default value, users might think 4 just works. But I guess they should read the docs and then they'd see.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Case A: Fails without any given argument. Then maybe they set this argument to 4, which fails again. Then they read the docs and set it to 2.
Case B: Works by default. If user wants to override, docs clearly call out the permitted value.
Thoughts?