|
| 1 | +--- |
| 2 | + |
| 3 | +### NOTE: |
| 4 | +# The 'Checks: >' is a multiline string here. Comment must not be moved into the string. |
| 5 | +# |
| 6 | +### Scopes to be enabled: |
| 7 | +# |
| 8 | +# cppcoreguidelines-*, |
| 9 | +# google-*, |
| 10 | +# readability-*, |
| 11 | +# modernize-*, |
| 12 | +# bugprone-*, |
| 13 | +# misc-*, |
| 14 | +# |
| 15 | +### Checks that are turned off for a reason: |
| 16 | +# |
| 17 | +# -cppcoreguidelines-pro-bounds-pointer-arithmetic |
| 18 | +# -google-readability-todo. No big reason to enforce |
| 19 | +# -modernize-use-trailing-return-type. Just stylistic preference |
| 20 | +# -readability-identifier-length. A lot of code use short names for readability, i.e. 'B' for batch |
| 21 | +# -readability-uppercase-literal-suffix. |
| 22 | +# |
| 23 | +### Checks that are turned off but better be enabled later: |
| 24 | +# -bugprone-narrowing-conversions |
| 25 | +# -bugprone-easily-swappable-parameters |
| 26 | +# -bugprone-fold-init-type |
| 27 | +# -bugprone-implicit-widening-of-multiplication-result |
| 28 | +# -cppcoreguidelines-narrowing-conversions |
| 29 | +# -google-readability-braces-around-statements |
| 30 | +# -readability-implicit-bool-conversion, |
| 31 | +# -readability-magic-numbers, cppcoreguidelines-avoid-magic-numbers |
| 32 | +# -readability-function-cognitive-complexity. Reasonable way to enforce splitting complex code into simple functions |
| 33 | +# -modernize-concat-nested-namespaces. More compact way when C++17 is available |
| 34 | + |
| 35 | +Checks: > |
| 36 | + -*, |
| 37 | + performance-*, |
| 38 | + modernize-pass-by-value, |
| 39 | + cppcoreguidelines-prefer-member-initializer, |
| 40 | + -bugprone-easily-swappable-parameters, |
| 41 | + -bugprone-fold-init-type, |
| 42 | + -bugprone-implicit-widening-of-multiplication-result, |
| 43 | + -bugprone-narrowing-conversions, |
| 44 | + -cppcoreguidelines-narrowing-conversions, |
| 45 | + -cppcoreguidelines-pro-bounds-pointer-arithmetic, |
| 46 | + -google-build-using-namespace, |
| 47 | + -google-readability-todo, |
| 48 | + -readability-braces-around-statements, |
| 49 | + -google-readability-braces-around-statements, |
| 50 | + -modernize-use-trailing-return-type, |
| 51 | + -readability-identifier-length, |
| 52 | + -readability-implicit-bool-conversion, |
| 53 | + -readability-magic-numbers, |
| 54 | + -cppcoreguidelines-avoid-magic-numbers, |
| 55 | + -readability-uppercase-literal-suffix, |
| 56 | + -readability-function-cognitive-complexity, |
| 57 | + -modernize-concat-nested-namespaces, |
| 58 | +# Treat warnings as errors |
| 59 | +WarningsAsErrors: '*' |
| 60 | +# Use clang-format for applied fixes |
| 61 | +FormatStyle: file |
| 62 | +HeaderFilterRegex: '' |
| 63 | +CheckOptions: |
| 64 | + - key: cppcoreguidelines-avoid-do-while.IgnoreMacros |
| 65 | + value: true |
| 66 | + # matches with corresponding cpplink check |
| 67 | + - key: google-readability-namespace-comments.ShortNamespaceLines |
| 68 | + value: "10" |
| 69 | + # matches with corresponding cpplink check |
| 70 | + - key: google-readability-namespace-comments.SpacesBeforeComments |
| 71 | + value: "2" |
| 72 | + - key: modernize-loop-convert.MinConfidence |
| 73 | + value: reasonable |
| 74 | + - key: modernize-pass-by-value.IncludeStyle |
| 75 | + value: google |
| 76 | +### To be considered to enable: |
| 77 | +# # Unifies the usage of the statements |
| 78 | +# - key: readability-braces-around-statements.ShortStatementLines |
| 79 | +# value: "1" |
| 80 | +# Reasonable way to enforce splitting complex code into simple functions |
| 81 | +# - key: google-readability-function-size.StatementThreshold |
| 82 | +# value: "800" |
| 83 | +--- |
0 commit comments