Skip to content

Add config file support #10

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Ben McMorran (benmcmorran) merged 3 commits into from
Jul 20, 2026
Merged

Add config file support #10

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
bc3824f
Add JSON config-file support (--config + auto-discovered msbuild-extr…
itodirel Jul 6, 2026
c7ff1e4
update readme and add example json for a commited msbuild-extractor.json
gcampbell-msft Jul 20, 2026
babdf68
add back verifier for rich format
gcampbell-msft Jul 20, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
118 changes: 86 additions & 32 deletions CommandLineOptions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,128 +38,147 @@ public class CommandLineOptions
public string MsBuildLauncher { get; set; } = "auto";
public string IncludePathOrder { get; set; } = "auto";

/// <summary>Path to the JSON config file that supplied defaults, or null if none was used.</summary>
public string? ConfigPath { get; set; }

public static CommandLineOptions Parse(string[] args)
{
CommandLineOptions? result = null;

// Load an optional config file; its values become the defaults for the options built
// below, so anything passed on the command line still wins. config stays null when no
// config file is present.
Config? config = new Config();
if (!config.Load(args))
config = null;

var projectOption = new Option<string[]>("--project", "-p")
{
Description = "Path to .vcxproj file (can be specified multiple times)",
AllowMultipleArgumentsPerToken = true
AllowMultipleArgumentsPerToken = true,
DefaultValueFactory = _ => config?.Projects ?? []
};

var solutionOption = new Option<string[]>("--solution", "-s")
{
Description = "Path to .sln or .slnx file (can be specified multiple times)",
AllowMultipleArgumentsPerToken = true
AllowMultipleArgumentsPerToken = true,
DefaultValueFactory = _ => config?.Solutions ?? []
};

var configOption = new Option<string>("--configuration", "-c")
{
Description = "Build configuration",
DefaultValueFactory = _ => "Debug"
DefaultValueFactory = _ => config?.Configuration ?? "Debug"
};

var platformOption = new Option<string>("--platform", "-a")
{
Description = "Build platform",
DefaultValueFactory = _ => "x64"
DefaultValueFactory = _ => config?.Platform ?? "x64"
};

var vsPathOption = new Option<string?>("--vs-path")
{
Description = "Path to Visual Studio installation"
Description = "Path to Visual Studio installation",
DefaultValueFactory = _ => config?.VsPath
};

var vcTargetsPathOption = new Option<string?>("--vc-targets-path")
{
Description = "Path to VC targets (e.g. ...\\MSBuild\\Microsoft\\VC\\v180)"
Description = "Path to VC targets (e.g. ...\\MSBuild\\Microsoft\\VC\\v180)",
DefaultValueFactory = _ => config?.VcTargetsPath
};

var clPathOption = new Option<string?>("--cl-path")
{
Description = "Path to cl.exe"
Description = "Path to cl.exe",
DefaultValueFactory = _ => config?.ClPath
};

var solutionDirOption = new Option<string?>("--solution-dir")
{
Description = "Value for the SolutionDir MSBuild property (auto-derived when using --solution)"
Description = "Value for the SolutionDir MSBuild property (auto-derived when using --solution)",
DefaultValueFactory = _ => config?.SolutionDir
};

var vcToolsInstallDirOption = new Option<string?>("--vc-tools-install-dir")
{
Description = "Value for the VCToolsInstallDir MSBuild property"
Description = "Value for the VCToolsInstallDir MSBuild property",
DefaultValueFactory = _ => config?.VcToolsInstallDir
};

var outputOption = new Option<string?>("--output", "-o")
{
Description = "Output path for compile_commands.json"
Description = "Output path for compile_commands.json",
DefaultValueFactory = _ => config?.Output
};

var loggerOption = new Option<bool>("--logger")
{
Description = "Enable MSBuild console logger output",
DefaultValueFactory = _ => false
DefaultValueFactory = _ => config?.Logger ?? false
};

var useDevEnvOption = new Option<bool>("--use-dev-env")
{
Description = "Read environment variables from Developer Command Prompt (VCToolsInstallDir, VCTargetsPath, etc.)",
DefaultValueFactory = _ => false
DefaultValueFactory = _ => config?.UseDevEnv ?? false
};

var msbuildPathOption = new Option<string?>("--msbuild-path")
{
Description = "Path to msbuild.exe (enables out-of-process mode for custom MSBuild/toolchain locations)"
Description = "Path to msbuild.exe (enables out-of-process mode for custom MSBuild/toolchain locations)",
DefaultValueFactory = _ => config?.MsBuildPath
};

var allConfigsOption = new Option<bool>("--all-configurations")
{
Description = "Extract for all configuration/platform combinations found in the project or solution",
DefaultValueFactory = _ => false
DefaultValueFactory = _ => config?.AllConfigurations ?? false
};

var mergeOption = new Option<bool>("--merge")
{
Description = "Merge all configurations into a single output file (use with --all-configurations)",
DefaultValueFactory = _ => false
DefaultValueFactory = _ => config?.Merge ?? false
};

var strictOption = new Option<bool>("--strict")
{
Description = "Treat configuration/platform validation warnings as errors",
DefaultValueFactory = _ => false
DefaultValueFactory = _ => config?.Strict ?? false
};

var validateOption = new Option<bool>("--validate")
{
Description = "After extraction, verify each compile command by running cl.exe /c",
DefaultValueFactory = _ => false
DefaultValueFactory = _ => config?.Validate ?? false
};

var formatOption = new Option<string>("--format", "-f")
{
Description = "Output format: 'standard' (compile_commands.json) or 'rich' (hierarchical compile_database.json)",
DefaultValueFactory = _ => "standard"
DefaultValueFactory = _ => config?.Format ?? "standard"
};
formatOption.AcceptOnlyFromAmong("standard", "rich");

var deduplicateOption = new Option<bool>("--deduplicate")
{
Description = "Merge duplicate entries for the same file into one best-compromise entry for IntelliSense",
DefaultValueFactory = _ => false
DefaultValueFactory = _ => config?.Deduplicate ?? false
};

var preferConfigOption = new Option<string>("--prefer-configuration")
{
Description = "Preferred configuration for conflict resolution during deduplication (default: Debug)",
DefaultValueFactory = _ => "Debug"
DefaultValueFactory = _ => config?.PreferConfiguration ?? "Debug"
};

var preferPlatformOption = new Option<string>("--prefer-platform")
{
Description = "Preferred platform for conflict resolution during deduplication (default: x64)",
DefaultValueFactory = _ => "x64"
DefaultValueFactory = _ => config?.PreferPlatform ?? "x64"
};

var listInstancesOption = new Option<bool>("--list-instances", "--list-vs")
Expand All @@ -169,25 +188,26 @@ public static CommandLineOptions Parse(string[] args)

var vsInstanceOption = new Option<string?>("--vs-instance")
{
Description = "Select VS installation by instance ID (use --list-instances to see available)"
Description = "Select VS installation by instance ID (use --list-instances to see available)",
DefaultValueFactory = _ => config?.VsInstance
};

var cCppPropertiesOption = new Option<bool>("--c-cpp-properties")
{
Description = "Emit a .vscode/c_cpp_properties.json pointing to the generated compile_commands.json",
DefaultValueFactory = _ => false
DefaultValueFactory = _ => config?.EmitCCppProperties ?? false
};

var emitDefaultsOption = new Option<bool>("--emit-defaults")
{
Description = "Include the project-wide default compile entry in the output (synthetic __project_defaults.cpp with the baseline switches for the project)",
DefaultValueFactory = _ => false
DefaultValueFactory = _ => config?.EmitDefaults ?? false
};

var mergeDefaultsOption = new Option<bool>("--merge-defaults")
{
Description = "Merge project-wide default switches (defines, language standard, warning level, etc.) into each per-file entry when they are not already present",
DefaultValueFactory = _ => false
DefaultValueFactory = _ => config?.MergeDefaults ?? false
};

var msbuildPropertyOption = new Option<string[]>("--msbuild-property")
Expand All @@ -205,17 +225,22 @@ public static CommandLineOptions Parse(string[] args)
var msbuildLauncherOption = new Option<string>("--msbuild-launcher")
{
Description = "How to launch MSBuild: auto (sniff extension, default), cmd (force cmd.exe /c wrapper), direct (run executable directly), dotnet (force dotnet exec)",
DefaultValueFactory = _ => "auto"
DefaultValueFactory = _ => config?.MsBuildLauncher ?? "auto"
};
msbuildLauncherOption.AcceptOnlyFromAmong("auto", "cmd", "direct", "dotnet");

var includePathOrderOption = new Option<string>("--include-path-order")
{
Description = "Where to place include paths from MSBuild's IncludePath/ExternalIncludePath properties: auto (per-path heuristic, default), prepend (before /I), append (after /I, matches cl.exe INCLUDE-env semantics)",
DefaultValueFactory = _ => "auto"
DefaultValueFactory = _ => config?.IncludePathOrder ?? "auto"
};
includePathOrderOption.AcceptOnlyFromAmong("auto", "prepend", "append");

var configFileOption = new Option<string?>("--config")
{
Description = "Path to a JSON config file supplying option defaults. When omitted, a 'msbuild-extractor.json' in the current directory is used automatically if present. Command-line options override values from the file."
};

var rootCommand = new RootCommand("Extract compile_commands.json from Visual C++ MSBuild projects");
rootCommand.Options.Add(projectOption);
rootCommand.Options.Add(solutionOption);
Expand Down Expand Up @@ -247,6 +272,7 @@ public static CommandLineOptions Parse(string[] args)
rootCommand.Options.Add(msbuildEnvOption);
rootCommand.Options.Add(msbuildLauncherOption);
rootCommand.Options.Add(includePathOrderOption);
rootCommand.Options.Add(configFileOption);

rootCommand.Validators.Add(commandResult =>
{
Expand All @@ -257,8 +283,12 @@ public static CommandLineOptions Parse(string[] args)
var projects = commandResult.GetValue(projectOption) ?? [];
var solutions = commandResult.GetValue(solutionOption) ?? [];

if (projects.Length == 0 && solutions.Length == 0)
commandResult.AddError("At least one --project or --solution must be specified.");
// Inputs may also come from the config file. A validator cannot see values produced
// by an option's DefaultValueFactory, so read them from the config directly.
var hasConfigInputs = (config?.Projects?.Length ?? 0) > 0 || (config?.Solutions?.Length ?? 0) > 0;

if (projects.Length == 0 && solutions.Length == 0 && !hasConfigInputs)
commandResult.AddError("At least one --project or --solution must be specified (via the command line or a config file).");

if (commandResult.GetValue(cCppPropertiesOption) && commandResult.GetValue(formatOption) == "rich")
Comment thread
gcampbell-msft marked this conversation as resolved.
commandResult.AddError("--c-cpp-properties cannot be used with --format rich (rich format does not produce compile_commands.json).");
Expand Down Expand Up @@ -294,11 +324,23 @@ public static CommandLineOptions Parse(string[] args)
EmitCCppProperties = parseResult.GetValue(cCppPropertiesOption),
EmitDefaults = parseResult.GetValue(emitDefaultsOption),
MergeDefaults = parseResult.GetValue(mergeDefaultsOption),
MsBuildProperties = ParseKeyValuePairs(parseResult.GetValue(msbuildPropertyOption), "--msbuild-property"),
MsBuildEnv = ParseKeyValuePairs(parseResult.GetValue(msbuildEnvOption), "--msbuild-env"),
MsBuildProperties = MergeKeyValues(config?.MsBuildProperties,
ParseKeyValuePairs(parseResult.GetValue(msbuildPropertyOption), "--msbuild-property")),
MsBuildEnv = MergeKeyValues(config?.MsBuildEnv,
ParseKeyValuePairs(parseResult.GetValue(msbuildEnvOption), "--msbuild-env")),
MsBuildLauncher = parseResult.GetValue(msbuildLauncherOption)!,
IncludePathOrder = parseResult.GetValue(includePathOrderOption)!
IncludePathOrder = parseResult.GetValue(includePathOrderOption)!,
ConfigPath = config?.SourcePath
};

// Re-check option combinations against the effective (merged) values. As with the
// input check above, a validator cannot see config-supplied defaults, so a
// config-only "rich + c-cpp-properties" clash would otherwise slip through.
if (result.EmitCCppProperties && result.Format == "rich")
{
Console.Error.WriteLine("Error: --c-cpp-properties / \"emitCCppProperties\" cannot be used with the 'rich' format (rich format does not produce compile_commands.json).");
Environment.Exit(1);
}
});

var exitCode = rootCommand.Parse(args).Invoke();
Expand All @@ -322,5 +364,17 @@ private static Dictionary<string, string> ParseKeyValuePairs(string[]? values, s
}
return dict;
}

private static Dictionary<string, string> MergeKeyValues(
Dictionary<string, string>? fromConfig, Dictionary<string, string> fromCommandLine)
{
var merged = new Dictionary<string, string>(StringComparer.OrdinalIgnoreCase);
if (fromConfig != null)
foreach (var kvp in fromConfig)
merged[kvp.Key] = kvp.Value;
foreach (var kvp in fromCommandLine)
merged[kvp.Key] = kvp.Value;
return merged;
}
}
}
Loading
Loading