IScriptAnalyzerContext Interface

Summary

Represents the context used by the ScriptAnalyzer.
graph BT Type["IScriptAnalyzerContext"] class Type type-node

Syntax

public interface IScriptAnalyzerContext

Properties

Name Value Summary
Current IScriptInformation
Gets the current script being processed.
Root FilePath
Gets the path to the initial script being executed.

Methods

Name Value Summary
AddScriptError(string) void
Adds a script error to the result.
AddScriptLine(string) void
Adds a script line to the result.
Analyze(FilePath) void
Processes the specified script path using the same context.

Extension Methods

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