CLANG-INCLUDE-FIXER(1)

✨ NAME ✨

clang-include-fixer — bestie, this is the manual page for clang-include-fixer 11, section 1, User Commands. It fixes your includes. It's giving "I will find the header you forgot" energy. 💅

---

🦋 DESCRIPTION 🦋

Okay so here's how you actually run this thing:

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

That's it. You hand it your source files and it does its little magic. Periodt. 🌈

---

🎀 OPTIONS 🎀

✨ Generic Options ✨

The universal ones, the classics, the ones every LLVM tool shows up with:

• --help — Display available options. And if you want the secret menu, pass --help-hidden for more. 🙈
• --help-list — Display list of available options (--help-list-hidden for more).
• --version — Display the version of this program.

---

💖 Tool options 💖

This is the main character section. Pull up a chair.

• --db=<value> — Specify input format. Pick your flavor, bestie:
  • =fixed — Hard-coded mapping. Zero thoughts, just vibes.
  • =yaml — Yaml database created by find-all-symbols.
  • =fuzzyYaml — Yaml database, with fuzzy-matched names. (Fuzzy! Like a little peach 🍑 that doesn't need exact names.)
• --extra-arg=<string> — Additional argument to append to the compiler command line.
• --extra-arg-before=<string> — Additional argument to prepend to the compiler command line. (Yes, before. Not the same as above, don't @ me.)
• --input=<string> — String to initialize the database.
• --insert-header=<string> — Insert a specific header. This should run with STDIN mode. The result is written to stdout. It is currently used for editor integration. Support 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 added include paths.
• --output-headers — Print the symbol being queried and all its relevant headers in JSON format to stdout:

{
  "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. (Shy queen behavior, honestly. 🤫)
• --query-symbol=<string> — Query a given symbol (e.g. "a::b::foo") in database directly without parsing the file. So efficient of it.
• --stdin — Override source file's content (in the overlaying virtual file system) with input from <stdin> and run the tool on the new content with the compilation options of the source file. This mode is currently used for editor integration.
• --style=<string> — Fallback style for reformatting after inserting new headers if there is no clang-format config file found.

---

Heads up bestie 🫶 — --insert-header is meant to run with STDIN mode, and both --insert-header and --output-headers write to stdout, so plan your redirections accordingly. No cap.

---

Okay that's the whole page, go slay some includes, this was clang-include-fixer 11 from January 2022, mwah 💋✨🦋