Skip to content

Commit 96e2665

Browse files
StartAutomatingStartAutomating
authored andcommitted
Adding README for Wrapper Transpilers
1 parent 4469522 commit 96e2665

File tree

1 file changed

+30
-0
lines changed

1 file changed

+30
-0
lines changed

Transpilers/Parameters/README.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
This directory and it's subdirectories contain Transpilers that transform parameter attributes.
2+
3+
Parameter Transpilers do not need to take any values from the pipeline.
4+
They will be called by the Core PipeScript Transpiler ```PipeScript.ParameterAttribute```.
5+
6+
When Transpiling a Parameter, the Transpiler should return one of two things.
7+
8+
1. An empty ```[ScriptBlock]``` preceeded by attributes or help. This will replace the Transpiled attribute with a real one.
9+
2. A ```[Collections.IDictionary]``` can be used to send arguments directly back to ```Update-PipeScript```.
10+
11+
Many parameter transpilers can also apply to a ```[Management.Automation.Language.VariableExpressionAst]```.
12+
13+
When this is the case it is common for the transpiler to add a ```[ValidateScript]``` attribute to the variable. This will constraint the value of that variable.
14+
15+
## List Of Parameter Transpilers
16+
17+
18+
|DisplayName |Synopsis |
19+
|----------------------------------------------------|---------------------------------------------------------------------|
20+
|[ValidatePlatform](ValidatePlatform.psx.ps1) |[Validates the Platform](ValidatePlatform.psx.ps1) |
21+
|[ValidatePropertyName](ValidatePropertyName.psx.ps1)|[Validates Property Names](ValidatePropertyName.psx.ps1) |
22+
|[ValidateTypes](ValidateTypes.psx.ps1) |[Validates if an object is one or more types.](ValidateTypes.psx.ps1)|
23+
|[VBN](VBN.psx.ps1) |[ValueFromPipline Shorthand](VBN.psx.ps1) |
24+
|[VFP](VFP.psx.ps1) |[ValueFromPipline Shorthand](VFP.psx.ps1) |
25+
26+
27+
28+
29+
30+

0 commit comments

Comments
 (0)