Skip to content

Commit ce64463

Browse files
author
James Brundage
committed
Updating Inline Transpilers Readme: Adding Contributing Section
1 parent 3a53416 commit ce64463

File tree

1 file changed

+23
-1
lines changed

1 file changed

+23
-1
lines changed

Transpilers/Inline/README.ps1.md

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,11 @@
11
This directory contains Inline PipeScript transpilers for several languages.
22

3+
Transpilers in this directory should be named ```Inline.NameOfLanguage.psx.ps1```.
4+
5+
Each file should handle one and only one language (better explicit than terse).
6+
7+
Transpilers should call ```.>PipeScript.Inline``` to simplify and standarize processing.
8+
39
PipeScript can currently be embedded in ```.>{@(Get-Transpiler -TranspilerPath $pwd).Count}<.``` languages or file types.
410

511
### Supported Languages
@@ -19,4 +25,20 @@ PipeScript can currently be embedded in ```.>{@(Get-Transpiler -TranspilerPath $
1925
}
2026
}
2127
}
22-
~~~
28+
~~~
29+
30+
### Contributing
31+
32+
If you would like to add support for writing a language with PipeScript, this is the place to put it.
33+
34+
Transpilers in this directory should:
35+
* Be named ```Inline.NameOfLanguage.psx.ps1```.
36+
* Accept ```[Management.Automation.CommandInfo]``` as a pipeline parameter.
37+
* Use ```[ValidateScript({})]``` or ```[ValidatePattern()]``` to ensure that the correct file type is targeted.
38+
39+
Each file should handle one and only one language (better explicit than terse).
40+
41+
Transpilers should call ```.>PipeScript.Inline``` to simplify and standarize processing.
42+
43+
44+

0 commit comments

Comments
 (0)