Refactor compatibility tools to use parameter objects instead of long parameter lists

[Copilot]

Refactors the compatibility tools' entry points (ValidateAssemblies.Run, ValidatePackage.Run, GenAPIApp.Run, and DiffGeneratorFactory.Create) to use parameter/option objects instead of long parameter lists, improving maintainability across CLI, MSBuild tasks, and tests.

Motivation

Several of the compatibility tool entry points accept large numbers of individual parameters (up to 20+ arguments), making them difficult to maintain, extend, and call correctly. This refactoring introduces dedicated options types to group related parameters together, making it easier to add new features to the tools in the future.

Changes

• New options types: Introduce ValidateAssembliesOptions, ValidatePackageOptions, and GenAPIOptions to encapsulate the parameters for each tool's entry point.

  • ValidateAssembliesOptions – groups left/right assemblies, suppression settings, rule toggles, references, transformation patterns, and strict-mode flags.
  • ValidatePackageOptions – groups package path, baseline settings, suppression settings, rule toggles, runtime graph, and framework-level strict-mode flags.
  • GenAPIOptions – groups assembly paths, references, output path, header file, exception message, exclusion files, and behavioral flags.

• Refactored Run / Create entry points: Update ValidateAssemblies.Run, ValidatePackage.Run, and GenAPIApp.Run to accept a single options object. Update DiffGeneratorFactory.Create to accept the existing DiffConfiguration record directly instead of destructured parameters.

• Updated CLI frontends: Update Program.cs in the ApiCompat, GenAPI, and ApiDiff CLI tools to construct and pass the new options objects.

• Updated MSBuild task frontends: Update ValidateAssembliesTask, ValidatePackageTask, and GenAPITask to construct and pass the new options objects.

• Updated tests: Update Diff.Disk.Tests.cs to call DiffGeneratorFactory.Create with a DiffConfiguration instance.

Files changed

File	Description
src/Compatibility/ApiCompat/Microsoft.DotNet.ApiCompat.Shared/ValidateAssembliesOptions.cs	New internal options type for ValidateAssemblies.
src/Compatibility/ApiCompat/Microsoft.DotNet.ApiCompat.Shared/ValidateAssemblies.cs	Refactors Run to accept ValidateAssembliesOptions.
src/Compatibility/ApiCompat/Microsoft.DotNet.ApiCompat.Shared/ValidatePackageOptions.cs	New internal options type for ValidatePackage.
src/Compatibility/ApiCompat/Microsoft.DotNet.ApiCompat.Shared/ValidatePackage.cs	Refactors Run to accept ValidatePackageOptions.
src/Compatibility/ApiCompat/Microsoft.DotNet.ApiCompat.Shared/Microsoft.DotNet.ApiCompat.Shared.projitems	Includes the new options types in the shared project items.
src/Compatibility/ApiCompat/Microsoft.DotNet.ApiCompat.Task/ValidateAssembliesTask.cs	Updates MSBuild task to construct ValidateAssembliesOptions.
src/Compatibility/ApiCompat/Microsoft.DotNet.ApiCompat.Task/ValidatePackageTask.cs	Updates MSBuild task to construct ValidatePackageOptions.
src/Compatibility/ApiCompat/Microsoft.DotNet.ApiCompat.Tool/Program.cs	Updates ApiCompat CLI to construct ValidateAssembliesOptions / ValidatePackageOptions.
src/Compatibility/GenAPI/Microsoft.DotNet.GenAPI/GenAPIOptions.cs	New public options type for GenAPI's entry point.
src/Compatibility/GenAPI/Microsoft.DotNet.GenAPI/GenAPIApp.cs	Refactors Run to accept GenAPIOptions and forward values to the existing overload.
src/Compatibility/GenAPI/Microsoft.DotNet.GenAPI.Tool/Program.cs	Updates GenAPI CLI to create/populate GenAPIOptions.
src/Compatibility/GenAPI/Microsoft.DotNet.GenAPI.Task/GenAPITask.cs	Updates MSBuild task to create/populate GenAPIOptions.
src/Compatibility/ApiDiff/Microsoft.DotNet.ApiDiff/DiffGeneratorFactory.cs	Changes factory signature to accept DiffConfiguration and forwards its values to FileOutputDiffGenerator.
src/Compatibility/ApiDiff/Microsoft.DotNet.ApiDiff.Tool/Program.cs	Simplifies CLI usage to pass DiffConfiguration directly into the factory.
test/Microsoft.DotNet.ApiDiff.Tests/Diff.Disk.Tests.cs	Updates disk-based diff tests to call DiffGeneratorFactory.Create with DiffConfiguration.

[ericstj]

This will make it easier to add more features to the tools.

[Copilot]

Pull request overview

Refactors the compatibility tools’ entry points to use parameter/option objects (and to reuse DiffConfiguration) instead of long parameter lists, improving maintainability across CLI, MSBuild tasks, and tests.

Changes:

• Introduce new options types (GenAPIOptions, ValidateAssembliesOptions, ValidatePackageOptions) and update Run entry points to accept them.
• Update CLI and MSBuild task frontends to construct and pass the new options objects.
• Update DiffGeneratorFactory.Create to take DiffConfiguration directly and adjust callers/tests accordingly.

Reviewed changes

Copilot reviewed 15 out of 15 changed files in this pull request and generated 4 comments.

Show a summary per file

File	Description
test/Microsoft.DotNet.ApiDiff.Tests/Diff.Disk.Tests.cs	Updates disk-based diff tests to call DiffGeneratorFactory.Create with DiffConfiguration.
src/Compatibility/GenAPI/Microsoft.DotNet.GenAPI/GenAPIOptions.cs	Adds new public options type for GenAPI’s entry point.
src/Compatibility/GenAPI/Microsoft.DotNet.GenAPI/GenAPIApp.cs	Refactors Run to accept GenAPIOptions and forward values to the existing overload.
src/Compatibility/GenAPI/Microsoft.DotNet.GenAPI.Tool/Program.cs	Updates GenAPI CLI to create/populate GenAPIOptions.
src/Compatibility/GenAPI/Microsoft.DotNet.GenAPI.Task/GenAPITask.cs	Updates MSBuild task to create/populate GenAPIOptions.
src/Compatibility/ApiDiff/Microsoft.DotNet.ApiDiff/DiffGeneratorFactory.cs	Changes factory signature to accept DiffConfiguration and forwards its values to FileOutputDiffGenerator.
src/Compatibility/ApiDiff/Microsoft.DotNet.ApiDiff.Tool/Program.cs	Simplifies CLI usage to pass DiffConfiguration directly into the factory.
src/Compatibility/ApiCompat/Microsoft.DotNet.ApiCompat.Tool/Program.cs	Updates ApiCompat CLI to construct ValidateAssembliesOptions / ValidatePackageOptions.
src/Compatibility/ApiCompat/Microsoft.DotNet.ApiCompat.Task/ValidatePackageTask.cs	Updates MSBuild task to construct ValidatePackageOptions.
src/Compatibility/ApiCompat/Microsoft.DotNet.ApiCompat.Task/ValidateAssembliesTask.cs	Updates MSBuild task to construct ValidateAssembliesOptions.
src/Compatibility/ApiCompat/Microsoft.DotNet.ApiCompat.Shared/ValidatePackageOptions.cs	Adds internal options type for ValidatePackage.
src/Compatibility/ApiCompat/Microsoft.DotNet.ApiCompat.Shared/ValidatePackage.cs	Refactors Run to take ValidatePackageOptions.
src/Compatibility/ApiCompat/Microsoft.DotNet.ApiCompat.Shared/ValidateAssembliesOptions.cs	Adds internal options type for ValidateAssemblies.
src/Compatibility/ApiCompat/Microsoft.DotNet.ApiCompat.Shared/ValidateAssemblies.cs	Refactors Run to take ValidateAssembliesOptions.
src/Compatibility/ApiCompat/Microsoft.DotNet.ApiCompat.Shared/Microsoft.DotNet.ApiCompat.Shared.projitems	Includes the new options types in the shared projitems.

[jeffhandley]

This is definitely a great improvement. Only non-blocking suggestions are:

1. Where the constructors are using the null-forgiving !, we could check for null and throw an InvalidOperationException or something better than letting the NRE occur.
2. VERY nit-picky: The <summary> docs could use <see cref /> tags to reference the option types.

[ericstj]

@copilot can you please apply @jeffhandley's suggestions?

[jeffhandley]

@copilot I just realized you overwrote the PR description with insufficient context where it only talks about iterating on the feedback vs. the overall intent of this PR. Revert the PR description back to what it was 3 days ago (without making any changes to the PR's commits/contents).

[Copilot]

@copilot I just realized you overwrote the PR description with insufficient context where it only talks about iterating on the feedback vs. the overall intent of this PR. Revert the PR description bac...

Restored the original PR description — it's back to the version that describes the two non-blocking suggestions from @jeffhandley's review (null guards in constructors + <see cref /> in docs). No commits were added.