Table of Contents

Interface IProjectIssueImport

Namespace
NDepend.Project
Assembly
NDepend.API.dll

Represents settings of an NDepend project concerning the issue import from other tools.

public interface IProjectIssueImport
Extension Methods

Properties (3)

Directories

Gets a read-only list of directories paths where to search for files that contains issues to import.

IReadOnlyList<IDirectoryPath> Directories { get; }

Property Value

IReadOnlyList<IDirectoryPath>

Remarks

The list returned is a read-only clone. Hence, it doesn't reflect any modification in the original collection.
If ResolveSarifInSolutionDirectories is true, the returned list also contains directories named .sarif eventually resolved from solution files referenced by this project.

DirectoriesAbsolute

Gets a read-only list of absolute directories paths where to search for files that contains issues to import.

IReadOnlyList<IAbsoluteDirectoryPath> DirectoriesAbsolute { get; }

Property Value

IReadOnlyList<IAbsoluteDirectoryPath>

Remarks

Return a read-only list of Directories resolved as absolute, in the context of the current machine and the current project.
In this situation, if a directory cannot be resolved to absolute (like for example the relative directory "....\Dir0" cannot be resolved from "C:\Dir1\Project.ndproj"), it doesn't appear in the returned collection of paths.
The list returned is a read-only clone. Hence, it doesn't reflect any modification in the original collection.

ResolveSarifInSolutionDirectories

If this flag is true, when a directory named .sarif is located in a directory containing a solution file referenced by this project, DirectoriesAbsolute returns it.

bool ResolveSarifInSolutionDirectories { get; set; }

Property Value

bool

Remarks

This flag is true per default.

Method (1)

SetAllDirectories(IEnumerable<IDirectoryPath>)

Force set the list of directories where to search for files that contains issues to import. Make sure that all directories are in a coherent absolute/relative path mode, else an incoherent state can occurs. Notice that directories containing .NET Framework assemblies are never relative.

void SetAllDirectories(IEnumerable<IDirectoryPath> directories)

Parameters

directories IEnumerable<IDirectoryPath>

The directory path to add.