Skip to content

Commit 0fc753c

Browse files
StartAutomatingStartAutomating
authored andcommitted
Adding Inline HCL Transpiler (Fixes #240 Fixes #241)
1 parent 95ddbcd commit 0fc753c

File tree

1 file changed

+81
-0
lines changed

1 file changed

+81
-0
lines changed

docs/Inline.HCL.md

Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
2+
Inline.HCL
3+
----------
4+
### Synopsis
5+
HCL PipeScript Transpiler.
6+
7+
---
8+
### Description
9+
10+
Transpiles HCL with Inline PipeScript into HCL.
11+
12+
Multiline comments blocks like ```/*{}*/``` will be treated as blocks of PipeScript.
13+
14+
Multiline comments can be preceeded or followed by 'empty' syntax, which will be ignored.
15+
16+
* ```null```
17+
* ```""```
18+
* ```{}```
19+
* ```[]```
20+
21+
---
22+
### Parameters
23+
#### **CommandInfo**
24+
25+
The command information. This will include the path to the file.
26+
27+
28+
29+
> **Type**: ```[CommandInfo]```
30+
31+
> **Required**: true
32+
33+
> **Position**: 1
34+
35+
> **PipelineInput**:true (ByValue)
36+
37+
38+
39+
---
40+
#### **Parameter**
41+
42+
A dictionary of parameters.
43+
44+
45+
46+
> **Type**: ```[IDictionary]```
47+
48+
> **Required**: false
49+
50+
> **Position**: 2
51+
52+
> **PipelineInput**:false
53+
54+
55+
56+
---
57+
#### **ArgumentList**
58+
59+
A list of arguments.
60+
61+
62+
63+
> **Type**: ```[PSObject[]]```
64+
65+
> **Required**: false
66+
67+
> **Position**: 3
68+
69+
> **PipelineInput**:false
70+
71+
72+
73+
---
74+
### Syntax
75+
```PowerShell
76+
Inline.HCL [-CommandInfo] <CommandInfo> [[-Parameter] <IDictionary>] [[-ArgumentList] <PSObject[]>] [<CommonParameters>]
77+
```
78+
---
79+
80+
81+

0 commit comments

Comments
 (0)