Reads an MSBuild solution or project file and returns all referenced source files as documents.
This module will be executed once and input documents will be ignored if a search path is
specified. Otherwise, if a delegate is specified the module will be executed once per input
document and the resulting output documents will be aggregated.
- Namespace
- Statiq
.CodeAnalysis - Interfaces
- Base Types
- Derived Types
graph BT
Type-->Base0["ParallelSyncConfigModule<NormalizedPath>"]
Base0-->Base1["ParallelConfigModule<NormalizedPath>"]
Base1-->Base2["Module"]
click Base2 "/api/Statiq.Common/Module"
Base2-->Base3["object"]
Type-.->Interface0["IModule"]
click Interface0 "/api/Statiq.Common/IModule"
Type-.->Interface1["IParallelModule"]
click Interface1 "/api/Statiq.Common/IParallelModule"
Type["ReadWorkspace"]
class Type type-node
Derived0["ReadSolution"]-->Type
click Derived0 "/api/Statiq.CodeAnalysis/ReadSolution"
Derived1["ReadProject"]-->Type
click Derived1 "/api/Statiq.CodeAnalysis/ReadProject"
Syntax
public abstract class ReadWorkspace : ParallelSyncConfigModule<NormalizedPath>, IModule,
IParallelModuleConstructors
| Name | Summary |
|---|---|
| ReadWorkspace |
Methods
| Name | Return Value | Summary |
|---|---|---|
| AfterExecution |
void |
Called after each module execution.
Inherited from Module
|
| AfterExecutionAsync |
Task |
Called after each module execution.
Inherited from Module
|
| BeforeExecution |
void |
Called before each module execution.
Inherited from Module
|
| BeforeExecutionAsync |
Task |
Called before each module execution.
Inherited from Module
|
| ExecuteAsync |
Task |
This should not be called directly, instead call
IExecutionContext.Execute() if you need to execute a module from within another module.
Inherited from Module
|
| ExecuteConfig |
IEnumerable |
|
| Finally |
void |
Called after each module execution, even if an exception is thrown during execution.
Inherited from Module
|
| FinallyAsync |
Task |
Called after each module execution, even if an exception is thrown during execution.
Inherited from Module
|
| GetProjects |
IEnumerable |
Gets the projects in the workspace (solution or project).
|
| WhereFile |
ReadWorkspace |
Filters the source code file based on path.
|
| WhereProject |
ReadWorkspace |
Filters the project based on name.
|
| WithExtensions |
ReadWorkspace |
Filters the source code files based on extension.
|