LadybirdBrowser/ladybird
1
1
Fork 0
mirror of https://github.com/LadybirdBrowser/ladybird.git synced 2024-12-28 13:43:45 +03:00
Code Issues Packages Projects Releases Wiki Activity
3888a91c5b
ladybird/.clang-tidy

58 lines
2.8 KiB
Plaintext
Raw Normal View History

Meta: Add basic clang-tidy configuration Add a basic clang-tidy configuration that enables checks from the following categories: - bugprone - cert - clang-analyzer - concurrency - misc - performance - portability - readability The noisiest rules that have conflicts with the project style guide or accepted practices have been turned off. There's absolutely more work to be done here before we could consider setting any of these warnings as errors and enforcing them in CI, but committing a project clang-tidy configuration should help the rules become more visible and let other contributors take a crack at tweaking rules and/or finding possible bugs. Sadly the cpp-core-guidelines and modernize categories are very, very noisy. If we want to enable rules from these categories, they would need to be on a rule by rule basis.
2021-09-20 00:46:18 +03:00
---
# Globally Disabled checks:
#
# bugprone-easily-swappable-parameters: This warning is loud with no clear advice on how to fix the potential problem
# FIXME: bugprone-macro-parentheses: Enable with clang-tidy-14 when NOLINTBEGIN/NOLINTEND are available for code generating macros
# bugprone-reserved-identifier: LibC headers that show up in the header filter are part of "the implementation"
# cert-dcl37-c: Alias for bugprone-reserved-identifier
# cert-dcl51-cpp: Alias for bugprone-reserved-identifier
# cert-dcl21-cpp: No reference to this rule exists on Carnegie Mellon's SEI CERT C++ Confluence. And the suggestion is unusual
Meta: Disable the misc-no-recursion check in clang-tidy We use recursive algorithms all over the place, and this check makes it hard to read those algorithms in CLion, since it draws squiggles under everything.
2023-03-18 16:23:36 +03:00
# misc-no-recursion: The project uses recursive algorithms in several places.
Meta: Disable misc-include-cleaner in clang-tidy IncludeCleaner is a new feature of clang-tidy/clangd that adds upstream support for the include-what-you-use (IWYU) tool's checks. However, this tool is very noisy on our codebase. It can be enabled by individual contributors at their leisure.
2024-02-05 14:22:03 +03:00
# misc-include-cleaner: This check is nice for cleanliness, but is very very noisy
Meta: Add basic clang-tidy configuration Add a basic clang-tidy configuration that enables checks from the following categories: - bugprone - cert - clang-analyzer - concurrency - misc - performance - portability - readability The noisiest rules that have conflicts with the project style guide or accepted practices have been turned off. There's absolutely more work to be done here before we could consider setting any of these warnings as errors and enforcing them in CI, but committing a project clang-tidy configuration should help the rules become more visible and let other contributors take a crack at tweaking rules and/or finding possible bugs. Sadly the cpp-core-guidelines and modernize categories are very, very noisy. If we want to enable rules from these categories, they would need to be on a rule by rule basis.
2021-09-20 00:46:18 +03:00
# FIXME: misc-non-private-member-variables-in-classes: Audit uses of protected member variables to see if they really need to be protected
# performance-noexcept-move-constructor: The project does not use exceptions, so there are no such optimizations available
# performance-no-int-to-ptr: This rule flags every pointer to integer cast, which gets quite noisy. Should only be enabled on a case-by-case basis
# readability-braces-around-statements: Redundant braces around single-line conditions is against project style
Meta: Disable readability-function-cognitive-complexity in clang-tidy Feedback from contributors suggests that this warning doesn't help code quality, and is seen as noisy.
2024-02-05 14:24:03 +03:00
# readability-function-cognitive-complexity: Most regular contributors seem to turn this one off anyway. Violations are hard to fix as well
Meta: Add basic clang-tidy configuration Add a basic clang-tidy configuration that enables checks from the following categories: - bugprone - cert - clang-analyzer - concurrency - misc - performance - portability - readability The noisiest rules that have conflicts with the project style guide or accepted practices have been turned off. There's absolutely more work to be done here before we could consider setting any of these warnings as errors and enforcing them in CI, but committing a project clang-tidy configuration should help the rules become more visible and let other contributors take a crack at tweaking rules and/or finding possible bugs. Sadly the cpp-core-guidelines and modernize categories are very, very noisy. If we want to enable rules from these categories, they would need to be on a rule by rule basis.
2021-09-20 00:46:18 +03:00
# readability-magic-numbers: This check is very noisy in the codebase, especially in AK.
# readability-named-parameter: We frequently omit parameter names to work around -Wunused-parameter
# FIXME: readability-uppercase-literal-suffix: Enable this check, the rationale is solid but the findings are numerous
#
Checks: >
-*,
bugprone-*,
cert-*,
clang-analyzer-*,
concurrency-*,
misc-*,
performance-*,
portability-*,
readability-*,
-bugprone-easily-swappable-parameters,
-bugprone-macro-parentheses,
-bugprone-reserved-identifier,-cert-dcl37-c,-cert-dcl51-cpp,
-cert-dcl21-cpp,
Meta: Disable misc-include-cleaner in clang-tidy IncludeCleaner is a new feature of clang-tidy/clangd that adds upstream support for the include-what-you-use (IWYU) tool's checks. However, this tool is very noisy on our codebase. It can be enabled by individual contributors at their leisure.
2024-02-05 14:22:03 +03:00
-misc-include-cleaner,
Meta: Disable the misc-no-recursion check in clang-tidy We use recursive algorithms all over the place, and this check makes it hard to read those algorithms in CLion, since it draws squiggles under everything.
2023-03-18 16:23:36 +03:00
-misc-no-recursion,
Meta: Add basic clang-tidy configuration Add a basic clang-tidy configuration that enables checks from the following categories: - bugprone - cert - clang-analyzer - concurrency - misc - performance - portability - readability The noisiest rules that have conflicts with the project style guide or accepted practices have been turned off. There's absolutely more work to be done here before we could consider setting any of these warnings as errors and enforcing them in CI, but committing a project clang-tidy configuration should help the rules become more visible and let other contributors take a crack at tweaking rules and/or finding possible bugs. Sadly the cpp-core-guidelines and modernize categories are very, very noisy. If we want to enable rules from these categories, they would need to be on a rule by rule basis.
2021-09-20 00:46:18 +03:00
-misc-non-private-member-variables-in-classes,
Meta: Disable misc-use-anonymous-namespace clang-tidy warning This flags nearly every static function, so let's disable it
2023-08-17 17:57:02 +03:00
-misc-use-anonymous-namespace,
Meta: Add basic clang-tidy configuration Add a basic clang-tidy configuration that enables checks from the following categories: - bugprone - cert - clang-analyzer - concurrency - misc - performance - portability - readability The noisiest rules that have conflicts with the project style guide or accepted practices have been turned off. There's absolutely more work to be done here before we could consider setting any of these warnings as errors and enforcing them in CI, but committing a project clang-tidy configuration should help the rules become more visible and let other contributors take a crack at tweaking rules and/or finding possible bugs. Sadly the cpp-core-guidelines and modernize categories are very, very noisy. If we want to enable rules from these categories, they would need to be on a rule by rule basis.
2021-09-20 00:46:18 +03:00
-performance-noexcept-move-constructor,
-performance-no-int-to-ptr,
-readability-braces-around-statements,
Meta: Disable readability-function-cognitive-complexity in clang-tidy Feedback from contributors suggests that this warning doesn't help code quality, and is seen as noisy.
2024-02-05 14:24:03 +03:00
-readability-function-cognitive-complexity,
Meta: Disable "readability-identifier-length" clang-tidy checks Short identifier names like "i", "x", "fd" are fairly common and fine.
2021-11-20 18:08:40 +03:00
-readability-identifier-length,
Meta: Add basic clang-tidy configuration Add a basic clang-tidy configuration that enables checks from the following categories: - bugprone - cert - clang-analyzer - concurrency - misc - performance - portability - readability The noisiest rules that have conflicts with the project style guide or accepted practices have been turned off. There's absolutely more work to be done here before we could consider setting any of these warnings as errors and enforcing them in CI, but committing a project clang-tidy configuration should help the rules become more visible and let other contributors take a crack at tweaking rules and/or finding possible bugs. Sadly the cpp-core-guidelines and modernize categories are very, very noisy. If we want to enable rules from these categories, they would need to be on a rule by rule basis.
2021-09-20 00:46:18 +03:00
-readability-magic-numbers,
-readability-named-parameter,
-readability-uppercase-literal-suffix,
Meta: Disable readability-use-anyofallof clang-tidy check
2022-01-09 17:34:38 +03:00
-readability-use-anyofallof,
Meta: Add basic clang-tidy configuration Add a basic clang-tidy configuration that enables checks from the following categories: - bugprone - cert - clang-analyzer - concurrency - misc - performance - portability - readability The noisiest rules that have conflicts with the project style guide or accepted practices have been turned off. There's absolutely more work to be done here before we could consider setting any of these warnings as errors and enforcing them in CI, but committing a project clang-tidy configuration should help the rules become more visible and let other contributors take a crack at tweaking rules and/or finding possible bugs. Sadly the cpp-core-guidelines and modernize categories are very, very noisy. If we want to enable rules from these categories, they would need to be on a rule by rule basis.
2021-09-20 00:46:18 +03:00
WarningsAsErrors: ''
HeaderFilterRegex: 'AK|Userland|Kernel|Tests'
FormatStyle: none
CheckOptions:
Meta: Enable the "bugprone-dangling-handle" clang-tidy check This should catch (the trivial cases of) construction of StringViews from temporary Strings and the construction of Spans from temporary Vectors.
2021-12-10 20:49:10 +03:00
- key: bugprone-dangling-handle.HandleClasses
value: 'AK::StringView;AK::Span'
Meta: Add basic clang-tidy configuration Add a basic clang-tidy configuration that enables checks from the following categories: - bugprone - cert - clang-analyzer - concurrency - misc - performance - portability - readability The noisiest rules that have conflicts with the project style guide or accepted practices have been turned off. There's absolutely more work to be done here before we could consider setting any of these warnings as errors and enforcing them in CI, but committing a project clang-tidy configuration should help the rules become more visible and let other contributors take a crack at tweaking rules and/or finding possible bugs. Sadly the cpp-core-guidelines and modernize categories are very, very noisy. If we want to enable rules from these categories, they would need to be on a rule by rule basis.
2021-09-20 00:46:18 +03:00
- key: misc-non-private-member-variables-in-classes.IgnoreClassesWithAllMemberVariablesBeingPublic
value: true
- key: readability-implicit-bool-conversion.AllowPointerConditions
value: true
Reference in New Issue Copy Permalink