Skip to content

Commit ce2a998

Browse files
StartAutomatingStartAutomating
authored andcommitted
feat: Irregular Dockerfile ( Fixes #206 )
1 parent cae7137 commit ce2a998

1 file changed

Lines changed: 3 additions & 63 deletions

File tree

docs/Export-RegEx.md

Lines changed: 3 additions & 63 deletions
Original file line numberDiff line numberDiff line change
@@ -1,94 +1,56 @@
11
Export-RegEx
22
------------
33

4-
5-
6-
74
### Synopsis
85
Exports a RegEx
96

10-
11-
127
---
138

14-
159
### Description
1610

1711
Exports one or more Regular Expressions
1812

19-
20-
2113
---
2214

23-
2415
### Related Links
2516
* [Import-RegEx](Import-RegEx.md)
2617

27-
28-
2918
* [Set-RegEx](Set-RegEx.md)
3019

31-
32-
33-
34-
3520
---
3621

37-
3822
### Examples
39-
#### EXAMPLE 1
23+
> EXAMPLE 1
24+
4025
```PowerShell
4126
Export-RegEx -Name Digits, Decimals -Path $home\MyRegExs
4227
```
28+
> EXAMPLE 2
4329
44-
#### EXAMPLE 2
4530
```PowerShell
4631
Export-RegEx -Name Digits, Decimals -As Script # Creates a script that embedes the expressions and Use-RegEx
4732
```
4833

49-
50-
5134
---
5235

53-
5436
### Parameters
5537
#### **Name**
56-
5738
The name of the regular expression. If not provided, this can be inferred if the pattern starts with a capture
5839

59-
60-
61-
62-
63-
6440
|Type |Required|Position|PipelineInput |
6541
|------------|--------|--------|---------------------|
6642
|`[String[]]`|false |1 |true (ByPropertyName)|
6743

68-
69-
7044
#### **Path**
71-
7245
The export path.
7346
If this is not provided, it will export regular expressions to the user's Irregular module path.
7447

75-
76-
77-
78-
79-
8048
|Type |Required|Position|PipelineInput |
8149
|----------|--------|--------|---------------------|
8250
|`[String]`|false |2 |true (ByPropertyName)|
8351

84-
85-
8652
#### **As**
87-
8853
How the expression will be exported.
89-
90-
91-
9254
Valid Values:
9355

9456
* Metadata
@@ -103,34 +65,19 @@ Valid Values:
10365
* Engine
10466
* Embedded
10567

106-
107-
108-
109-
110-
11168
|Type |Required|Position|PipelineInput|
11269
|----------|--------|--------|-------------|
11370
|`[String]`|false |3 |false |
11471

115-
116-
11772
#### **Noun**
118-
11973
If provided, will rename -RegEx commands with the provided -Noun.
12074
This option is only valid when -As is Engine.
12175
It prevents name conflicts with Irregular.
12276

123-
124-
125-
126-
127-
12877
|Type |Required|Position|PipelineInput|
12978
|----------|--------|--------|-------------|
13079
|`[String]`|false |4 |false |
13180

132-
133-
13481
#### **WhatIf**
13582
-WhatIf is an automatic variable that is created when a command has ```[CmdletBinding(SupportsShouldProcess)]```.
13683
-WhatIf is used to see what would happen, or return operations without executing them
@@ -140,25 +87,18 @@ It prevents name conflicts with Irregular.
14087

14188
If you pass ```-Confirm:$false``` you will not be prompted.
14289

143-
14490
If the command sets a ```[ConfirmImpact("Medium")]``` which is lower than ```$confirmImpactPreference```, you will not be prompted unless -Confirm is passed.
14591

146-
147-
14892
---
14993

150-
15194
### Notes
15295
When exporting as a script, Use-RegEx is renamed to UseRegex.
15396
This enables embedding the core of Irregular and your Regular Expressions into a module while making it easy to avoid exporting Irregular.
15497

15598
To use this within a module, make sure your module explicitly exports commands, or exports with a wildcard like '*-*'.
15699

157-
158-
159100
---
160101

161-
162102
### Syntax
163103
```PowerShell
164104
Export-RegEx [[-Name] <String[]>] [[-Path] <String>] [[-As] <String>] [[-Noun] <String>] [-WhatIf] [-Confirm] [<CommonParameters>]

0 commit comments

Comments
 (0)