Adding requires keyword (Fixes #293)

Author: StartAutomating

docs/Requires.md

@@ -0,0 +1,189 @@
+Requires
+--------
+### Synopsis
+requires one or more modules, variables, or types.
+
+---
+### Description
+
+Requires will require on or more modules, variables, or types to exist.
+
+---
+### Examples
+#### EXAMPLE 1
+```PowerShell
+requires latest pipescript  # will require the latest version of pipescript
+```
+
+#### EXAMPLE 2
+```PowerShell
+requires variable $pid $sid # will error, because there is no $sid
+```
+
+---
+### Parameters
+#### **Module**
+
+One or more required modules.
+
+
+
+> **Type**: ```[Object]```
+
+> **Required**: false
+
+> **Position**: named
+
+> **PipelineInput**:true (ByPropertyName)
+
+
+
+---
+#### **Latest**
+
+If set, will require the latest version of a module.
+
+
+
+> **Type**: ```[Switch]```
+
+> **Required**: false
+
+> **Position**: named
+
+> **PipelineInput**:true (ByPropertyName)
+
+
+
+---
+#### **ModuleLoader**
+
+A ModuleLoader script can be used to dynamically load unresolved modules.
+This script will be passed the unloaded module as an argument, and should return a module.
+
+
+
+> **Type**: ```[ScriptBlock]```
+
+> **Required**: false
+
+> **Position**: named
+
+> **PipelineInput**:true (ByPropertyName)
+
+
+
+---
+#### **Type**
+
+One or more required types.
+
+
+
+> **Type**: ```[Object]```
+
+> **Required**: false
+
+> **Position**: named
+
+> **PipelineInput**:true (ByPropertyName)
+
+
+
+---
+#### **TypeLoader**
+
+A TypeLoader script can be used to dynamically load unresolved types.
+This script will be passed the unloaded type as an argument.
+
+
+
+> **Type**: ```[ScriptBlock]```
+
+> **Required**: false
+
+> **Position**: named
+
+> **PipelineInput**:true (ByPropertyName)
+
+
+
+---
+#### **Variables**
+
+One or more required variables.
+
+
+
+> **Type**: ```[Object]```
+
+> **Required**: false
+
+> **Position**: named
+
+> **PipelineInput**:true (ByPropertyName)
+
+
+
+---
+#### **VariableLoader**
+
+A VariableLoader script can be used to dynamically load unresolved variable.
+This script will be passed the unloaded variable as an argument.
+
+
+
+> **Type**: ```[ScriptBlock]```
+
+> **Required**: false
+
+> **Position**: named
+
+> **PipelineInput**:true (ByPropertyName)
+
+
+
+---
+#### **CommandAst**
+
+The Command AST.  This will be provided when using the transpiler as a keyword.
+
+
+
+> **Type**: ```[CommandAst]```
+
+> **Required**: true
+
+> **Position**: named
+
+> **PipelineInput**:true (ByValue)
+
+
+
+---
+#### **ScriptBlock**
+
+The ScriptBlock.  This will be provided when using the transpiler as an attribute.
+
+
+
+> **Type**: ```[ScriptBlock]```
+
+> **Required**: true
+
+> **Position**: named
+
+> **PipelineInput**:true (ByValue)
+
+
+
+---
+### Syntax
+```PowerShell
+Requires [-Module <Object>] [-Latest] [-ModuleLoader <ScriptBlock>] [-Type <Object>] [-TypeLoader <ScriptBlock>] [-Variables <Object>] [-VariableLoader <ScriptBlock>] -CommandAst <CommandAst> [<CommonParameters>]
+```
+```PowerShell
+Requires [-Module <Object>] [-Latest] [-ModuleLoader <ScriptBlock>] [-Type <Object>] [-TypeLoader <ScriptBlock>] [-Variables <Object>] [-VariableLoader <ScriptBlock>] -ScriptBlock <ScriptBlock> [<CommonParameters>]
+```
+---
+