Skip to content

Commit 1e7576f

Browse files
StartAutomatingStartAutomating
authored andcommitted
ValidateScriptBlock: Adding -IncludeCommand/-ExcludeCommand (Fixes #224)
1 parent fa7cc21 commit 1e7576f

File tree

1 file changed

+82
-2
lines changed

1 file changed

+82
-2
lines changed

docs/ValidateScriptBlock.md

Lines changed: 82 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -114,6 +114,86 @@ If set, will ensure that the [ScriptBlock] has no parameters.
114114
115115

116116

117+
---
118+
#### **IncludeCommand**
119+
120+
> **Type**: ```[Object]```
121+
122+
> **Required**: false
123+
124+
> **Position**: named
125+
126+
> **PipelineInput**:false
127+
128+
129+
130+
---
131+
#### **ExcludeCommand**
132+
133+
> **Type**: ```[Object]```
134+
135+
> **Required**: false
136+
137+
> **Position**: named
138+
139+
> **PipelineInput**:false
140+
141+
142+
143+
---
144+
#### **IncludeType**
145+
146+
If set, will ensure that the script block contains types in this list.
147+
Passing -IncludeType without -ExcludeType will make -ExcludeType default to *.
148+
149+
150+
151+
> **Type**: ```[Object]```
152+
153+
> **Required**: false
154+
155+
> **Position**: named
156+
157+
> **PipelineInput**:false
158+
159+
160+
161+
---
162+
#### **ExcludeType**
163+
164+
If set, will ensure that the script block does not use the types in this list.
165+
Passing -IncludeType without -ExcludeType will make -ExcludeType default to *.
166+
167+
168+
169+
> **Type**: ```[Object]```
170+
171+
> **Required**: false
172+
173+
> **Position**: named
174+
175+
> **PipelineInput**:false
176+
177+
178+
179+
---
180+
#### **AstCondition**
181+
182+
One or more AST conditions to validate.
183+
If no results are found or the condition throws, the script block will be considered invalid.
184+
185+
186+
187+
> **Type**: ```[ScriptBlock[]]```
188+
189+
> **Required**: false
190+
191+
> **Position**: named
192+
193+
> **PipelineInput**:false
194+
195+
196+
117197
---
118198
#### **VariableAST**
119199

@@ -134,10 +214,10 @@ A VariableExpression. If provided, the Validation attributes will apply to this
134214
---
135215
### Syntax
136216
```PowerShell
137-
ValidateScriptBlock [-DataLanguage] [-ParameterOnly] [-NoBlock] [-NoParameter] [<CommonParameters>]
217+
ValidateScriptBlock [-DataLanguage] [-ParameterOnly] [-NoBlock] [-NoParameter] [-IncludeCommand <Object>] [-ExcludeCommand <Object>] [-IncludeType <Object>] [-ExcludeType <Object>] [-AstCondition <ScriptBlock[]>] [<CommonParameters>]
138218
```
139219
```PowerShell
140-
ValidateScriptBlock [-DataLanguage] [-ParameterOnly] [-NoBlock] [-NoParameter] -VariableAST <VariableExpressionAst> [<CommonParameters>]
220+
ValidateScriptBlock [-DataLanguage] [-ParameterOnly] [-NoBlock] [-NoParameter] [-IncludeCommand <Object>] [-ExcludeCommand <Object>] [-IncludeType <Object>] [-ExcludeType <Object>] [-AstCondition <ScriptBlock[]>] -VariableAST <VariableExpressionAst> [<CommonParameters>]
141221
```
142222
---
143223

0 commit comments

Comments
 (0)