Skip to content

Commit 0346432

Browse files
StartAutomatingStartAutomating
authored andcommitted
Updating Inline Transpilers Readme: Adding Contributing Section
1 parent ce64463 commit 0346432

File tree

1 file changed

+21
-2
lines changed

1 file changed

+21
-2
lines changed

Transpilers/Inline/README.md

Lines changed: 21 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,15 @@
11
This directory contains Inline PipeScript transpilers for several languages.
22

3-
PipeScript can currently be embedded in 27 languages or file types.
4-
53
Transpilers in this directory should be named ```Inline.NameOfLanguage.psx.ps1```.
4+
65
Each file should handle one and only one language (better explicit than terse).
76

87
Transpilers should call ```.>PipeScript.Inline``` to simplify and standarize processing.
98

9+
PipeScript can currently be embedded in 27 languages or file types.
10+
11+
### Supported Languages
12+
1013

1114
|Language |Synopsis |
1215
|---------------------------------------|---------------------------------------------------------------------|
@@ -40,3 +43,19 @@ Transpilers should call ```.>PipeScript.Inline``` to simplify and standarize pro
4043

4144

4245

46+
### Contributing
47+
48+
If you would like to add support for writing a language with PipeScript, this is the place to put it.
49+
50+
Transpilers in this directory should:
51+
* Be named ```Inline.NameOfLanguage.psx.ps1```.
52+
* Accept ```[Management.Automation.CommandInfo]``` as a pipeline parameter.
53+
* Use ```[ValidateScript({})]``` or ```[ValidatePattern()]``` to ensure that the correct file type is targeted.
54+
55+
Each file should handle one and only one language (better explicit than terse).
56+
57+
Transpilers should call ```.>PipeScript.Inline``` to simplify and standarize processing.
58+
59+
60+
61+

0 commit comments

Comments
 (0)