cpp-include-sorter
Automatically sorts C/C++ header files (#include statements) with full support for conditional compilation blocks. Use when Claude needs to organize
How do I install this agent skill?
npx skills add https://github.com/openharmonyinsight/openharmony-skills --skill cpp-include-sorterIs this agent skill safe to install?
- Gen Agent Trust Hubpass
The skill is a utility for sorting C/C++ include statements. It processes local source files but does not perform network operations, execute remote code, or exhibit any malicious patterns.
- Socketpass
No alerts
- Snykpass
Risk: LOW · No issues
- Runlayerwarn
2/2 files flagged
What does this agent skill do?
C/C++ Include Sorter
Automatically sorts #include statements in C/C++ source files with intelligent handling of conditional compilation blocks.
Quick Start
Sort all .cpp files in a directory:
python scripts/sort_includes.py <directory-path>
Preview changes without modifying files:
python scripts/sort_includes.py <directory-path> --dry-run
Sorting Rules
Includes are organized into 3 categories with blank lines between each group:
- Corresponding header - For
file.cpp,file.his placed first (prefers longest path if duplicates exist) - System headers - Headers with angle brackets
<>(sorted alphabetically) - Local headers - Headers with double quotes
""(sorted alphabetically)
Conditional Compilation Blocks
#ifdef/#ifndef/#if defined blocks are treated as units:
- Blocks participate in global sorting based on their first include
- Headers inside each block are also sorted (system headers first, then local headers)
- Block structure (
#ifdef...#endif) is preserved #elifand#elseblocks are supported
Example
Before:
#include "common/rs_log.h"
#include "rs_trace.h"
#include <memory>
#ifdef RS_ENABLE_GPU
#include "feature/uifirst/rs_sub_thread_manager.h"
#include "feature/capture/rs_ui_capture_task_parallel.h"
#endif
#include "platform/common/rs_system_properties.h"
After:
#include "rs_trace.h" // 1. Corresponding header (longest path preferred)
#include <memory> // 2. System headers (alphabetical)
#include "common/rs_log.h" // 3. Local headers (alphabetical)
#ifdef RS_ENABLE_GPU
#include "feature/capture/rs_ui_capture_task_parallel.h"
#include "feature/uifirst/rs_sub_thread_manager.h"
#endif
#include "platform/common/rs_system_properties.h"
Features
- Duplicate include handling: When multiple includes with same filename but different paths exist (e.g.,
"file.h"and"path/to/file.h"), the longest path is used as the corresponding header and placed first - Comment preservation: Inline comments (
// comment) and preceding comments are preserved - Nested conditional blocks: Handles
#elifand#elsewithin#ifdefblocks - Validation: Verifies no headers are lost during sorting
Script Reference
See scripts/sort_includes.py for implementation details.
Key functions:
extract_includes_with_ifdef()- Parses includes and conditional blockssort_includes_with_ifdef()- Sorts with 3-category ruleformat_ifdef_block()- Formats conditional blocks with sorted includes
Verification
After sorting, verify:
- All
#ifdefblocks contain same number of headers as before - Corresponding header has complete path (not shortened)
- Total include count unchanged
- Comments preserved
Use git diff to compare before/after:
git diff <file.cpp> | grep "^[-+]" | grep "include"
How can the creator link this skill?
Add the canonical catalog link to the repository README so users can inspect current installs and available audits. The publishing guide covers the complete discovery path.
<a href="https://skillzs.dev/skills/openharmonyinsight/openharmony-skills/cpp-include-sorter">View cpp-include-sorter on skillZs</a>