Skip to content

Commit 8d28b28

Browse files
StartAutomatingStartAutomating
authored andcommitted
Adding Scala Template Transpiler (Fixes #395)
1 parent a7b371e commit 8d28b28

File tree

1 file changed

+108
-0
lines changed

1 file changed

+108
-0
lines changed

docs/Scala.Template.md

Lines changed: 108 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,108 @@
1+
Scala.Template
2+
--------------
3+
4+
5+
6+
7+
### Synopsis
8+
Scala Template Transpiler.
9+
10+
11+
12+
---
13+
14+
15+
### Description
16+
17+
Allows PipeScript to generate Scala.
18+
19+
Multiline comments with /*{}*/ will be treated as blocks of PipeScript.
20+
21+
Multiline comments can be preceeded or followed by 'empty' syntax, which will be ignored.
22+
23+
This for Inline PipeScript to be used with operators, and still be valid Scala syntax.
24+
25+
The Scala Template Transpiler will consider the following syntax to be empty:
26+
27+
* ```null```
28+
* ```""```
29+
* ```''```
30+
31+
32+
33+
---
34+
35+
36+
### Parameters
37+
#### **CommandInfo**
38+
39+
The command information. This will include the path to the file.
40+
41+
42+
43+
44+
45+
46+
|Type |Required|Position|PipelineInput |
47+
|---------------|--------|--------|--------------|
48+
|`[CommandInfo]`|true |named |true (ByValue)|
49+
50+
51+
52+
#### **AsTemplateObject**
53+
54+
If set, will return the information required to dynamically apply this template to any text.
55+
56+
57+
58+
59+
60+
61+
|Type |Required|Position|PipelineInput|
62+
|----------|--------|--------|-------------|
63+
|`[Switch]`|true |named |false |
64+
65+
66+
67+
#### **Parameter**
68+
69+
A dictionary of parameters.
70+
71+
72+
73+
74+
75+
76+
|Type |Required|Position|PipelineInput|
77+
|---------------|--------|--------|-------------|
78+
|`[IDictionary]`|false |named |false |
79+
80+
81+
82+
#### **ArgumentList**
83+
84+
A list of arguments.
85+
86+
87+
88+
89+
90+
91+
|Type |Required|Position|PipelineInput|
92+
|--------------|--------|--------|-------------|
93+
|`[PSObject[]]`|false |named |false |
94+
95+
96+
97+
98+
99+
---
100+
101+
102+
### Syntax
103+
```PowerShell
104+
Scala.Template -CommandInfo <CommandInfo> [-Parameter <IDictionary>] [-ArgumentList <PSObject[]>] [<CommonParameters>]
105+
```
106+
```PowerShell
107+
Scala.Template -AsTemplateObject [-Parameter <IDictionary>] [-ArgumentList <PSObject[]>] [<CommonParameters>]
108+
```

0 commit comments

Comments
 (0)