Interface IProject

Namespace

NDepend.Project

Assembly

NDepend.API.dll

Represents an NDepend project, with all its settings readable and writable.

public interface IProject

Extension Methods

ExtensionMethodsProjectAnalysis.BuildAnalysisResultRefFor(IProject, IAbsoluteFilePath)

ExtensionMethodsProjectAnalysis.CanAllPathsReferencedBeResolvedAsAbsolute(IProject)

ExtensionMethodsProjectAnalysis.GetAvailableAnalysisResultsRefs(IProject)

ExtensionMethodsProjectAnalysis.GetAvailableAnalysisResultsRefsGroupedPerMonth(IProject)

ExtensionMethodsProjectAnalysis.LoadAnalysisResultFromFile(IProject, IAbsoluteFilePath)

ExtensionMethodsProjectAnalysis.LogTrendMetrics(IProject, IReadOnlyList<MetricValue>, string, DateTime)

ExtensionMethodsProjectAnalysis.RunAnalysis(IProject, Action<IAnalysisLog>, Action<IProgressLog>, string)

ExtensionMethodsProjectAnalysis.RunAnalysis(IProject, string)

ExtensionMethodsProjectAnalysis.RunAnalysisAndBuildReport(IProject, Action<IAnalysisLog>, Action<IProgressLog>, string)

ExtensionMethodsProjectAnalysis.RunAnalysisAndBuildReport(IProject, string)

ExtensionMethodsProjectAnalysis.TryComputeLogLabel(IProject, ICodeBase, out string)

ExtensionMethodsProjectAnalysis.TryGetMostRecentAnalysisResultRef(IProject, out IAnalysisResultRef)

ExtensionMethodsEnumerable.Concat<TElement>(TElement, IEnumerable<TElement>)

ExtensionMethodsEnumerable.ToEnumerable<TElement>(TElement)

ExtensionMethodsProject.GetDefaultOutputDirectoryAbsolutePath(IProject)

ExtensionMethodsProject.GetOutputDirectoryAbsolutePath(IProject)

ExtensionMethodsProject.GetRulesInProjectFileAndInRuleFiles(IProject)

ExtensionMethodsProject.GetRulesInProjectFileAndInRuleFilesAndDeclaredInSourceCode(IProject, IGroup)

ExtensionMethodsProject.GetRulesInProjectFileAndInRuleFilesAndDeclaredInSourceCodeAndImported(IProject, IGroup, IRuleIssues[])

ExtensionMethodsProject.TryLoadRuleFile(IProject, IRuleFileRef, out IGroup, out string)

ExtensionMethodsProject.TryResolveAbsolutePathFromProject(IProject, IDirectoryPath, out IAbsoluteDirectoryPath)

ExtensionMethodsProject.TryResolveAbsolutePathFromProject(IProject, IDirectoryPath, out IAbsoluteDirectoryPath, out string)

ExtensionMethodsProject.TryResolveAbsolutePathFromProject(IProject, IFilePath, out IAbsoluteFilePath)

ExtensionMethodsProject.TryResolveAbsolutePathFromProject(IProject, IFilePath, out IAbsoluteFilePath, out string)

ExtensionMethodsProject.TryResolveAbsolutePathFromProject(IProject, IPath, out IAbsolutePath)

ExtensionMethodsProject.TryResolveAbsolutePathFromProject(IProject, IPath, out IAbsolutePath, out string)

ExtensionMethodsProject.TrySaveRuleFile(IProject, IRuleFileRef, IGroup, out string)

ExtensionMethodsMisc.ToNullableDouble(object)

Remarks

IProjectManager presents methods to create, load and save an NDepend project.

Properties (17)

BaselineDuringAnalysis

Represents settings of this NDepend project concerning the baseline eventually used during analysis.

IProjectBaseline BaselineDuringAnalysis { get; }

Property Value

IProjectBaseline

BaselineInUI

Represents settings of this NDepend project concerning the baseline eventually used in NDepend user interface (VisualNDepend or VisualStudio addin).

IProjectBaseline BaselineInUI { get; }

Property Value

IProjectBaseline

CodeQueries

Represents this NDepend project code queries and code rules.

IProjectCodeQueries CodeQueries { get; }

Property Value

IProjectCodeQueries

See Also

NDepend.CodeQuery

CodeToAnalyze

Represents this NDepend project assemblies to analyze.

IProjectCodeToAnalyze CodeToAnalyze { get; }

Property Value

IProjectCodeToAnalyze

Coverage

Represents settings of this NDepend project concerning code coverage file(s) to load to obtain code coverage metrics.

IProjectCoverage Coverage { get; }

Property Value

IProjectCoverage

See Also

PercentageCoverage

NbLinesOfCodeCovered

NbLinesOfCodeNotCovered

PercentageBranchCoverage

DebtSettings

Represents the debt settings of this project.

IProjectDebtSettings DebtSettings { get; }

Property Value

IProjectDebtSettings

DisabledWarnings

Represents the collection of analysis warnings disabled, of this NDepend project.

IProjectDisabledWarnings DisabledWarnings { get; }

Property Value

IProjectDisabledWarnings

Github

Represents this NDepend project Github settings.

IProjectGithub Github { get; }

Property Value

IProjectGithub

GraphFiles

Represents the list of graph files referenced by this project.

IProjectGraphFiles GraphFiles { get; }

Property Value

IProjectGraphFiles

HistoricAnalysisResult

Represents this NDepend project's settings relative to Historic Analysis Results storage.

IProjectHistoricAnalysisResult HistoricAnalysisResult { get; }

Property Value

IProjectHistoricAnalysisResult

IssueImport

Represents the issue import settings of this project.

IProjectIssueImport IssueImport { get; }

Property Value

IProjectIssueImport

PathVariables

Represents this NDepend project path variables collection.

IProjectPathVariables PathVariables { get; }

Property Value

IProjectPathVariables

Properties

Represents this NDepend project main properties.

IProjectProperties Properties { get; }

Property Value

IProjectProperties

Report

Represents settings of this NDepend project concerning report.

IProjectReport Report { get; }

Property Value

IProjectReport

RuleFiles

Represents the list of rule files referenced by this project.

IProjectRuleFiles RuleFiles { get; }

Property Value

IProjectRuleFiles

SourceFilesRebasing

Represents this NDepend project source files rebasing settings.

IProjectSourceFilesRebasing SourceFilesRebasing { get; }

Property Value

IProjectSourceFilesRebasing

Remarks

SourceFilesRebasing is useful if the analysis results are produced on a machine, but used from another machine, where source file are nested in a different root directory.
Hence source files rebasing settings are used to rebase source files paths.

See Also

SourceDecls

SourceFileDeclAvailable

Trend

Represents this NDepend project's settings relative to trend metrics log and diagrams displayed.

IProjectTrend Trend { get; }

Property Value

IProjectTrend

Method (1)

GetProjectRef(DateTime)

Gets a reference to this NDepend project, with IProjectRef.DateLastTouched equals to dateLastTouched.

IProjectRef GetProjectRef(DateTime dateLastTouched)

Parameters

dateLastTouched DateTime

The IProjectRef.DateLastTouched of the returned NDepend project reference.

Returns

IProjectRef

Event (1)

SettingsChanged

This event is triggered each time some settings of this NDepend project are changed.

event Action<IProject, ProjectSettings> SettingsChanged

Event Type

Action<IProject, ProjectSettings>

Remarks

The settings changed are listed through the ProjectSettings flags.