Skip to content
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

(clang-tidy): Disable 'modernize-use-designated-initializers' #4333

Conversation

fsandhei
Copy link
Contributor

@fsandhei fsandhei commented Apr 6, 2024

modernize-use-designated-initializers checks for initializer lists that could be written as designated initializers instead. See https://clang.llvm.org/extra//clang-tidy/checks/modernize/use-designated-initializers.html

However, this is a C++20 feature. While it can be supported by compilers before C++20, it is still enabled by default by clang-tidy.

Since designated initializers are not in the standard pre C++20, and this library supports versions up to including C++20, I would suggest disabling this check.


Pull request checklist

Read the Contribution Guidelines for detailed information.

  • Changes are described in the pull request, or an existing issue is referenced.
  • The test suite compiles and runs without error.
  • Code coverage is 100%. Test cases can be added by editing the test suite.
  • The source code is amalgamated; that is, after making changes to the sources in the include/nlohmann directory, run make amalgamate to create the single-header files single_include/nlohmann/json.hpp and single_include/nlohmann/json_fwd.hpp. The whole process is described here.

Please don't

  • The C++11 support varies between different compilers and versions. Please note the list of supported compilers. Some compilers like GCC 4.7 (and earlier), Clang 3.3 (and earlier), or Microsoft Visual Studio 13.0 and earlier are known not to work due to missing or incomplete C++11 support. Please refrain from proposing changes that work around these compiler's limitations with #ifdefs or other means.
  • Specifically, I am aware of compilation problems with Microsoft Visual Studio (there even is an issue label for this kind of bug). I understand that even in 2016, complete C++11 support isn't there yet. But please also understand that I do not want to drop features or uglify the code just to make Microsoft's sub-standard compiler happy. The past has shown that there are ways to express the functionality such that the code compiles with the most recent MSVC - unfortunately, this is not the main objective of the project.
  • Please refrain from proposing changes that would break JSON conformance. If you propose a conformant extension of JSON to be supported by the library, please motivate this extension.
  • Please do not open pull requests that address multiple issues.

modernize-use-designated-initializers checks for initializer lists that
could be written as designated initializers instead.
See https://clang.llvm.org/extra//clang-tidy/checks/modernize/use-designated-initializers.html

However, this is a C++20 feature. While it can be supported by compilers
before C++20, it is still enabled by default by clang-tidy.

Since designated initializers are not in the standard pre C++20,
and this library supports versions up to including C++20, I would
suggest disabling this check.
@fsandhei fsandhei requested a review from nlohmann as a code owner April 6, 2024 18:55
@github-actions github-actions bot added the S label Apr 6, 2024
@coveralls
Copy link

Coverage Status

coverage: 100.0%. remained the same
when pulling f4cbd47 on fsandhei:disable-designated-initializers-check-clang-tidy
into 199dea1 on nlohmann:develop.

@fsandhei
Copy link
Contributor Author

fsandhei commented Apr 7, 2024

I see that apparently you have made a similar pull request for this, so I'll close :)

@fsandhei fsandhei closed this Apr 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants