[clangd] Add categories to help options, and only show clangd options.

[sammccall]

Summary

Restricting the categories prevents extra unwanted options from creeping into
help (D60663), and removes a bunch of noise from --help-hidden.

While here, remove static from the opts in favor of an anon namespace, to
reduce the noise level.

[hokein]

clang-tools-extra/clangd/tool/ClangdMain.cpp

59

maybe also group these options by the their categories?

[sammccall]

clang-tools-extra/clangd/tool/ClangdMain.cpp

59

Done, and sorted by name. Bye bye version history, though :-/

clang-tools-extra/clangd/tool/ClangdMain.cpp

 #include <iostream>
 #include <memory>
 #include <mutex>
 #include <string>
 #include <thread>
 
 namespace clang {
 namespace clangd {
+namespace {
 
 using llvm::cl::cat;
 using llvm::cl::CommaSeparated;
 using llvm::cl::desc;
 using llvm::cl::Hidden;
 using llvm::cl::init;
 using llvm::cl::list;
 using llvm::cl::opt;
+using llvm::cl::OptionCategory;
 using llvm::cl::values;
 
-static opt<Path> CompileCommandsDir{
+// All flags must be placed in a category, or they will be shown neither in
+// --help, nor --help-hidden!
+OptionCategory Features("clangd feature options");
+OptionCategory Protocol("clangd protocol and logging options");
+OptionCategory CompileCommands("clangd compilation flags options");
+OptionCategory Misc("clangd miscellaneous options");
+const OptionCategory *ClangdCategories[] = {&Features, &Protocol,
+                                            &CompileCommands, &Misc};
+
+opt<Path> CompileCommandsDir{
     "compile-commands-dir",
+    cat(CompileCommands),
     desc("Specify a path to look for compile_commands.json. If path "
          "is invalid, clangd will look in the current directory and "
          "parent paths of each source file"),
 };
 
-static opt<unsigned> WorkerThreadsCount{
+opt<unsigned> WorkerThreadsCount{
     "j",
+    cat(Misc),
     desc("Number of async workers used by clangd"),
     init(getDefaultAsyncThreadsCount()),
 };
 
 // FIXME: also support "plain" style where signatures are always omitted.
 enum CompletionStyleFlag { Detailed, Bundled };
-static opt<CompletionStyleFlag> CompletionStyle{
+opt<CompletionStyleFlag> CompletionStyle{
     "completion-style",
+    cat(Features),
     desc("Granularity of code completion suggestions"),
     values(clEnumValN(Detailed, "detailed",
                       "One completion item for each semantically distinct "
                       "completion, with full type information"),
            clEnumValN(Bundled, "bundled",
                       "Similar completion items (e.g. function overloads) are "
                       "combined. Type information shown where possible")),
 };
 
 // FIXME: Flags are the wrong mechanism for user preferences.
 // We should probably read a dotfile or similar.
-static opt<bool> IncludeIneligibleResults{
+opt<bool> IncludeIneligibleResults{
     "include-ineligible-results",
+    cat(Features),
     desc("Include ineligible completion results (e.g. private members)"),
     init(CodeCompleteOptions().IncludeIneligibleResults),
     Hidden,
 };
 
-static opt<JSONStreamStyle> InputStyle{
+opt<JSONStreamStyle> InputStyle{
     "input-style",
+    cat(Protocol),
     desc("Input JSON stream encoding"),
     values(
         clEnumValN(JSONStreamStyle::Standard, "standard", "usual LSP protocol"),
         clEnumValN(JSONStreamStyle::Delimited, "delimited",
                    "messages delimited by --- lines, with # comment support")),
     init(JSONStreamStyle::Standard),
     Hidden,
 };
 
-static opt<bool> PrettyPrint{
+opt<bool> PrettyPrint{
     "pretty",
+    cat(Protocol),
     desc("Pretty-print JSON output"),
     init(false),
 };
 
-static opt<Logger::Level> LogLevel{
+opt<Logger::Level> LogLevel{
     "log",
+    cat(Protocol),
     desc("Verbosity of log messages written to stderr"),
     values(clEnumValN(Logger::Error, "error", "Error messages only"),
            clEnumValN(Logger::Info, "info", "High level execution tracing"),
            clEnumValN(Logger::Debug, "verbose", "Low level details")),
     init(Logger::Info),
 };
 
-static opt<bool> Test{
+opt<bool> Test{
     "lit-test",
+    cat(Misc),
     desc("Abbreviation for -input-style=delimited -pretty -sync "
-         "-enable-test-scheme -log=verbose."
+         "-enable-test-scheme -log=verbose. "
          "Intended to simplify lit tests"),
     init(false),
     Hidden,
 };
 
-static opt<bool> EnableTestScheme{
+opt<bool> EnableTestScheme{
     "enable-test-uri-scheme",
+    cat(Protocol),
     desc("Enable 'test:' URI scheme. Only use in lit tests"),
     init(false),
     Hidden,
 };
 
 enum PCHStorageFlag { Disk, Memory };
-static opt<PCHStorageFlag> PCHStorage{
+opt<PCHStorageFlag> PCHStorage{
     "pch-storage",
+    cat(Misc),
     desc("Storing PCHs in memory increases memory usages, but may "
          "improve performance"),
     values(
         clEnumValN(PCHStorageFlag::Disk, "disk", "store PCHs on disk"),
         clEnumValN(PCHStorageFlag::Memory, "memory", "store PCHs in memory")),
     init(PCHStorageFlag::Disk),
 };
 
-static opt<int> LimitResults{
+opt<int> LimitResults{
     "limit-results",
+    cat(Features),
     desc("Limit the number of results returned by clangd. "
          "0 means no limit (default=100)"),
     init(100),
 };
 
-static opt<bool> Sync{
+opt<bool> Sync{
     "sync",
+    cat(Misc),
     desc("Parse on main thread. If set, -j is ignored"),
     init(false),
     Hidden,
 };
 
-static opt<Path> ResourceDir{
+opt<Path> ResourceDir{
     "resource-dir",
+    cat(CompileCommands),
     desc("Directory for system clang headers"),
     init(""),
     Hidden,
 };
 
-static opt<Path> InputMirrorFile{
+opt<Path> InputMirrorFile{
     "input-mirror-file",
+    cat(Protocol),
     desc("Mirror all LSP input to the specified file. Useful for debugging"),
     init(""),
     Hidden,
 };
 
-static opt<bool> EnableIndex{
+opt<bool> EnableIndex{
     "index",
+    cat(Features),
     desc("Enable index-based features. By default, clangd maintains an index "
          "built from symbols in opened files. Global index support needs to "
          "enabled separatedly"),
     init(true),
     Hidden,
 };
 
-static opt<bool> AllScopesCompletion{
+opt<bool> AllScopesCompletion{
     "all-scopes-completion",
+    cat(Features),
     desc("If set to true, code completion will include index symbols that are "
          "not defined in the scopes (e.g. "
          "namespaces) visible from the code completion point. Such completions "
          "can insert scope qualifiers"),
     init(true),
 };
 
-static opt<bool> ShowOrigins{
+opt<bool> ShowOrigins{
     "debug-origin",
+    cat(Features),
     desc("Show origins of completion items"),
     init(CodeCompleteOptions().ShowOrigins),
     Hidden,
 };
 
-static opt<CodeCompleteOptions::IncludeInsertion> HeaderInsertion{
+opt<CodeCompleteOptions::IncludeInsertion> HeaderInsertion{
     "header-insertion",
+    cat(Features),
     desc("Add #include directives when accepting code completions"),
     init(CodeCompleteOptions().InsertIncludes),
     values(
         clEnumValN(CodeCompleteOptions::IWYU, "iwyu",
                    "Include what you use. "
                    "Insert the owning header for top-level symbols, unless the "
                    "header is already directly included or the symbol is "
                    "forward-declared"),
         clEnumValN(
             CodeCompleteOptions::NeverInsert, "never",
             "Never insert #include directives as part of code completion")),
 };
 
-static opt<bool> HeaderInsertionDecorators{
+opt<bool> HeaderInsertionDecorators{
     "header-insertion-decorators",
+    cat(Features),
     desc("Prepend a circular dot or space before the completion "
          "label, depending on whether "
          "an include line will be inserted or not"),
     init(true),
 };
 
-static opt<Path> IndexFile{
+opt<Path> IndexFile{
     "index-file",
+    cat(Misc),
     desc(
         "Index file to build the static index. The file must have been created "
         "by a compatible clangd-indexer\n"
         "WARNING: This option is experimental only, and will be removed "
         "eventually. Don't rely on it"),
     init(""),
     Hidden,
 };
 
-static opt<bool> EnableBackgroundIndex{
+opt<bool> EnableBackgroundIndex{
     "background-index",
+    cat(Features),
     desc("Index project code in the background and persist index on disk. "
          "Experimental"),
     init(true),
 };
 
 enum CompileArgsFrom { LSPCompileArgs, FilesystemCompileArgs };
-static opt<CompileArgsFrom> CompileArgsFrom{
+opt<CompileArgsFrom> CompileArgsFrom{
     "compile_args_from",
+    cat(CompileCommands),
     desc("The source of compile commands"),
     values(clEnumValN(LSPCompileArgs, "lsp",
                       "All compile commands come from LSP and "
                       "'compile_commands.json' files are ignored"),
            clEnumValN(FilesystemCompileArgs, "filesystem",
                       "All compile commands come from the "
                       "'compile_commands.json' files")),
     init(FilesystemCompileArgs),
     Hidden,
 };
 
-static opt<bool> EnableFunctionArgSnippets{
+opt<bool> EnableFunctionArgSnippets{
     "function-arg-placeholders",
+    cat(Features),
     desc("When disabled, completions contain only parentheses for "
          "function calls. When enabled, completions also contain "
          "placeholders for method parameters"),
     init(CodeCompleteOptions().EnableFunctionArgSnippets),
     Hidden,
 };
 
-static opt<std::string> ClangTidyChecks{
+opt<std::string> ClangTidyChecks{
     "clang-tidy-checks",
+    cat(Features),
     desc("List of clang-tidy checks to run (this will override "
          ".clang-tidy files). Only meaningful when -clang-tidy flag is on"),
     init(""),
 };
 
-static opt<bool> EnableClangTidy{
+opt<bool> EnableClangTidy{
     "clang-tidy",
+    cat(Features),
     desc("Enable clang-tidy diagnostics"),
     init(true),
 };
 
-static opt<std::string> FallbackStyle{
+opt<std::string> FallbackStyle{
     "fallback-style",
+    cat(Features),
     desc("clang-format style to apply by default when "
          "no .clang-format file is found"),
     init(clang::format::DefaultFallbackStyle),
 };
 
-static opt<bool> SuggestMissingIncludes{
+opt<bool> SuggestMissingIncludes{
     "suggest-missing-includes",
+    cat(Features),
     desc("Attempts to fix diagnostic errors caused by missing "
          "includes using index"),
     init(true),
 };
 
-static opt<OffsetEncoding> ForceOffsetEncoding{
+opt<OffsetEncoding> ForceOffsetEncoding{
     "offset-encoding",
+    cat(Protocol),
     desc("Force the offsetEncoding used for character positions. "
          "This bypasses negotiation via client capabilities"),
     values(
         clEnumValN(OffsetEncoding::UTF8, "utf-8", "Offsets are in UTF-8 bytes"),
         clEnumValN(OffsetEncoding::UTF16, "utf-16",
                    "Offsets are in UTF-16 code units")),
     init(OffsetEncoding::UnsupportedEncoding),
 };
 
-static opt<CodeCompleteOptions::CodeCompletionParse> CodeCompletionParse{
+opt<CodeCompleteOptions::CodeCompletionParse> CodeCompletionParse{
     "completion-parse",
+    cat(Features),
     desc("Whether the clang-parser is used for code-completion"),
     values(clEnumValN(CodeCompleteOptions::AlwaysParse, "always",
                       "Block until the parser can be used"),
            clEnumValN(CodeCompleteOptions::ParseIfReady, "auto",
                       "Use text-based completion if the parser "
                       "is not ready"),
            clEnumValN(CodeCompleteOptions::NeverParse, "never",
                       "Always used text-based completion")),
     init(CodeCompleteOptions().RunParser),
     Hidden,
 };
 
-static opt<bool> HiddenFeatures{
+opt<bool> HiddenFeatures{
     "hidden-features",
+    cat(Features),
     desc("Enable hidden features mostly useful to clangd developers"),
     init(false),
     Hidden,
 };
 
-static list<std::string> QueryDriverGlobs{
+list<std::string> QueryDriverGlobs{
     "query-driver",
+    cat(CompileCommands),
     desc(
         "Comma separated list of globs for white-listing gcc-compatible "
         "drivers that are safe to execute. Drivers matching any of these globs "
         "will be used to extract system includes. e.g. "
         "/usr/bin/**/clang-*,/path/to/repo/**/g++-*"),
     CommaSeparated,
 };
 
-static list<std::string> TweakList{
+list<std::string> TweakList{
     "tweaks",
+    cat(Features),
     desc("Specify a list of Tweaks to enable (only for clangd developers)."),
     Hidden,
     CommaSeparated,
 };
 
-namespace {
-
 /// \brief Supports a test URI scheme with relaxed constraints for lit tests.
 /// The path in a test URI will be combined with a platform-specific fake
 /// directory to form an absolute path. For example, test:///a.cpp is resolved
 /// C:\clangd-test\a.cpp on Windows and /clangd-test/a.cpp on Unix.
 class TestScheme : public URIScheme {
 public:
   llvm::Expected<std::string>
   getAbsolutePath(llvm::StringRef /*Authority*/, llvm::StringRef Body,
int main(int argc, char *argv[]) {
   using namespace clang;
   using namespace clang::clangd;
 
   llvm::InitializeAllTargetInfos();
   llvm::sys::PrintStackTraceOnErrorSignal(argv[0]);
   llvm::cl::SetVersionPrinter([](llvm::raw_ostream &OS) {
     OS << clang::getClangToolFullVersion("clangd") << "\n";
   });
+  llvm::cl::HideUnrelatedOptions(ClangdCategories);
   llvm::cl::ParseCommandLineOptions(
       argc, argv,
       "clangd is a language server that provides IDE-like features to editors. "
       "\n\nIt should be used via an editor plugin rather than invoked "
       "directly. "
       "For more information, see:"
       "\n\thttps://clang.llvm.org/extra/clangd.html"
       "\n\thttps://microsoft.github.io/language-server-protocol/");