style(clang-tidy): fix include headers clang-tidy errors

[bavulapati]

fixes #1684

[jviotti]

Let's make modules only include public headers of other modules

Suggested change

	#include <sourcemeta/core/json_value.h>
	#include <sourcemeta/core/json.h>

The idea is that only src/json can be internally aware that there is a json_value.h header, and every consumer should just require the public one

[jviotti]

Suggested change

	#include <sourcemeta/core/json_value.h>
	#include <sourcemeta/core/json.h>

[jviotti]

We shouldn't include json_value.h if we are including json.h

[jviotti]

We shouldn't include jsonschema_types.h if we are including jsonschema.h

[jviotti]

Suggested change

	#include <sourcemeta/core/json_value.h>
	#include <sourcemeta/core/json.h>

[jviotti]

Suggested change

	#include <sourcemeta/core/json_value.h>
	#include <sourcemeta/core/json.h>

[jviotti]

Suggested change

	#include <sourcemeta/core/json_value.h>
	#include <sourcemeta/core/json.h>

[jviotti]

We shouldn't include json_value.h (nor json_error.h as in the above line btw) if we are including json.h

[jviotti]

we shouldn't include yaml_error.h if we are including yaml.h

[jviotti]

This file should only be including jsonschema.h

[bavulapati]

@jviotti I think we can use https://github.com/include-what-you-use/include-what-you-use/blob/master/docs/IWYUPragmas.md

I'm learning more

[bavulapati]

https://clangd.llvm.org/design/include-cleaner#iwyu-pragmas

[bavulapati]

I think we are looking for https://clangd.llvm.org/design/include-cleaner#umbrella-headers

[bavulapati]

googletest is using iwyu

https://github.com/google/googletest/blob/09ffd0015395354774c059a17d9f5bee36177ff9/googletest/include/gtest/gtest.h#L63-L72

https://github.com/google/googletest/blob/09ffd0015395354774c059a17d9f5bee36177ff9/googletest/include/gtest/gtest-assertion-result.h#L34-L36

[bavulapati]

Not sure how googletest is using it. repo doesn't have any file containing iwyu other than source code

[jviotti]

I'm not sure, but sounds worth researching. In any case, just to keep it simple, let's aim to fix the ClangTidy warnings we get now, as of the latest changes. Once we have ClangTidy enforced in the .cc files, we can look at how to make it cover headers and potentially improve the include detection?

[bavulapati]

#1750 replaces this.