CLANG-INCLUDE-FIXER(1)

💖 NAME 💖

clang-include-fixer — bestie, this is the manual page for clang-include-fixer 15 🦋

---

✨ DESCRIPTION ✨

okay so here's the vibe. You run it like this:

USAGE: clang-include-fixer [options] <source0> [... <sourceN>]

and then there are OPTIONS. so many options. let's get into it 💅

🌸 Generic Options 🌸

• --help — shows you all the available options (--help-hidden gets you even more, lowkey a lot)
• --help-list — prints out the list of available options (--help-list-hidden for even more)
• --version — tells you what version of this program you're running

🎀 Tool options 🎀

• --db=<value> — specify the input format. the options for value are:
  • =fixed — hard-coded mapping
  • =yaml — a Yaml database, the kind created by find-all-symbols
  • =fuzzyYaml — a Yaml database, but with fuzzy-matched names
• --extra-arg=<string> — an extra argument to append to the compiler command line
• --extra-arg-before=<string> — an extra argument to prepend to the compiler command line
• --input=<string> — a string to initialize the database with
• --insert-header=<string> — insert one specific header. this one should run with STDIN mode, bestie. the result gets written to stdout, and rn it's used for editor integration. it supports YAML/JSON format:

-insert-header="{
       FilePath: "/path/to/foo.cc", QuerySymbolInfos: [

{RawIdentifier: foo,
       Range: {Offset: 0, Length: 3}}

],     HeaderInfos: [ {Headers: "\"foo_a.h\"",

       QualifiedName: "a::foo"} ]}"

• --minimize-paths — whether to minimize the added include paths
• --output-headers — prints the symbol being queried plus all its relevant headers in JSON format to stdout, like this:

{      "FilePath": "/path/to/foo.cc", "QuerySymbolInfos": [

{"RawIdentifier": "foo",
       "Range": {"Offset": 0, "Length": 3}}

],     "HeaderInfos": [ {"Header": "\"foo_a.h\"",

"QualifiedName": "a::foo"} ]
       }

• -p <string> — build path
• -q — reduce terminal output (quiet girl era 🙈)
• --query-symbol=<string> — query a given symbol (like "a::b::foo") directly in the database, no file parsing needed
• --stdin — overrides the source file's content (in the overlaying virtual file system) with input from <stdin>, then runs the tool on that new content using the compilation options of the source file. this mode is currently used for editor integration ✨
• --style=<string> — the fallback style for reformatting after inserting new headers, for when there's no clang-format config file to be found

---

and that's the whole thing, no cap 💜 this was clang-include-fixer 15, from July 2023, part of User Commands — go forth and let the includes fix themselves, you've got this 🫶✨