Skip to content

Commit 4233814

Browse files
🩹 [Patch]: Add tests and update linter (#31)
## Description - Add tests - Update linter ## Type of change <!-- Use the check-boxes [x] on the options that are relevant. --> - [ ] 📖 [Docs] - [ ] 🪲 [Fix] - [x] 🩹 [Patch] - [ ] ⚠️ [Security fix] - [ ] 🚀 [Feature] - [ ] 🌟 [Breaking change] ## Checklist <!-- Use the check-boxes [x] on the options that are relevant. --> - [x] I have performed a self-review of my own code - [x] I have commented my code, particularly in hard-to-understand areas
1 parent b82e76a commit 4233814

39 files changed

+1439
-8
lines changed

.github/workflows/Action-Test.yml

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@ run-name: "Action-Test - [${{ github.event.pull_request.title }} #${{ github.eve
44

55
on: [pull_request]
66

7+
permissions: {}
8+
79
jobs:
810
ActionTest:
911
strategy:
@@ -25,12 +27,6 @@ jobs:
2527
- name: Checkout repo
2628
uses: actions/checkout@v4
2729

28-
- name: Checkout tests -> PSModuleTest
29-
uses: actions/checkout@v4
30-
with:
31-
repository: PSModule/PSModuleTest
32-
path: tests
33-
3430
- name: Initialize environment
3531
uses: PSModule/Initialize-PSModule@main
3632
with:
@@ -41,6 +37,6 @@ jobs:
4137
env:
4238
GITHUB_TOKEN: ${{ github.token }}
4339
with:
44-
Name: PSModule
40+
Name: PSModuleTest
4541
Path: ${{ matrix.path }}
4642
Shell: ${{ matrix.shell }}

.github/workflows/Linter.yml

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,22 @@ run-name: "Linter - [${{ github.event.pull_request.title }} #${{ github.event.pu
44

55
on: [pull_request]
66

7+
permissions:
8+
contents: read
9+
packages: read
10+
statuses: write # To report GitHub Actions status checks
11+
712
jobs:
813
Lint:
914
name: Lint code base
1015
runs-on: ubuntu-latest
1116
steps:
1217
- name: Checkout repo
1318
uses: actions/checkout@v4
19+
with:
20+
fetch-depth: 0
1421

1522
- name: Lint code base
16-
uses: github/super-linter@latest
23+
uses: super-linter/super-linter@latest
1724
env:
1825
GITHUB_TOKEN: ${{ github.token }}
Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
---
2+
external help file: PSModuleTest-help.xml
3+
Module Name: PSModuleTest
4+
online version:
5+
schema: 2.0.0
6+
---
7+
8+
# Get-PSModuleTest
9+
10+
## SYNOPSIS
11+
Performs tests on a module.
12+
13+
## SYNTAX
14+
15+
```powershell
16+
Get-PSModuleTest [-Name] <String> [-ProgressAction <ActionPreference>] [<CommonParameters>]
17+
```
18+
19+
## DESCRIPTION
20+
{{ Fill in the Description }}
21+
22+
## EXAMPLES
23+
24+
### EXAMPLE 1
25+
```powershell
26+
Test-PSModule -Name 'World'
27+
```
28+
29+
"Hello, World!"
30+
31+
## PARAMETERS
32+
33+
### -Name
34+
Name of the person to greet.
35+
36+
```yaml
37+
Type: String
38+
Parameter Sets: (All)
39+
Aliases:
40+
41+
Required: True
42+
Position: 1
43+
Default value: None
44+
Accept pipeline input: False
45+
Accept wildcard characters: False
46+
```
47+
48+
### -ProgressAction
49+
{{ Fill ProgressAction Description }}
50+
51+
```yaml
52+
Type: ActionPreference
53+
Parameter Sets: (All)
54+
Aliases: proga
55+
56+
Required: False
57+
Position: Named
58+
Default value: None
59+
Accept pipeline input: False
60+
Accept wildcard characters: False
61+
```
62+
63+
### CommonParameters
64+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
65+
66+
## INPUTS
67+
68+
## OUTPUTS
69+
70+
## NOTES
71+
72+
## RELATED LINKS
Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
---
2+
external help file: PSModuleTest-help.xml
3+
Module Name: PSModuleTest
4+
online version:
5+
schema: 2.0.0
6+
---
7+
8+
# New-PSModuleTest
9+
10+
## SYNOPSIS
11+
Performs tests on a module.
12+
13+
## SYNTAX
14+
15+
```powershell
16+
New-PSModuleTest [-Name] <String> [-ProgressAction <ActionPreference>] [<CommonParameters>]
17+
```
18+
19+
## DESCRIPTION
20+
{{ Fill in the Description }}
21+
22+
## EXAMPLES
23+
24+
### EXAMPLE 1
25+
```powershell
26+
Test-PSModule -Name 'World'
27+
```
28+
29+
"Hello, World!"
30+
31+
## PARAMETERS
32+
33+
### -Name
34+
Name of the person to greet.
35+
36+
```yaml
37+
Type: String
38+
Parameter Sets: (All)
39+
Aliases:
40+
41+
Required: True
42+
Position: 1
43+
Default value: None
44+
Accept pipeline input: False
45+
Accept wildcard characters: False
46+
```
47+
48+
### -ProgressAction
49+
{{ Fill ProgressAction Description }}
50+
51+
```yaml
52+
Type: ActionPreference
53+
Parameter Sets: (All)
54+
Aliases: proga
55+
56+
Required: False
57+
Position: Named
58+
Default value: None
59+
Accept pipeline input: False
60+
Accept wildcard characters: False
61+
```
62+
63+
### CommonParameters
64+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
65+
66+
## INPUTS
67+
68+
## OUTPUTS
69+
70+
## NOTES
71+
72+
## RELATED LINKS
Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
---
2+
external help file: PSModuleTest-help.xml
3+
Module Name: PSModuleTest
4+
online version:
5+
schema: 2.0.0
6+
---
7+
8+
# Set-PSModuleTest
9+
10+
## SYNOPSIS
11+
Performs tests on a module.
12+
13+
## SYNTAX
14+
15+
```powershell
16+
Set-PSModuleTest [-Name] <String> [-ProgressAction <ActionPreference>] [<CommonParameters>]
17+
```
18+
19+
## DESCRIPTION
20+
{{ Fill in the Description }}
21+
22+
## EXAMPLES
23+
24+
### EXAMPLE 1
25+
```powershell
26+
Test-PSModule -Name 'World'
27+
```
28+
29+
"Hello, World!"
30+
31+
## PARAMETERS
32+
33+
### -Name
34+
Name of the person to greet.
35+
36+
```yaml
37+
Type: String
38+
Parameter Sets: (All)
39+
Aliases:
40+
41+
Required: True
42+
Position: 1
43+
Default value: None
44+
Accept pipeline input: False
45+
Accept wildcard characters: False
46+
```
47+
48+
### -ProgressAction
49+
{{ Fill ProgressAction Description }}
50+
51+
```yaml
52+
Type: ActionPreference
53+
Parameter Sets: (All)
54+
Aliases: proga
55+
56+
Required: False
57+
Position: Named
58+
Default value: None
59+
Accept pipeline input: False
60+
Accept wildcard characters: False
61+
```
62+
63+
### CommonParameters
64+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
65+
66+
## INPUTS
67+
68+
## OUTPUTS
69+
70+
## NOTES
71+
72+
## RELATED LINKS
Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
---
2+
external help file: PSModuleTest-help.xml
3+
Module Name: PSModuleTest
4+
online version:
5+
schema: 2.0.0
6+
---
7+
8+
# Test-PSModuleTest
9+
10+
## SYNOPSIS
11+
Performs tests on a module.
12+
13+
## SYNTAX
14+
15+
```powershell
16+
Test-PSModuleTest [-Name] <String> [-ProgressAction <ActionPreference>] [<CommonParameters>]
17+
```
18+
19+
## DESCRIPTION
20+
{{ Fill in the Description }}
21+
22+
## EXAMPLES
23+
24+
### EXAMPLE 1
25+
```powershell
26+
Test-PSModule -Name 'World'
27+
```
28+
29+
"Hello, World!"
30+
31+
## PARAMETERS
32+
33+
### -Name
34+
Name of the person to greet.
35+
36+
```yaml
37+
Type: String
38+
Parameter Sets: (All)
39+
Aliases:
40+
41+
Required: True
42+
Position: 1
43+
Default value: None
44+
Accept pipeline input: False
45+
Accept wildcard characters: False
46+
```
47+
48+
### -ProgressAction
49+
{{ Fill ProgressAction Description }}
50+
51+
```yaml
52+
Type: ActionPreference
53+
Parameter Sets: (All)
54+
Aliases: proga
55+
56+
Required: False
57+
Position: Named
58+
Default value: None
59+
Accept pipeline input: False
60+
Accept wildcard characters: False
61+
```
62+
63+
### CommonParameters
64+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
65+
66+
## INPUTS
67+
68+
## OUTPUTS
69+
70+
## NOTES
71+
72+
## RELATED LINKS

0 commit comments

Comments
 (0)