Interface IProjectList

List of projects

Namespace: BuildSystem.ProjectList

Assembly: BuildSystem.ManagerObject.Interfaces.dll

Syntax

public interface IProjectList : IList<IProject>, ICollection<IProject>, IEnumerable<IProject>, IEnumerable

Properties

Analyzer

Fills dependencies between projects

Declaration

IAnalyzer? Analyzer { get; set; }

Property Value

Type	Description
IAnalyzer

BuildInfoSaver

Save build information in some storage

Declaration

IBuildInfoSaver? BuildInfoSaver { get; set; }

Property Value

Type	Description
IBuildInfoSaver

Compiler

Proceeds stateless tasks, which should help to build projects

Declaration

ICompiler? Compiler { get; set; }

Property Value

Type	Description
ICompiler

CopierBuildResults

Object to copy build results of dependency project into parent project

Declaration

ICopierBuildResults? CopierBuildResults { get; set; }

Property Value

Type	Description
ICopierBuildResults

Deployer

Object to execute some tasks for deploying packages of projects

Declaration

IDeployer? Deployer { get; set; }

Property Value

Type	Description
IDeployer

ManagersFactory

Factory for generating global managing objects. Their setting set not for project but for whole build space

Declaration

IManagersFactory? ManagersFactory { get; set; }

Property Value

Type	Description
IManagersFactory

ProjectRestorer

Object to restore projects by downloading their packages from repository

Declaration

IProjectRestorer? ProjectRestorer { get; set; }

Property Value

Type	Description
IProjectRestorer

Props

Properties of project list

Declaration

IProjectListProps Props { get; }

Property Value

Type	Description
IProjectListProps

SourceHashCalculator

Calculates hash of source files with some specific logic

Declaration

ISourceHashCalculator? SourceHashCalculator { get; set; }

Property Value

Type	Description
ISourceHashCalculator

VariantList

List of configuration of build space

Declaration

VariantList? VariantList { get; set; }

Property Value

Type	Description
VariantList

Methods

AnalyzeProjects()

Analyze projects and fill some properties of IProject

Declaration

void AnalyzeProjects()

Clean(string, ProjectFilter?)

Calls Clean(string) to each project

Declaration

void Clean(string variantName, ProjectFilter? filter = null)

Parameters

Type	Name	Description
string	variantName	Environment params
ProjectFilter	filter	Filtering processed projects

Compile(string, bool, ProjectFilter?)

Build project

Declaration

void Compile(string variantName, bool breakOnError = false, ProjectFilter? filter = null)

Parameters

Type	Name	Description
string	variantName	Environment params
bool	breakOnError	Break compilation if an error found
ProjectFilter	filter	Filtering processed projects

Deploy(string, bool, ProjectFilter?)

Creates packages and then pushed them

Declaration

bool Deploy(string variantName, bool onlyCreate = false, ProjectFilter? filter = null)

Parameters

Type	Name	Description
string	variantName	Environment params
bool	onlyCreate	No need in push
ProjectFilter	filter	Filtering processed projects

Returns

Type	Description
bool	Flag, that everything is ok

FirstOrDefaultByJsonPath(string)

Search project in self list - path to JSON file with settings should be the same as in input param

Declaration

IProject? FirstOrDefaultByJsonPath(string jsonPath)

Parameters

Type	Name	Description
string	jsonPath	Path to JSON file with settings

Returns

Type	Description
IProject

FirstOrDefaultByProjectPath(string)

Search project in self list - path to main project file should be the same as in input param

Declaration

IProject? FirstOrDefaultByProjectPath(string projectPath)

Parameters

Type	Name	Description
string	projectPath	Path to main project file

Returns

Type	Description
IProject

GenDoc(string, ProjectFilter?)

Generate HTML documentation per each project

Declaration

void GenDoc(string variantName, ProjectFilter? filter = null)

Parameters

Type	Name	Description
string	variantName	Environment params
ProjectFilter	filter	Filtering processed projects

GenProjectDependsGraph(string, ProjectFilter?)

Generates a dependency graph of build system projects in .dot format

Declaration

void GenProjectDependsGraph(string fileName, ProjectFilter? filter = null)

Parameters

Type	Name	Description
string	fileName	Path to resulting .dot file
ProjectFilter	filter	Project filtering

GetBuildResultPaths(string, ProjectFilter?)

Calls GetBuildResultPath(string, string) to each project

Declaration

List<string> GetBuildResultPaths(string variantName, ProjectFilter? filter = null)

Parameters

Type	Name	Description
string	variantName	Environment params
ProjectFilter	filter	Filtering processed projects

Returns

Type	Description
System.Collections.Generic.List<><string>	Flag that everything is ok

Restore(string, ProjectFilter?)

Restore current project list dependencies

Declaration

void Restore(string variantName, ProjectFilter? filter = null)

Parameters

Type	Name	Description
string	variantName	Environment params
ProjectFilter	filter	Filter for projects, which dependencies should be restored. If null, all project dependencies will be restored.

RunTests(string, ProjectFilter?)

Run unit testing for each project

Declaration

bool RunTests(string variantName, ProjectFilter? filter = null)

Parameters

Type	Name	Description
string	variantName	Environment params
ProjectFilter	filter	Filtering processed projects

Returns

Type	Description
bool	False, if at least one test failed

Sign(string, ProjectFilter?)

Calls Sign(string) to each project

Declaration

bool Sign(string variantName, ProjectFilter? filter = null)

Parameters

Type	Name	Description
string	variantName	Environment params
ProjectFilter	filter	Filtering processed projects

Returns

Type	Description
bool	Flag, that everything is ok