Reads all the source files from a specified MSBuild project.
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.
Note that this requires the MSBuild tools to be installed (included with Visual Studio).
- Namespace
- Statiq
.CodeAnalysis - Interfaces
- Base Types
graph BT
Type-->Base0["ReadWorkspace"]
click Base0 "/api/Statiq.CodeAnalysis/ReadWorkspace"
Base0-->Base1["ParallelSyncConfigModule<NormalizedPath>"]
Base1-->Base2["ParallelConfigModule<NormalizedPath>"]
Base2-->Base3["Module"]
click Base3 "/api/Statiq.Common/Module"
Base3-->Base4["object"]
Type-.->Interface0["IModule"]
click Interface0 "/api/Statiq.Common/IModule"
Type-.->Interface1["IParallelModule"]
click Interface1 "/api/Statiq.Common/IParallelModule"
Type["ReadProject"]
class Type type-node
Syntax
public class ReadProject : ReadWorkspace, IModule, IParallelModuleRemarks
The output of this module is similar to executing the ReadFiles module on all source files in the project.
Constructors
| Name | Summary |
|---|---|
| ReadProject |
Reads the project file at the specified path. This allows you to specify a different project file depending on the input. |
| ReadProject |
Reads the project file at the specified path. This allows you to specify a different project file depending on the input. |
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 |
Inherited from ReadWorkspace
|
| 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.
Inherited from ReadWorkspace
|
| WhereProject |
ReadWorkspace |
Filters the project based on name.
Inherited from ReadWorkspace
|
| WithExtensions |
ReadWorkspace |
Filters the source code files based on extension.
Inherited from ReadWorkspace
|