RoslynScriptSession Class

Summary

Represents a Roslyn-based script session for Cake.

Namespace

Cake.Infrastructure.Scripting

Interfaces

IScriptSession

Base Types

object

graph BT Type-->Base0["object"] Type-.->Interface0["IScriptSession"] click Interface0 "/api/Cake.Core.Scripting/IScriptSession" Type["RoslynScriptSession"] class Type type-node

Syntax

public sealed class RoslynScriptSession : IScriptSession

Constructors

Name	Summary
RoslynScriptSession(IScriptHost, IAssemblyLoader, ICakeConfiguration, ICakeLog, IScriptHostSettings)	Initializes a new instance of the `RoslynScriptSession` class.

Properties

Name	Value	Summary
Namespaces	HashSet<string>	Gets the namespaces.
ReferencePaths	HashSet<FilePath>	Gets the reference paths.
References	HashSet<Assembly>	Gets the references.

Methods

Name	Value	Summary
AddReference(Assembly)	void	Adds an assembly reference.
AddReference(FilePath)	void	Adds a reference from the specified file path.
Execute(Script)	void	Executes the specified script.
GetScriptHash(Script)	string	Gets the hash for the specified script.
ImportNamespace(string)	void	Imports a namespace.

Extension Methods

Name	Value	Summary
Dump<RoslynScriptSession>()	string	Get a basic string representation of specified object. From LoggingExtensions Requires the Cake.Incubator addin
IsIn<RoslynScriptSession>(RoslynScriptSession[])	bool	Checks if the source is contained in a list From EnumerableExtensions Requires the Cake.Incubator addin
NotNull<RoslynScriptSession>(string)	void	Throws an exception if the specified parameter's value is null. From Extensions Requires the Cake.Ftp addin
NotNull<RoslynScriptSession>(string)	void	Throws an exception if the specified parameter's value is null. From IssuesArgumentChecks Requires the Cake.Issues addin
ThrowIfNull<RoslynScriptSession>(string, string)	T	Throws a `System.ArgumentNullException` with a specific message if the value is null, otherwise returns the value From AssertExtensions Requires the Cake.Incubator addin
ThrowIfNull<RoslynScriptSession>(string)	T	Throws a `System.ArgumentNullException` if the value is null, otherwise returns the value From AssertExtensions Requires the Cake.Incubator addin
ToDictionary()	IDictionary<string, object>	From ObjectHelpers Requires the Cake.DeployParams addin
ToStringWithNullMarkup()	string	Returns the string value or a `Not set`> markup suitable for Spectre.Console. From StringExtensions Requires the Cake.Issues addin