refactor: Update include statements to match our latest style guidelines (resolves #140). - #141
Conversation
|
""" WalkthroughThis change systematically replaces all relative include paths in source and test files with project-root-based absolute include paths prefixed by Changes
Possibly related PRs
Suggested reviewers
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (3)
🚧 Files skipped from review as they are similar to previous changes (3)
⏰ Context from checks skipped due to timeout of 90000ms (3)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🔭 Outside diff range comments (1)
src/spider/io/msgpack_message.hpp (1)
1-2:⚠️ Potential issueInclude guard macro does not match file path
The header is located inio, but the guard is namedSPIDER_CORE_MSGPACKMESSAGE_HPP, which risks collisions and reduces clarity.
Apply this diff to align the macro with its directory:-#ifndef SPIDER_CORE_MSGPACKMESSAGE_HPP -#define SPIDER_CORE_MSGPACKMESSAGE_HPP +#ifndef SPIDER_IO_MSGPACKMESSAGE_HPP +#define SPIDER_IO_MSGPACKMESSAGE_HPP ... -#endif // SPIDER_CORE_MSGPACKMESSAGE_HPP +#endif // SPIDER_IO_MSGPACKMESSAGE_HPPAlso applies to: 24-24
🧹 Nitpick comments (6)
src/spider/io/msgpack_message.hpp (1)
7-8: Header include paths updated correctly; unify IWYU pragma formatting
The absolute includes for BoostAsio and MsgPack are correct . However, the IWYU pragmas are inconsistent (// IWYU pragma: keepvs// IWYU pragma :keep). Please normalise both to the standard// IWYU pragma: keep.tests/CMakeLists.txt (3)
22-22: Ensure test target include directory resolves project headers correctlyThe test target uses:
target_include_directories(unitTest PRIVATE ${CMAKE_CURRENT_SOURCE_DIR}/..)which points at the repo root. Since your headers live under
src/spider/...and your code now does#include "spider/...", you likely need to add thesrcdirectory explicitly so the<spider/...>includes resolve. Consider:-target_include_directories(unitTest PRIVATE ${CMAKE_CURRENT_SOURCE_DIR}/..) +target_include_directories(unitTest PRIVATE + ${CMAKE_CURRENT_SOURCE_DIR}/../src +)
58-58: Restrict include directory visibility and update pathCurrently:
target_include_directories(worker_test PUBLIC ${CMAKE_CURRENT_SOURCE_DIR}/..)
PUBLICpropagates this include dir to dependents unnecessarily, and it still points at the repo root. Prefer:-target_include_directories(worker_test PUBLIC ${CMAKE_CURRENT_SOURCE_DIR}/..) +target_include_directories(worker_test PRIVATE + ${CMAKE_CURRENT_SOURCE_DIR}/../src +)to lock it down and ensure
"spider/..."headers are found.
82-82: Verifysignal_testheader pathThe
signal_testtarget now has:target_include_directories(signal_test PRIVATE ${CMAKE_CURRENT_SOURCE_DIR}/..)but headers live under
src/spider. You may want:-target_include_directories(signal_test PRIVATE ${CMAKE_CURRENT_SOURCE_DIR}/..) +target_include_directories(signal_test PRIVATE + ${CMAKE_CURRENT_SOURCE_DIR}/../src +)to match your new include convention.
src/spider/client/Driver.cpp (1)
15-21: Unify include style for all headersInternal headers have been standardized to:
#include "spider/..."but the local header is still:
#include "Driver.hpp"For consistency, update it to:
-#include "Driver.hpp" +#include "spider/client/Driver.hpp"src/spider/client/TaskContext.cpp (1)
12-15: Consistent header includesThe refactor changes external includes to
"spider/...", yet this file still does:#include "TaskContext.hpp"Please switch to:
-#include "TaskContext.hpp" +#include "spider/client/TaskContext.hpp"to keep the include style uniform.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (65)
src/spider/CMakeLists.txt(1 hunks)src/spider/client/Data.hpp(1 hunks)src/spider/client/Driver.cpp(1 hunks)src/spider/client/Driver.hpp(1 hunks)src/spider/client/Job.hpp(1 hunks)src/spider/client/TaskContext.cpp(1 hunks)src/spider/client/TaskContext.hpp(1 hunks)src/spider/client/TaskGraph.hpp(1 hunks)src/spider/client/spider.hpp(1 hunks)src/spider/client/task.hpp(1 hunks)src/spider/core/DataImpl.hpp(1 hunks)src/spider/core/Task.cpp(1 hunks)src/spider/core/Task.hpp(1 hunks)src/spider/core/TaskContextImpl.hpp(1 hunks)src/spider/core/TaskGraph.hpp(1 hunks)src/spider/core/TaskGraphImpl.hpp(1 hunks)src/spider/io/Serializer.hpp(1 hunks)src/spider/io/msgpack_message.cpp(1 hunks)src/spider/io/msgpack_message.hpp(1 hunks)src/spider/scheduler/FifoPolicy.cpp(1 hunks)src/spider/scheduler/FifoPolicy.hpp(1 hunks)src/spider/scheduler/SchedulerMessage.hpp(1 hunks)src/spider/scheduler/SchedulerServer.cpp(1 hunks)src/spider/scheduler/SchedulerServer.hpp(1 hunks)src/spider/scheduler/scheduler.cpp(1 hunks)src/spider/storage/DataStorage.hpp(1 hunks)src/spider/storage/JobSubmissionBatch.hpp(1 hunks)src/spider/storage/MetadataStorage.hpp(1 hunks)src/spider/storage/StorageFactory.hpp(1 hunks)src/spider/storage/mysql/MySqlConnection.cpp(1 hunks)src/spider/storage/mysql/MySqlConnection.hpp(1 hunks)src/spider/storage/mysql/MySqlJobSubmissionBatch.cpp(1 hunks)src/spider/storage/mysql/MySqlJobSubmissionBatch.hpp(1 hunks)src/spider/storage/mysql/MySqlStorage.cpp(1 hunks)src/spider/storage/mysql/MySqlStorage.hpp(1 hunks)src/spider/storage/mysql/MySqlStorageFactory.cpp(1 hunks)src/spider/storage/mysql/MySqlStorageFactory.hpp(1 hunks)src/spider/worker/DllLoader.cpp(1 hunks)src/spider/worker/FunctionManager.cpp(1 hunks)src/spider/worker/FunctionManager.hpp(1 hunks)src/spider/worker/TaskExecutor.cpp(1 hunks)src/spider/worker/TaskExecutor.hpp(1 hunks)src/spider/worker/TaskExecutorMessage.hpp(1 hunks)src/spider/worker/WorkerClient.cpp(1 hunks)src/spider/worker/WorkerClient.hpp(1 hunks)src/spider/worker/message_pipe.cpp(1 hunks)src/spider/worker/message_pipe.hpp(1 hunks)src/spider/worker/task_executor.cpp(1 hunks)src/spider/worker/worker.cpp(1 hunks)tests/CMakeLists.txt(3 hunks)tests/client/client-test.cpp(1 hunks)tests/client/test-Driver.cpp(1 hunks)tests/io/test-MsgpackMessage.cpp(1 hunks)tests/scheduler/test-SchedulerPolicy.cpp(1 hunks)tests/scheduler/test-SchedulerServer.cpp(1 hunks)tests/storage/StorageTestHelper.hpp(1 hunks)tests/storage/test-DataStorage.cpp(1 hunks)tests/storage/test-MetadataStorage.cpp(1 hunks)tests/utils/CoreDataUtils.hpp(1 hunks)tests/utils/CoreTaskUtils.cpp(1 hunks)tests/utils/CoreTaskUtils.hpp(1 hunks)tests/worker/test-FunctionManager.cpp(1 hunks)tests/worker/test-MessagePipe.cpp(1 hunks)tests/worker/test-Process.cpp(1 hunks)tests/worker/test-TaskExecutor.cpp(1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (3)
- GitHub Check: lint
- GitHub Check: non-storage-unit-tests (ubuntu-24.04)
- GitHub Check: non-storage-unit-tests (ubuntu-22.04)
🔇 Additional comments (62)
src/spider/storage/JobSubmissionBatch.hpp (1)
4-5: Use project-root-relative include pathsThe includes have been updated from relative paths to use the
spider/...prefix, matching the project’s convention and CMaketarget_include_directoriessetup. This improves readability and maintainability without altering functionality.src/spider/core/TaskContextImpl.hpp (1)
8-11: Consistent absolute include paths
The updated directives now correctly usespider/...paths and include all required headers (TaskContext,DataStorage,MetadataStorage,StorageFactory) without altering functionality.src/spider/storage/StorageFactory.hpp (1)
7-11: Standardized storage factory include paths
The includes forError,DataStorage,JobSubmissionBatch,MetadataStorage, andStorageConnectionhave been updated to project-root-basedspider/...paths, aligning with the refactor and preserving existing interfaces.src/spider/storage/DataStorage.hpp (1)
8-11: Unified include paths for DataStorage
All internal dependencies (Data,Error,KeyValueData,StorageConnection) are now consistently referenced usingspider/...absolute paths, maintaining the class interface and behavior.src/spider/client/TaskContext.hpp (1)
18-28: Project-root include paths in TaskContext.hpp
The header now references all client and core dependencies (Data,Exception,Job,task,TaskGraph,Error,TaskGraphImpl,Serializer,StorageConnection,StorageFactory) viaspider/...paths, ensuring consistency without functional changes.src/spider/client/Data.hpp (1)
14-20: Consistent include path updates
TheDatatemplate now imports necessary components (Exception,Error,MsgPack,Serializer,DataStorage,StorageConnection,StorageFactory) using uniformspider/...includes, preserving all existing functionality.src/spider/CMakeLists.txt (1)
46-46: Expose include directory for headers
Addingtarget_include_directories(spider_core PUBLIC ${CMAKE_CURRENT_SOURCE_DIR}/..)correctly exposes the root include path (spider/…) for consumers of spider_core, aligning with the refactored non-relative includes.src/spider/storage/MetadataStorage.hpp (1)
9-15: Consistent absolute include paths
The updated includes from"spider/core/Driver.hpp"through"spider/storage/StorageConnection.hpp"match the new project-root-relative style and maintain clear separation between core and storage headers. This aligns perfectly with the PR’s goal of removing relative paths.tests/utils/CoreDataUtils.hpp (1)
3-3: Use project-root include for Data.hpp
Switching to"spider/core/Data.hpp"ensures the test util follows the new include convention and remains consistent with production code.src/spider/core/TaskGraph.hpp (1)
15-15: Standardize include path for Task.hpp
Updating to"spider/core/Task.hpp"matches the absolute include pattern used elsewhere and removes any ambiguity in header resolution.src/spider/client/TaskGraph.hpp (1)
7-7: Adopt absolute include for client/task.hpp
Changing the include to"spider/client/task.hpp"aligns this header with the project-root style and guaranteesTaskIoand related templates are resolved consistently.src/spider/worker/TaskExecutorMessage.hpp (1)
6-6: Convert include to project-root-relative path
The include directive has been updated from a relative path to"spider/io/MsgPack.hpp", aligning with the repository’s convention for non-relative includes.src/spider/io/Serializer.hpp (1)
9-9: Standardise include path for MsgPack.hpp
Switching to"spider/io/MsgPack.hpp"ensures consistency with the absolute include strategy and honours the IWYU pragma.src/spider/core/Task.cpp (1)
12-13: Update include directives to usespider/prefix
Both MsgPack and Serializer headers now use fully qualified paths, matching the new include policy without altering any logic.src/spider/core/TaskGraphImpl.hpp (1)
14-21: Migrate multiple includes to absolute, project-root-relative paths
All core, client and IO headers are now imported viaspider/..., preserving IWYU pragmas and simplifying include resolution.src/spider/worker/FunctionManager.hpp (1)
20-30: Refactor includes to usespider/-prefixed paths
Internal headers across client, core, IO, storage and worker modules have been updated consistently, facilitating clearer dependency management.src/spider/scheduler/SchedulerMessage.hpp (1)
10-11: Include paths refactored to absolute project-root style
The relative imports for MsgPack and Serializer have been correctly replaced withspider/io/..., improving consistency across the codebase.src/spider/worker/message_pipe.hpp (1)
7-8: Include paths updated to project-root style
The switch from../io/...tospider/io/...for BoostAsio and MsgPack is accurate and aligns with the PR objective.src/spider/worker/message_pipe.cpp (1)
14-15: Include paths updated to project-root style
The absolute imports for BoostAsio and MsgPack now use thespider/io/...prefix as intended.tests/utils/CoreTaskUtils.cpp (1)
16-17: Test utilities updated to use absolute includes
The headersTask.hppandTaskGraph.hpphave been correctly referenced viaspider/core/..., aligning with the rest of the suite.src/spider/core/Task.hpp (1)
16-17: Standardize include directives to project-root-relative paths
The two headers have been correctly updated from relative to absolute paths (spider/core/Data.hppandspider/io/MsgPack.hpp), aligning with the new convention.src/spider/storage/mysql/MySqlConnection.cpp (1)
15-16: Apply absolute include paths for core and storage headers
The includes forspider/core/Error.hppandspider/storage/StorageConnection.hppare correctly converted to project-root-based paths, matching the refactoring across the codebase.src/spider/io/msgpack_message.cpp (1)
17-18: Switch to absolute includes for BoostAsio and MsgPack
The local includes have been updated to"spider/io/BoostAsio.hpp"and"spider/io/MsgPack.hpp"with IWYU pragmas retained—this change is consistent with the new include strategy.src/spider/scheduler/scheduler.cpp (1)
23-35: Refactor scheduler includes to project-root-relative style
All dependencies underspider/core,spider/io,spider/scheduler,spider/storage, andspider/utilshave been updated to absolute paths. This block is consistent with the rest of the refactor and preserves include grouping.src/spider/client/Driver.hpp (2)
11-11: Add<utility>for move semantics
The addition of<utility>ensuresstd::moveand related utilities are available, which is required by the class constructors invokingstd::move.
18-31: Convert client-driver includes to absolute paths
All client, core, io, storage, and worker headers are now included via fully qualifiedspider/...paths. This aligns with project guidelines and maintains consistency.tests/storage/StorageTestHelper.hpp (1)
10-11: Include path update is correct and consistent.
The switch tospider/storage/mysql/MySqlStorageFactory.hppandspider/storage/StorageFactory.hppaligns with the new project-root include convention and improves clarity.src/spider/worker/task_executor.cpp (1)
23-33: Switch to non-relative include directives.
These updated includes consistently reference thespider/namespace and preserve existing IWYU pragmas, matching the PR’s objective to standardize header paths.tests/utils/CoreTaskUtils.hpp (1)
4-5: Standardize to project-root include paths.
Replacing the relative paths withspider/core/Task.hppandspider/core/TaskGraph.hppimproves maintainability and aligns with the repository’s conventions.src/spider/scheduler/FifoPolicy.hpp (1)
11-15: Convert to fully qualified include paths.
The newspider/core/Task.hpp,spider/scheduler/SchedulerPolicy.hpp,spider/storage/DataStorage.hpp,spider/storage/MetadataStorage.hpp, andspider/storage/StorageConnection.hppincludes adhere to the project-root convention and enhance readability.src/spider/core/DataImpl.hpp (1)
7-9: Adopt project-root include directives.
Updating tospider/client/Data.hpp,spider/core/Data.hpp, andspider/storage/StorageFactory.hppmaintains consistency across modules and supports the updated CMake include settings.src/spider/worker/DllLoader.cpp (1)
11-12: Consistent project-root include paths
Updated include directives correctly referencespider/workerheaders, aligning with the project’s non-relative include style.src/spider/worker/worker.cpp (1)
36-52: Standardize include directives
All project headers are now included withspider/...prefixes and IWYU pragmas are preserved, improving clarity and maintainability.src/spider/storage/mysql/MySqlConnection.hpp (1)
11-12: Use absolute include paths for core and storage
The includes forspider/core/Error.hppandspider/storage/StorageConnection.hppcorrectly replace relative paths and maintain consistency with the project’s include conventions.src/spider/storage/mysql/MySqlStorageFactory.cpp (1)
8-16: Switch to project-root includes for storage factory
Updated include directives to non-relative paths for core error, storage interfaces, and MySQL-specific headers, matching the refactoring across the storage module.tests/io/test-MsgpackMessage.cpp (1)
13-15: Align test includes with project structure
Replaced relative test includes withspider/io/...paths and preserved IWYU pragmas, ensuring tests compile against the new header layout.src/spider/scheduler/FifoPolicy.cpp (1)
13-16: Approve include path modernizationThe updated include directives correctly use the project-root
spider/...style without altering any semantics. CI confirms the build remains successful.src/spider/scheduler/SchedulerServer.cpp (1)
14-24: Approve include path updatesThe switch to
spider/...include paths is consistent and does not affect functionality. All existing IWYU pragmas remain in place and CI passes.src/spider/worker/WorkerClient.cpp (1)
18-28: Approve absolute include path standardizationThe updated includes follow the
spider/...convention and preserve the necessary IWYU pragmas. No behavioural changes introduced.src/spider/storage/mysql/MySqlJobSubmissionBatch.hpp (1)
8-10: Approve modernization of include directivesThe include paths were converted to use the
spider/...prefix correctly, aligning with project style. Class definitions and logic remain untouched.src/spider/client/task.hpp (1)
6-8: Approve refactored include pathsHeaders now use root-based
spider/...includes per project convention. All template concepts and declarations are unchanged.src/spider/worker/WorkerClient.hpp (1)
11-14: Use absolute include paths consistently
The refactored include directives now uniformly reference thespider/root, improving clarity and maintainability. The IWYU pragmas are preserved correctly.src/spider/client/spider.hpp (1)
5-9: Standardise client module include paths
The change to fully qualifiedspider/client/...headers enhances discoverability and aligns with the project’s include path conventions.src/spider/storage/mysql/MySqlJobSubmissionBatch.cpp (1)
7-10: Align MySQL storage includes with project root
Updating these headers to usespider/...paths maintains consistency across storage modules without altering functionality.src/spider/worker/FunctionManager.cpp (1)
14-15: Update worker includes to project-root paths
The modification tospider/io/MsgPack.hppandspider/worker/TaskExecutorMessage.hppfollows the new include path standard and keeps the IWYU directives intact.src/spider/storage/mysql/MySqlStorageFactory.hpp (1)
8-13: Switch StorageFactory includes to absolute paths
These headers now correctly reference thespider/prefix, which improves readability and reduces dependency on relative paths.tests/scheduler/test-SchedulerServer.cpp (1)
15-29: Excellent standardization of include paths.The change from relative include paths to project-root-based absolute paths improves maintainability and readability. This standardization makes it easier to relocate files within the project structure without having to update numerous include paths.
These non-relative paths make the code more robust against refactoring and provide clearer visibility into the project's structure.
src/spider/storage/mysql/MySqlStorage.hpp (1)
13-25: Great improvement to include directives.Converting from relative paths (which likely involved multiple levels of "../") to absolute paths with the "spider/" prefix significantly enhances code readability and maintainability. This is especially valuable in deeply nested directories like this MySQL storage implementation.
The change eliminates the need to count directory levels when adding new includes and makes the code structure immediately obvious to developers.
tests/worker/test-Process.cpp (1)
10-11: Consistent include path standardization.The change to project-root-based paths aligns with the codebase-wide standardization and improves maintainability. The IWYU pragma is properly preserved.
src/spider/scheduler/SchedulerServer.hpp (1)
8-12: Good include path standardization.Converting to project-root-based include paths improves maintainability and clarity. This approach makes it instantly clear which project component each header belongs to and eliminates complex relative path calculations.
The IWYU pragma comment is properly preserved, maintaining build optimization directives.
tests/worker/test-FunctionManager.cpp (1)
14-28: Refactored include paths look correct
The updated headers now use project-root-basedspider/andtests/prefixes, replacing the previous relative paths. This enhances clarity and maintainability without altering behaviour.tests/worker/test-MessagePipe.cpp (1)
9-13: Absolute include paths applied successfully
The change to#include "spider/io/BoostAsio.hpp"and other internal headers aligns with the project standard. No logic or test behaviour is affected.src/spider/worker/TaskExecutor.hpp (1)
24-28: Updated internal includes to usespider/prefix
Switching from relative to absolute includes here is consistent with the rest of the codebase. Ensure that the include directories in CMake are correctly set to resolve these paths.src/spider/worker/TaskExecutor.cpp (1)
13-18: Project include directives standardised
The move to absolutespider/includes for BoostAsio, MsgPack, FunctionManager, etc., is purely stylistic and maintains existing functionality.tests/scheduler/test-SchedulerPolicy.cpp (1)
15-25: Scheduler test includes aligned with new style
Replacing relative includes withspider/andtests/prefixes keeps the test code consistent and clear. No behavioural changes detected.tests/worker/test-TaskExecutor.cpp (1)
19-32: Absolute include paths look correctThe include directives have been updated from relative to absolute (
"spider/..."and"tests/...") and align with the new project layout. Everything here looks good.tests/client/test-Driver.cpp (1)
9-13: Project and test headers updated properlyYour
#includedirectives now use project-root paths ("spider/..."and"tests/...") matching the refactored structure. LGTM.tests/client/client-test.cpp (1)
15-19:Details
✅ Verification successful
Consistent non‐relative includes
The include directives have been updated to use project‐root‐based paths (spider/…andtests/…), improving clarity and maintainability.Run the following to ensure your CMakeLists setup covers both source and test roots:
🏁 Script executed:
#!/bin/bash # Search for include setup in CMakeLists.txt rg "target_include_directories" -n .Length of output: 568
CMake include paths already cover project-root-based includes
Bothsrc/spider/CMakeLists.txt(lines 46, 179) andtests/CMakeLists.txt(lines 22, 58, 81) add${CMAKE_CURRENT_SOURCE_DIR}/..to their include paths, so thespider/...andtests/...headers intests/client/client-test.cppresolve correctly. No further changes required.tests/storage/test-MetadataStorage.cpp (1)
16-26: Localized include path standardization approved
Updated headers now consistently referencespider/…andtests/…paths, aligning with project conventions and requiring no further adjustments.src/spider/client/Job.hpp (1)
19-29:Details
✅ Verification successful
Root‐based header includes applied
Headers have been converted from relative to absolute paths. Confirm that all listed headers (notablyspider/client/task.hppandspider/client/type_utils.hpp) exist with correct casing, and verify thatsrc/spideris included in your build’s include directories.Run this script to verify header file existence:
🏁 Script executed:
#!/bin/bash # Check for the existence of each updated include for hdr in Data.hpp Exception.hpp task.hpp type_utils.hpp; do echo -n "Checking spider/client/$hdr: " [ -f src/spider/client/$hdr ] && echo "Found" || echo "Missing" doneLength of output: 824
🏁 Script executed:
#!/usr/bin/env bash # Search for CMake include directives and compiler flags referencing src/spider echo "Scanning for include_directories in CMakeLists:" rg "include_directories" -n . rg "target_include_directories" -n . echo "Scanning for -I flags pointing to src/spider:" rg "-I[^ ]*src/spider" -n .Length of output: 1771
Root‐based includes verification complete
All specified headers exist undersrc/spider/client, and the project’s CMakeLists (src/spider/CMakeLists.txt) correctly adds${CMAKE_CURRENT_SOURCE_DIR}/..to the include path, coveringsrc/spider. No further action needed.tests/storage/test-DataStorage.cpp (1)
11-22: Approved: standardized includes
Include directives now uniformly usespider/…andtests/…paths. This enhances consistency and readability without affecting test logic.src/spider/storage/mysql/MySqlStorage.cpp (1)
31-43: Approved: MySQL storage headers updated
Includes have been refactored to use project‐root‐based paths for core, storage, and MySQL‐specific headers. Ensure that bothsrc/spiderandsrc/spider/storage/mysqldirectories are added to your build’s include paths.
davidlion
changed the title
davidlion
left a comment
davidlion
left a comment
There was a problem hiding this comment.
As we discussed let's change the project library header include statements to use <> rather than "".
Co-authored-by: davidlion <davidlion2@protonmail.com>
Co-authored-by: davidlion <davidlion2@protonmail.com>
| # NOTE: A header is grouped by first matching regex | ||
| # Project headers | ||
| # Project library headers | ||
| - Regex: "^<spider" | ||
| Priority: 4 | ||
| # Library headers. Update when adding new libraries. |
There was a problem hiding this comment.
Sorry I just realized all of the .clang-format files have a weird issue where the project library headers split up the comment. Unfortunately, I can't make the full suggestion.
It should be:
# NOTE: A header is grouped by first matching regex library headers. Update when adding new
# libraries.
# NOTE: clang-format retains leading white-space on a line in violation of the YAML spec.
# Project library headers
- Regex: "^<spider"
Priority: 4
# External library headers
- Regex: "^<(absl|boost|catch2|fmt|mariadb|msgpack|spdlog|ystdlib)"
Priority: 3
# C system headers
There was a problem hiding this comment.
I believe the "Update when adding new libraries" is a comment for external library headers only. Thus I move it there.
3 participants
Description
Use non-relative header include paths for
src/spiderandtests.Checklist
breaking change.
Validation performed
Summary by CodeRabbit
Refactor
Chores