ReadProject Class

Summary

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).
Assembly
Wyam.CodeAnalysis.dll
Namespace
Wyam.CodeAnalysis
Interfaces
Base Types
graph BT Type-->Base0["ReadWorkspace"] click Base0 "/api/Wyam.CodeAnalysis/ReadWorkspace" Base0-->Base1["Object"] Type-.->Interface0["IModule"] click Interface0 "/api/Wyam.Common.Modules/IModule" Type-.->Interface1["IAsNewDocuments"] click Interface1 "/api/Wyam.Common.Modules/IAsNewDocuments" Type["ReadProject"] class Type type-node

Syntax

public class ReadProject : ReadWorkspace, IModule, IAsNewDocuments

Remarks

The output of this module is similar to executing the ReadFiles module on all source files in the project.

Constructors

Name Summary
ReadProject(DocumentConfig) Reads the project file at the specified path. This allows you to specify a different project file depending on the input.
ReadProject(FilePath) Reads the project file at the specified path.

Methods

Name Value Summary
Execute(IReadOnlyList<IDocument>, IExecutionContext) IEnumerable<IDocument>
This should not be called directly, instead call IExecutionContext.Execute() if you need to execute a module from within another module.
Inherited from ReadWorkspace
GetProjects(IExecutionContext, IFile) IEnumerable<Project>
Gets the projects in the workspace (solution or project).
WhereFile(Func<IFile, bool>) ReadWorkspace
Filters the source code file based on path.
Inherited from ReadWorkspace
WhereProject(Func<string, bool>) ReadWorkspace
Filters the project based on name.
Inherited from ReadWorkspace
WithExtensions(string[]) ReadWorkspace
Filters the source code files based on extension.
Inherited from ReadWorkspace
GitHub