You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The structure of the ModuleTools module is meticulously designed according to PowerShell best practices for module development. While some design decisions may seem unconventional, they are made to ensure that ModuleTools and the process of building modules remain straightforward and easy to manage.
19
21
20
22
> [!IMPORTANT]
@@ -26,7 +28,7 @@ The structure of the ModuleTools module is meticulously designed according to Po
26
28
Install-Module -Name ModuleTools
27
29
```
28
30
29
-
> Note: ModuleTolls is still in early development phase and lot of changes are expected. Please read through [ChangeLog](/CHANGELOG.md) for all updates.
31
+
> Note: ModuleTolls is still in early devleopment phase and lot of changes are expected. Please read through [ChangeLog](/CHANGELOG.md) for all updates.
30
32
31
33
## 🧵 Design
32
34
@@ -60,6 +62,8 @@ Generated module is stored in dist folder, you can easily import it or publish i
60
62
└── TestModule.psm1
61
63
```
62
64
65
+
66
+
63
67
### Project JSON File
64
68
65
69
The `project.json` file contains all the important details about your module and is used during the module build. It should comply with a specific schema. You can refer to the sample `project-sample.json` file in the `example` directory for guidance.
@@ -68,43 +72,9 @@ Run `New-MTModule` to generate the scaffolding; this will also create the `proje
68
72
69
73
### Src Folder
70
74
71
-
- Place all your functions in the `private` and `public` folders within the `src` directory.
72
-
- All functions in the `public` folder are exported during the module build.
73
-
- All functions in the `private` folder are accessible internally within the module but are not exposed outside the module.
74
-
- Contents of the `src/resources` folder, including any subfolder, will included in the `dist` folder during the module build.
75
-
76
-
#### resources Folder
77
-
78
-
The `resources` folder within the `src` directory is intended for including any additional resources required by your module. This can include files such as:
79
-
80
-
-**Configuration files**: Store any JSON, XML, or other configuration files needed by your module.
81
-
-**Script files**: Place any scripts that are used by your functions or modules, but are not directly part of the public or private functions.
82
-
-**Documentation files**: Include any supplementary documentation that supports the usage or development of the module.
83
-
-**Data files**: Store any data files that are used by your module, such as CSV or JSON files.
84
-
-**Subfolder**: Include any additional folders and their content to be included with the module, such as dependant Modules, APIs, DLLs, etc... organized by a subfolder.
85
-
86
-
When the module is built, the contents of the `src/resources` folder will be copied directly to the `dist` folder. If the `src/resources` folder contains any subfolders, those subfolders and their contents will also be included in the `dist` folder, ensuring that all necessary files are available for the module to function correctly.
87
-
88
-
How the resources folder gets copied to the "OutputModuleDir" folder will depends on the "ResourceCopyMode" project setting. When missing or set to "Folder", the resources folder will be copied. When "ResourceCopyMode" is set to "Content", then only the content of the resources folder will be copied.
89
-
90
-
Leave `src\resources` empty if there is no need to include any additional content in the `dist` folder.
91
-
92
-
An example of the module build where resources were included:
93
-
94
-
```powershell
95
-
dist
96
-
└── TestModule
97
-
├── TestModule.psd1
98
-
├── TestModule.psm1
99
-
├── config.json
100
-
├── additionalScript.ps1
101
-
├── helpDocumentation.md
102
-
├── sampleData.csv
103
-
└── subfolder
104
-
├── subConfig.json
105
-
├── subScript.ps1
106
-
└── subData.csv
107
-
```
75
+
- Place all your functions in the `private` and `public` folders within the `src` directory.
76
+
- All functions in the `public` folder are exported during the module build.
77
+
- All functions in the `private` folder are accessible internally within the module but are not exposed outside the module.
108
78
109
79
### Tests Folder
110
80
@@ -127,11 +97,6 @@ New-MTModule ~/Work
127
97
128
98
`ModuleTools` is designed so that you don't need any additional tools like `make` or `psake` to run the build commands. There's no need to maintain complex `build.ps1` files or sample `.psd1` files. Simply follow the structure outlined above, and you can run `Invoke-MTBuild` to build the module. The output will be saved in the `dist` folder, ready for distribution.
129
99
130
-
The Invoke-MTBuild CmdLet includes a step where the resources folder and/or it's contents are copied to the "OutputModuleDir" folder. This is controlled by the optional "ResourceCopyMode" project setting.
131
-
132
-
If "ResourceCopyMode" = 'Folder or if it's missing, the entire resources folder gets copied to the "OutputModuleDir" folder.
133
-
If "ResourceCopyMode" = 'Content', only the content of the resources folder gets copied to the "OutputModuleDir" folder.
134
-
135
100
```powershell
136
101
# From the Module root
137
102
Invoke-MTBuild
@@ -161,15 +126,7 @@ A simple command to update the module version by modifying the values in `projec
161
126
162
127
## Advanced - Use it in Github Actions
163
128
164
-
This is not required for local module builds, if you are running github actions, use the following yaml workflow template to test, build and publish module which helps to automate the process of:
165
-
166
-
1. Checking out the repository code.
167
-
1. Installing the `ModuleTools` module from the PowerShell Gallery.
168
-
1. Building the module.
169
-
1. Running Pester tests.
170
-
1. Publishing the module to a specified repository.
171
-
172
-
This allows for seamless and automated management of your PowerShell module, ensuring consistency and reliability in your build, test, and release processes.
129
+
This is not required for local module builds, if you are running github actions, use below template to test, build and publish module with ease.
Copy file name to clipboardExpand all lines: project.json
+1-2Lines changed: 1 addition & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -1,8 +1,7 @@
1
1
{
2
2
"ProjectName": "ModuleTools",
3
3
"Description": "ModuleTools is a versatile, standalone PowerShell module builder. Create anything from simple to robust modules with ease. Built for CICD and Automation.",
0 commit comments