Skip to content

Commit ca79e1b

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

1 file changed

Lines changed: 2 additions & 84 deletions

File tree

docs/Set-RegEx.md

Lines changed: 2 additions & 84 deletions
Original file line numberDiff line numberDiff line change
@@ -1,159 +1,87 @@
11
Set-RegEx
22
---------
33

4-
5-
6-
74
### Synopsis
85
Sets a Regular Expression
96

10-
11-
127
---
138

14-
159
### Description
1610

1711
Sets Regular Expressions to a .regex.txt file
1812

19-
20-
2113
---
2214

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

27-
28-
29-
30-
3118
---
3219

33-
3420
### Examples
35-
#### EXAMPLE 1
21+
> EXAMPLE 1
22+
3623
```PowerShell
3724
New-RegEx -Name Digits -CharacterClass Digit -Repeat |
3825
Set-RegEx
3926
```
4027

41-
42-
4328
---
4429

45-
4630
### Parameters
4731
#### **Pattern**
48-
4932
The regular expression.
5033

51-
52-
53-
54-
55-
5634
|Type |Required|Position|PipelineInput |
5735
|----------|--------|--------|---------------------|
5836
|`[String]`|true |1 |true (ByPropertyName)|
5937

60-
61-
6238
#### **Name**
63-
6439
The name of the regular expression. If not provided, this can be inferred if the pattern starts with a capture
6540

66-
67-
68-
69-
70-
7141
|Type |Required|Position|PipelineInput |
7242
|----------|--------|--------|---------------------|
7343
|`[String]`|false |2 |true (ByPropertyName)|
7444

75-
76-
7745
#### **Description**
78-
7946
The description
8047

81-
82-
83-
84-
85-
8648
|Type |Required|Position|PipelineInput |
8749
|----------|--------|--------|---------------------|
8850
|`[String]`|false |named |true (ByPropertyName)|
8951

90-
91-
9252
#### **Path**
93-
9453
The path to the file. If this is not provided, it will save regular expressions to the user's Irregular module path.
9554

96-
97-
98-
99-
100-
10155
|Type |Required|Position|PipelineInput |
10256
|----------|--------|--------|---------------------|
10357
|`[String]`|false |named |true (ByPropertyName)|
10458

105-
106-
10759
#### **Temporary**
108-
10960
If set, will not save the regular expression to disk. Instead, it will alter the in-memory RegEx library.
11061
To use the alias immediately, call Set-RegEx with the . operator (e.g. . Set-Regex -Pattern '\s+' -Name Whitespace -Temporary)
11162

112-
113-
114-
115-
116-
11763
|Type |Required|Position|PipelineInput |
11864
|----------|--------|--------|---------------------|
11965
|`[Switch]`|false |named |true (ByPropertyName)|
12066

121-
122-
12367
#### **TimeOut**
124-
12568
The timeout for the regular expression.
12669
This will only be used if the expression is temporary.
12770
By default, this is 5 seconds
12871

129-
130-
131-
132-
133-
13472
|Type |Required|Position|PipelineInput|
13573
|------------|--------|--------|-------------|
13674
|`[TimeSpan]`|false |named |false |
13775

138-
139-
14076
#### **PassThru**
141-
14277
If set, will output created files or commands.
14378
If using -Temporary, will output the created commands.
14479
Otherwise, will output the created files.
14580

146-
147-
148-
149-
150-
15181
|Type |Required|Position|PipelineInput|
15282
|----------|--------|--------|-------------|
15383
|`[Switch]`|false |named |false |
15484

155-
156-
15785
#### **WhatIf**
15886
-WhatIf is an automatic variable that is created when a command has ```[CmdletBinding(SupportsShouldProcess)]```.
15987
-WhatIf is used to see what would happen, or return operations without executing them
@@ -163,25 +91,15 @@ Otherwise, will output the created files.
16391

16492
If you pass ```-Confirm:$false``` you will not be prompted.
16593

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

169-
170-
17196
---
17297

173-
17498
### Outputs
17599
* [Nullable](https://learn.microsoft.com/en-us/dotnet/api/System.Nullable)
176100

177-
178-
179-
180-
181-
182101
---
183102

184-
185103
### Syntax
186104
```PowerShell
187105
Set-RegEx [-Pattern] <String> [[-Name] <String>] [-Description <String>] [-Path <String>] [-Temporary] [-TimeOut <TimeSpan>] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>]

0 commit comments

Comments
 (0)