Add build/namespaces_names error #286
Closed
Conversation
This file contains hidden or 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
This error category checks whether all namespace names are written in lowercase, with words separated by underscores, as is recommended by the google style guide: https://google.github.io/styleguide/cppguide.html#Namespace_Names This is accomplished by checking every line against a regular expression to find namespace declarations first, and afterwards check the name of that namespace.
This checks some basic good and bad examples for the namespace names convention as established by the google style guide.
The v8 sample defines a namespace `v8`, which is not allowed according to the google style guide.
aaronliu0130
requested changes
Sep 5, 2024
Member
aaronliu0130
left a comment
aaronliu0130
left a comment
There was a problem hiding this comment.
Thanks for taking the time to contribute!
Comment on lines
+5496
to
+5499
| 'Namespace names must be all lower-case, with words separated ' | ||
| 'by underscores. See ' | ||
| 'https://google.github.io/styleguide/cppguide.html#Namespace_Names' | ||
| ' for more information.') |
Member
There was a problem hiding this comment.
Suggested change
| 'Namespace names must be all lower-case, with words separated ' | |
| 'by underscores. See ' | |
| 'https://google.github.io/styleguide/cppguide.html#Namespace_Names' | |
| ' for more information.') | |
| 'Namespace names must be all lower-case with words separated ' | |
| 'by underscores.') |
We never link to the style guide if it's pretty obvious, and there's a comma splice here.
Comment on lines
+4584
to
+4602
| 'foo.' + extension, 'namespace CamelCase {}', | ||
| 'Namespace names must be all lower-case, with words separated by underscores. ' | ||
| 'See https://google.github.io/styleguide/cppguide.html#Namespace_Names ' | ||
| 'for more information. [build/namespaces_names] [4]') | ||
| self.TestLanguageRulesCheck( | ||
| 'foo.' + extension, 'inline namespace Uppercase {', | ||
| 'Namespace names must be all lower-case, with words separated by underscores. ' | ||
| 'See https://google.github.io/styleguide/cppguide.html#Namespace_Names ' | ||
| 'for more information. [build/namespaces_names] [4]') | ||
| self.TestLanguageRulesCheck( | ||
| 'foo.' + extension, 'namespace Uppercase = std', | ||
| 'Namespace names must be all lower-case, with words separated by underscores. ' | ||
| 'See https://google.github.io/styleguide/cppguide.html#Namespace_Names ' | ||
| 'for more information. [build/namespaces_names] [4]') | ||
| self.TestLanguageRulesCheck( | ||
| 'foo.' + extension, 'namespace a::inline b::inline C {', | ||
| 'Namespace names must be all lower-case, with words separated by underscores. ' | ||
| 'See https://google.github.io/styleguide/cppguide.html#Namespace_Names ' | ||
| 'for more information. [build/namespaces_names] [4]') |
Member
There was a problem hiding this comment.
Suggested change
| 'foo.' + extension, 'namespace CamelCase {}', | |
| 'Namespace names must be all lower-case, with words separated by underscores. ' | |
| 'See https://google.github.io/styleguide/cppguide.html#Namespace_Names ' | |
| 'for more information. [build/namespaces_names] [4]') | |
| self.TestLanguageRulesCheck( | |
| 'foo.' + extension, 'inline namespace Uppercase {', | |
| 'Namespace names must be all lower-case, with words separated by underscores. ' | |
| 'See https://google.github.io/styleguide/cppguide.html#Namespace_Names ' | |
| 'for more information. [build/namespaces_names] [4]') | |
| self.TestLanguageRulesCheck( | |
| 'foo.' + extension, 'namespace Uppercase = std', | |
| 'Namespace names must be all lower-case, with words separated by underscores. ' | |
| 'See https://google.github.io/styleguide/cppguide.html#Namespace_Names ' | |
| 'for more information. [build/namespaces_names] [4]') | |
| self.TestLanguageRulesCheck( | |
| 'foo.' + extension, 'namespace a::inline b::inline C {', | |
| 'Namespace names must be all lower-case, with words separated by underscores. ' | |
| 'See https://google.github.io/styleguide/cppguide.html#Namespace_Names ' | |
| 'for more information. [build/namespaces_names] [4]') | |
| 'foo.' + extension, 'namespace CamelCase {}', | |
| 'Namespace names must be all lower-case with words separated by underscores. ' | |
| '[naming/namespaces] [4]') | |
| self.TestLanguageRulesCheck( | |
| 'foo.' + extension, 'inline namespace Uppercase {', | |
| 'Namespace names must be all lower-case with words separated by underscores. ' | |
| '[naming/namespaces] [4]') | |
| self.TestLanguageRulesCheck( | |
| 'foo.' + extension, 'namespace Uppercase = std', | |
| 'Namespace names must be all lower-case with words separated by underscores. ' | |
| '[naming/namespaces] [4]') | |
| self.TestLanguageRulesCheck( | |
| 'foo.' + extension, 'namespace a::inline b::inline C {', | |
| 'Namespace names must be all lower-case with words separated by underscores. ' | |
| '[naming/namespaces] [4]') |
Ditto
| if match: | ||
| name = match.group(1) | ||
| if name != "" and not re.match(r'^((inline )?[a-z_]+(::)?)+$', name): | ||
| error(filename, linenum, 'build/namespaces_names', 4, |
Member
There was a problem hiding this comment.
Suggested change
| error(filename, linenum, 'build/namespaces_names', 4, | |
| error(filename, linenum, 'naming/namespaces', 4, |
This is decidedly not a building issue. This entire check is also not suited for the language rules−checking function. (I recommend you move this to a new function, which should also solve the lint errors.
Comment on lines
+5491
to
+5494
| match = re.match(r'.*namespace\s+([^{=;]+)\s+[{;=]', line) | ||
| if match: | ||
| name = match.group(1) | ||
| if name != "" and not re.match(r'^((inline )?[a-z_]+(::)?)+$', name): |
Member
There was a problem hiding this comment.
It would be much better if the detection was based on nesting_state. The could changed by #235 should provide an example.
aaronliu0130
reviewed
Sep 5, 2024
|
|
||
| src/interface-descriptors.h:5: #ifndef header guard has wrong style, please use: SAMPLES_V8_SAMPLE_SRC_INTERFACE_DESCRIPTORS_H_ [build/header_guard] [5] | ||
| src/interface-descriptors.h:1255: #endif line should be "#endif // SAMPLES_V8_SAMPLE_SRC_INTERFACE_DESCRIPTORS_H_" [build/header_guard] [5] | ||
| src/interface-descriptors.h:15: Namespace names must be all lower-case, with words separated by underscores. See https://google.github.io/styleguide/cppguide.html#Namespace_Names for more information. [build/namespaces_names] [4] |
Member
There was a problem hiding this comment.
Suggested change
| src/interface-descriptors.h:15: Namespace names must be all lower-case, with words separated by underscores. See https://google.github.io/styleguide/cppguide.html#Namespace_Names for more information. [build/namespaces_names] [4] | |
| src/interface-descriptors.h:15: Namespace names must be all lower-case with words separated by underscores. [naming/namespaces] [4] |
Member
|
Stale. Feel free to submit again after making the changes mentioned! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
This error category checks whether all namespace names are written in lowercase, with words separated by underscores, as is recommended by the google style guide:
https://google.github.io/styleguide/cppguide.html#Namespace_Names
This is accomplished by checking every line against a regular expression to find namespace declarations first, and afterwards check the name of that namespace.
The
v8sample fails this check, as it defines a namespacev8, which is not allowed. Subsequently, I also changed that test definition.