New-MFProject

SYNOPSIS

Capture some basic parameters, and create the scaffold file structure

SYNTAX

New-MFProject [-ModuleName] <String> [-Description] <String> [[-MinimumPsVersion] <Version>]
 [[-ModuleAuthors] <String[]>] [[-CompanyName] <String>] [[-ModuleTags] <String[]>] [[-ModulePath] <String>]
 [[-ProjectUri] <String>] [[-IconUri] <String>] [[-LicenseUri] <String>] [[-ConfigFile] <String>]
 [[-RequiredModules] <Object[]>] [[-ExternalModuleDependencies] <String[]>] [[-DefaultCommandPrefix] <String>]
 [[-PrivateData] <Hashtable>] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

The New-MFProject function streamlines the process of creating a scaffold (or basic structure) for a new PowerShell module. Whether you’re building a custom module for automation, administration, or any other purpose, this function sets up the initial directory structure, essential files, and variables and properties. Think of it as laying the foundation for your module project.

---

EXAMPLES

EXAMPLE 1

New-MFProject -ModuleName "MyModule" -Description "A module for automating tasks" -ModuleAuthors "John Doe" -CompanyName "MyCompany" -ModuleTags "automation", "tasks" -ProjectUri "https://github.com/username/repo" -IconUri "https://example.com/icon.png" -LicenseUri "https://example.com/license" -RequiredModules @("Module1", "Module2") -ExternalModuleDependencies @("Dependency1", "Dependency2") -DefaultCommandPrefix "MyMod" -PrivateData @{}

DESCRIPTION

This example demonstrates how to use the ‘new-mfProject’ function to create a scaffold for a new PowerShell module named “MyModule”. It includes a description, authors, company name, tags, project URI, icon URI, license URI, required modules, external module dependencies, default command prefix, and private data.

OUTPUT

The function will create the directory structure and essential files for the new module “MyModule” in the current working directory. It will also set up the specified metadata and dependencies.

PARAMETERS

-ModuleName

The name of your module

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Description

A description of your module. Is used as the descriptor in the module repository

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-MinimumPsVersion

Minimum PowerShell version. Defaults to 7.2 as this is the current LTS version

Type: Version
Parameter Sets: (All)
Aliases:

Required: False
Position: 3
Default value: [version]::new('7.2.0')
Accept pipeline input: False
Accept wildcard characters: False

-ModuleAuthors

Who are the primary module authors. Can be updated later with Update-MFProject

Type: String[]
Parameter Sets: (All)
Aliases:

Required: False
Position: 4
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-CompanyName

Company Name. If you are building this module for your organisation, this is where it goes

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 5
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ModuleTags

Module Tags. Used to help discoverability and compatibility in package repositories

Type: String[]
Parameter Sets: (All)
Aliases:

Required: False
Position: 6
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ModulePath

Root path of the module. Uses the current working directory by default

Type: String
Parameter Sets: (All)
Aliases: Path

Required: False
Position: 7
Default value: $(get-location).path
Accept pipeline input: False
Accept wildcard characters: False

-ProjectUri

Project URI. Will try and read from Git if you are using a git repository

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 8
Default value: $(try{git config remote.origin.url}catch{$null})
Accept pipeline input: False
Accept wildcard characters: False

-IconUri

A URL to an icon representing this module

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 9
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-LicenseUri

URI to use for your project’s license. Will try and use the license file if a projectUri is found

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 10
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ConfigFile

Name of the ModuleForge config file. Defaults to ‘moduleForgeConfig.xml’

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 11
Default value: ModuleForgeConfig.xml
Accept pipeline input: False
Accept wildcard characters: False

-RequiredModules

Modules that must be imported into the global environment prior to importing this module

Type: Object[]
Parameter Sets: (All)
Aliases:

Required: False
Position: 12
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ExternalModuleDependencies

Modules that this module depends on but does not bundle - the consumer is expected to supply them

Type: String[]
Parameter Sets: (All)
Aliases:

Required: False
Position: 13
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-DefaultCommandPrefix

Default command prefix applied to all exported function names in the module manifest

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 14
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-PrivateData

Additional private data to include in the module manifest PrivateData section. Must be a hashtable - it is forwarded directly to New-ModuleManifest, which requires a hashtable

Type: Hashtable
Parameter Sets: (All)
Aliases:

Required: False
Position: 15
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

OUTPUTS

NOTES

Author: Adrian Andersson

RELATED LINKS