feat: use IWYU pragma: private to indicate to IWYU the proper use of the library (#201)

Author: daantimmer

cucumber_cpp/acceptance_test/hooks/Hooks.cpp

@@ -1,4 +1,4 @@
-#include "cucumber_cpp/library/Hooks.hpp"
+#include "cucumber_cpp/CucumberCpp.hpp"
 #include "gmock/gmock.h"
 #include <iostream>
 #include <string>

cucumber_cpp/acceptance_test/steps/Steps.cpp

@@ -1,7 +1,6 @@
-#include "cucumber_cpp/library/Steps.hpp"
+#include "cucumber_cpp/CucumberCpp.hpp"
 #include "gmock/gmock.h"
 #include "gtest/gtest.h"
-#include <cstdint>
 #include <iostream>
 #include <string>
 

cucumber_cpp/library/Application.hpp

@@ -1,6 +1,9 @@
 #ifndef CUCUMBER_CPP_APPLICATION_HPP
 #define CUCUMBER_CPP_APPLICATION_HPP
 
+// IWYU pragma: private, include "cucumber_cpp/CucumberCpp.hpp"
+// IWYU pragma: friend cucumber_cpp/.*
+
 #include "cucumber/gherkin/app.hpp"
 #include "cucumber_cpp/library/Context.hpp"
 #include "cucumber_cpp/library/cucumber_expression/ParameterRegistry.hpp"

cucumber_cpp/library/Context.hpp

@@ -1,6 +1,9 @@
 #ifndef CUCUMBER_CPP_CONTEXT_HPP
 #define CUCUMBER_CPP_CONTEXT_HPP
 
+// IWYU pragma: private, include "cucumber_cpp/CucumberCpp.hpp"
+// IWYU pragma: friend cucumber_cpp/.*
+
 #include <algorithm>
 #include <forward_list>
 #include <iostream>

cucumber_cpp/library/Hooks.hpp

@@ -1,6 +1,9 @@
 #ifndef CUCUMBER_CPP_HOOKS_HPP
 #define CUCUMBER_CPP_HOOKS_HPP
 
+// IWYU pragma: private, include "cucumber_cpp/CucumberCpp.hpp"
+// IWYU pragma: friend cucumber_cpp/.*
+
 #include "cucumber_cpp/library/BodyMacro.hpp"
 #include "cucumber_cpp/library/HookRegistry.hpp"
 

cucumber_cpp/library/Steps.hpp

@@ -1,6 +1,9 @@
 #ifndef CUCUMBER_CPP_STEPSMACRO_HPP
 #define CUCUMBER_CPP_STEPSMACRO_HPP
 
+// IWYU pragma: private, include "cucumber_cpp/CucumberCpp.hpp"
+// IWYU pragma: friend cucumber_cpp/.*
+
 #include "cucumber_cpp/library/BodyMacro.hpp"
 #include "cucumber_cpp/library/StepRegistry.hpp"
 #include "cucumber_cpp/library/engine/Step.hpp"

cucumber_cpp/library/report/Report.hpp

@@ -1,6 +1,9 @@
 #ifndef REPORT_REPORT_HPP
 #define REPORT_REPORT_HPP
 
+// IWYU pragma: private, include "cucumber_cpp/CucumberCpp.hpp"
+// IWYU pragma: friend cucumber_cpp/.*
+
 #include "cucumber_cpp/library/TraceTime.hpp"
 #include "cucumber_cpp/library/engine/ContextManager.hpp"
 #include "cucumber_cpp/library/engine/FeatureInfo.hpp"