Skip to content

Commit 697b774

Browse files
belibugbelibug
committed
Help for module through playtps
1 parent 4dc5da2 commit 697b774

13 files changed

Lines changed: 725 additions & 112 deletions

‎docs/ModuleTools/Get-MTProjectInfo.md‎

Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
---
2+
document type: cmdlet
3+
external help file: ModuleTools-Help.xml
4+
HelpUri: ''
5+
Locale: en-US
6+
Module Name: ModuleTools
7+
ms.date: 03/19/2026
8+
PlatyPS schema version: 2024-05-01
9+
title: Get-MTProjectInfo
10+
---
11+
12+
# Get-MTProjectInfo
13+
14+
## SYNOPSIS
15+
16+
Retrieves information about a project by reading data from a project.json file in ModuleTools project folder.
17+
18+
## SYNTAX
19+
20+
### __AllParameterSets
21+
22+
```
23+
Get-MTProjectInfo [[-Path] <string>] [<CommonParameters>]
24+
```
25+
26+
## ALIASES
27+
28+
## DESCRIPTION
29+
30+
The Get-MTProjectInfo function retrieves information about a project by reading data from a project.json file located in the current directory.
31+
Ensure you navigate to a module directory which has project.json in root directory.
32+
Most variables are already defined in output of this command which can be used in pester tests and other configs.
33+
34+
## EXAMPLES
35+
36+
### EXAMPLE 1
37+
38+
Get-MTProjectInfo
39+
Retrieves project information from the project.json file in the current directory. Useful for debuggin and writing pester tests.
40+
41+
## PARAMETERS
42+
43+
### -Path
44+
45+
Provide path to root folder of the ModuleTool based project
46+
47+
```yaml
48+
Type: System.String
49+
DefaultValue: ''
50+
SupportsWildcards: false
51+
Aliases: []
52+
ParameterSets:
53+
- Name: (All)
54+
Position: 0
55+
IsRequired: false
56+
ValueFromPipeline: false
57+
ValueFromPipelineByPropertyName: false
58+
ValueFromRemainingArguments: false
59+
DontShow: false
60+
AcceptedValues: []
61+
HelpMessage: ''
62+
```
63+
64+
## INPUTS
65+
66+
## OUTPUTS
67+
68+
### hastable with all project data.
69+
70+
{{ Fill in the Description }}
71+
72+
## NOTES
73+
74+
## RELATED LINKS
75+
76+
{{ Fill in the related links here }}
77+

‎docs/ModuleTools/Invoke-MTBuild.md‎

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
---
2+
document type: cmdlet
3+
external help file: ModuleTools-Help.xml
4+
HelpUri: ''
5+
Locale: en-US
6+
Module Name: ModuleTools
7+
ms.date: 03/19/2026
8+
PlatyPS schema version: 2024-05-01
9+
title: Invoke-MTBuild
10+
---
11+
12+
# Invoke-MTBuild
13+
14+
## SYNOPSIS
15+
16+
Build a ModuleTool project to generate ready to import PowerShell Module.
17+
18+
## SYNTAX
19+
20+
### __AllParameterSets
21+
22+
```
23+
Invoke-MTBuild [<CommonParameters>]
24+
```
25+
26+
## ALIASES
27+
28+
This cmdlet has the following aliases,
29+
{{Insert list of aliases}}
30+
31+
## DESCRIPTION
32+
33+
This function is used to build a module, dist folder is cleaned up and whole module is build from scracth.
34+
copies all necessary resource files.
35+
36+
## EXAMPLES
37+
38+
### EXAMPLE 1
39+
40+
Invoke-MTBuild
41+
Builds module from the project files.
42+
43+
### EXAMPLE 2
44+
45+
Invoke-MTBuild -Verbose
46+
Builds module and outputs verbose details during entire workflow.
47+
48+
## PARAMETERS
49+
50+
### CommonParameters
51+
52+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
53+
-InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable,
54+
-ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see
55+
[about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).
56+
57+
## INPUTS
58+
59+
## OUTPUTS
60+
61+
## NOTES
62+
63+
## RELATED LINKS
64+
65+
{{ Fill in the related links here }}

‎docs/ModuleTools/Invoke-MTTest.md‎

Lines changed: 112 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,112 @@
1+
---
2+
document type: cmdlet
3+
external help file: ModuleTools-Help.xml
4+
HelpUri: ''
5+
Locale: en-US
6+
Module Name: ModuleTools
7+
ms.date: 03/19/2026
8+
PlatyPS schema version: 2024-05-01
9+
title: Invoke-MTTest
10+
---
11+
12+
# Invoke-MTTest
13+
14+
## SYNOPSIS
15+
16+
Runs Pester tests using settings from project.json
17+
18+
## SYNTAX
19+
20+
### __AllParameterSets
21+
22+
```
23+
Invoke-MTTest [[-TagFilter] <string[]>] [[-ExcludeTagFilter] <string[]>] [<CommonParameters>]
24+
```
25+
26+
## ALIASES
27+
28+
This cmdlet has the following aliases,
29+
{{Insert list of aliases}}
30+
31+
## DESCRIPTION
32+
33+
Run Pester tests using the specified configuration and settings as defined in project.json. Place all your tests in "tests" folder
34+
35+
## EXAMPLES
36+
37+
### EXAMPLE 1
38+
39+
Invoke-MTTest
40+
Runs the Pester tests for the project.
41+
42+
### EXAMPLE 2
43+
44+
Invoke-MTTest -TagFilter "unit","integrate"
45+
Runs the Pester tests for the project, that has tag unit or integrate
46+
47+
### EXAMPLE 3
48+
49+
Invoke-MTTest -ExcludeTagFilter "unit"
50+
Runs the Pester tests for the project, excludes any test with tag unit
51+
52+
## PARAMETERS
53+
54+
### -ExcludeTagFilter
55+
56+
Array of tags to exclude, Provide the tag Pester should exclude
57+
58+
```yaml
59+
Type: System.String[]
60+
DefaultValue: ''
61+
SupportsWildcards: false
62+
Aliases: []
63+
ParameterSets:
64+
- Name: (All)
65+
Position: 1
66+
IsRequired: false
67+
ValueFromPipeline: false
68+
ValueFromPipelineByPropertyName: false
69+
ValueFromRemainingArguments: false
70+
DontShow: false
71+
AcceptedValues: []
72+
HelpMessage: ''
73+
```
74+
75+
### -TagFilter
76+
77+
Array of tags to run, Provide the tag Pester should run
78+
79+
```yaml
80+
Type: System.String[]
81+
DefaultValue: ''
82+
SupportsWildcards: false
83+
Aliases: []
84+
ParameterSets:
85+
- Name: (All)
86+
Position: 0
87+
IsRequired: false
88+
ValueFromPipeline: false
89+
ValueFromPipelineByPropertyName: false
90+
ValueFromRemainingArguments: false
91+
DontShow: false
92+
AcceptedValues: []
93+
HelpMessage: ''
94+
```
95+
96+
### CommonParameters
97+
98+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
99+
-InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable,
100+
-ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see
101+
[about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).
102+
103+
## INPUTS
104+
105+
## OUTPUTS
106+
107+
## NOTES
108+
109+
## RELATED LINKS
110+
111+
{{ Fill in the related links here }}
112+

‎docs/ModuleTools/ModuleTools.md‎

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
---
2+
document type: module
3+
Help Version: 1.0.0.0
4+
HelpInfoUri: ''
5+
Locale: en-US
6+
Module Guid: d1595b4a-a79f-4440-94f0-3196f4d29c41
7+
Module Name: ModuleTools
8+
ms.date: 03/19/2026
9+
PlatyPS schema version: 2024-05-01
10+
title: ModuleTools Module
11+
---
12+
13+
# ModuleTools Module
14+
15+
## Description
16+
17+
ModuleTools is a versatile, standalone PowerShell module builder. Create anything from simple to robust modules with ease. Built for CICD and Automation.
18+
19+
## ModuleTools Cmdlets
20+
21+
### [Get-MTProjectInfo](Get-MTProjectInfo.md)
22+
23+
Retrieves information about a project by reading data from a project.json file in ModuleTools project folder.
24+
25+
### [Invoke-MTBuild](Invoke-MTBuild.md)
26+
27+
Build a ModuleTool project to generate ready to import PowerShell Module.
28+
29+
### [Invoke-MTTest](Invoke-MTTest.md)
30+
31+
Runs Pester tests using settings from project.json
32+
33+
### [New-MTModule](New-MTModule.md)
34+
35+
Create module scaffolding along with project.json file to easily build and manage modules in ModuleTools opinionated format
36+
37+
### [Publish-MTLocal](Publish-MTLocal.md)
38+
39+
Copy built module to local PSModulePath.
40+
41+
### [Update-MTModuleVersion](Update-MTModuleVersion.md)
42+
43+
Updates the version number of a module in project.json file. Uses [semver] object type.
44+

0 commit comments

Comments
 (0)