C# Parameters
NuGet
For more information regarding NuGet integration, refer here.
Configuration File Parameter | Description and Expected Behavior | If True | If False | Default | Command Line Parameter Available? |
---|---|---|---|---|---|
nuget.resolveDependencies | Whether to resolve NuGet packages.config and .csproj files. | Resolves NuGet packages.config and .csproj files. | Will not resolve NuGet packages.config and .csproj files. | True | No |
nuget.resolvePackagesConfigFiles | Whether to resolve NOTE: In order for this parameter's value to impact the scan, the parameter nuget.resolveDependencies must be set to True. | Resolves | Will not resolve | True | No |
nuget.resolveCsProjFiles | Whether to resolve NOTE: In order for this parameter's value to impact the scan, the parameter nuget.resolveDependencies must be set to True. | Resolves | Will not resolve | True | No |
nuget.preferredEnvironment | Defines the preferred NuGet restore command. Available values are nuget and dotnet. NOTE: This parameter will be used only if the nuget.runPreStep parameter is set to True. | N/A | N/A | No default | No |
nuget.packagesDirectory | Provide a custom Nuget cache folder to override the default global Nuget cache directory. If the NUGET_PACKAGES environment variable was set, the UA will use that to determine the Nuget cache path. In addition, if | N/A | N/A | No default | No |
nuget.ignoreSourceFiles | When using the dependency resolver, whether to include package dependencies or package dependencies + source files. NOTE: Only relevant when fileSystemScan is true. | Includes only package dependencies | Includes package dependencies and source files | True | No |
nuget.runPreStep | Whether to run nuget restore on found | Runs dotnet restore on csproj files and nuget restore on found packages.config files in order to download all dependencies to a temporary folder, scans this folder and deletes it after fetching the dependencies. | Will not run dotnet restore and nuget restore on found packages.config and csproj files. | False | No |
nuget.resolveNuspecFiles | Indicates whether to resolve NOTE: In order for this parameter's value to impact the scan, the parameter nuget.resolveDependencies must be set to True. | Resolves | Will not resolve | True | No |
nuget.resolveAssetsFiles | Resolves obj/project.assets.json file for new .NET dependency management structure. | N/A | N/A | True | No |
Paket
Configuration File Parameter | Description and Expected Behavior | If True | If False | Default | Command Line Parameter Available? |
---|---|---|---|---|---|
paket.resolveDependencies | Whether to resolve .NET dependencies using the Paket dependency manager. | Paket projects are resolved. | Paket projects will not be resolved. | True | No |
paket.ignoredGroups | Which Paket scopes to ignore. Values are comma/semi-colon/space delimited. GLOB patterns are supported, in addition to exact names. | N/A | N/A | Empty | No |
paket.ignoreSourceFiles | When using the Paket resolver, defines whether to ignore the .NET Paket files outside the packages folder. NOTE: Only relevant when fileSystemScan is true. | Will ignore files from scan, those which have extensions such as: .nupkg, .dll, .exe, .cs, .js | Will not ignore the mentioned file extensions. | True | No |
paket.runPreStep | Runs "paket install" on found Paket folder. | Will run the "paket install" command | Will not run the command. | False | No |
paket.exePath | The path to the paket.exe file used to run "paket install". | N/A | N/A | No default (empty) | No |