Module manifest (.psd1) in PowerShell - Mini Project: Build & Apply

Create a PowerShell Module Manifest (.psd1)

📖 Scenario: You are packaging a PowerShell module to share with your team. To do this properly, you need to create a module manifest file (.psd1) that describes your module's metadata and settings.

🎯 Goal: Build a simple PowerShell module manifest file (.psd1) with essential information like module name, version, author, and description.

📋 What You'll Learn

Create a hashtable named ModuleManifest with specific keys and values

Add a ModuleVersion key with a version string

Include author and description information

Output the manifest content as a formatted string

💡 Why This Matters

🌍 Real World

Module manifests are used to describe PowerShell modules so others can understand and use them properly.

💼 Career

Knowing how to create and manage module manifests is essential for PowerShell developers and system administrators who package and share reusable scripts.

1

Create the basic module manifest hashtable

Create a hashtable called ModuleManifest with these exact keys and values: ModuleName set to 'MyModule', Author set to 'Jane Doe', and Description set to 'This is a sample PowerShell module.'

PowerShell

# Create the ModuleManifest hashtable with ModuleName, Author, and Description
# Your code here

Need a hint?

Use @{} to create a hashtable and assign keys with =.

2

Add the module version to the manifest

Add a key ModuleVersion with the value '1.0.0' to the existing ModuleManifest hashtable.

PowerShell

$ModuleManifest = @{
    ModuleName = 'MyModule'
    Author = 'Jane Doe'
    Description = 'This is a sample PowerShell module.'
}
# Add ModuleVersion key with value '1.0.0' to ModuleManifest
# Your code here

Need a hint?

Add the new key and value inside the hashtable using the same syntax as before.

3

Convert the manifest hashtable to a formatted string

Use ConvertTo-Json and Out-String to convert the ModuleManifest hashtable into a JSON formatted string and store it in a variable called ManifestString.

PowerShell

$ModuleManifest = @{
    ModuleName = 'MyModule'
    Author = 'Jane Doe'
    Description = 'This is a sample PowerShell module.'
    ModuleVersion = '1.0.0'
}
# Convert ModuleManifest to JSON string and assign to ManifestString
# Your code here

Need a hint?

Use the pipeline | to send ModuleManifest to ConvertTo-Json and then to Out-String.

4

Display the module manifest content

Print the content of the ManifestString variable to the console using Write-Output.

PowerShell

$ModuleManifest = @{
    ModuleName = 'MyModule'
    Author = 'Jane Doe'
    Description = 'This is a sample PowerShell module.'
    ModuleVersion = '1.0.0'
}

$ManifestString = $ModuleManifest | ConvertTo-Json -Depth 3 | Out-String
# Print ManifestString to the console
# Your code here

Need a hint?

Use Write-Output followed by the variable name to print the string.