Update-MFProject

SYNOPSIS

Update the parameters of a moduleForge project

SYNTAX

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

DESCRIPTION

This command allows you to update any of the parameters that were saved with the new-mfProject function without having to recreate the whole project file from scratch.

---

EXAMPLES

EXAMPLE 1

Update-MFProject -ModuleName "UpdatedModule" -Description "An updated description for the module" -ModuleAuthors "Jane Doe" -CompanyName "UpdatedCompany" -ModuleTags "updated", "module" -ProjectUri "https://github.com/username/updated-repo" -IconUri "https://example.com/updated-icon.png" -LicenseUri "https://example.com/updated-license" -RequiredModules @("UpdatedModule1", "UpdatedModule2") -ExternalModuleDependencies @("UpdatedDependency1", "UpdatedDependency2") -DefaultCommandPrefix "UpdMod" -PrivateData @{}

DESCRIPTION

This example demonstrates how to use the `Update-MFProject` function to update multiple parameters of an existing module project. It updates the module name, 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 update the specified parameters in the module project configuration file.

EXAMPLE 2

Update-MFProject -ModuleName "UpdatedModule" -Description "An updated description for the module"

DESCRIPTION

This example demonstrates how to use the `Update-MFProject` function to update only the module name and description of an existing module project. It leaves all other parameters unchanged.

OUTPUT

The function will update the module name and description in the module project configuration file.

PARAMETERS

-ModuleName

The name of your module

Type: String
Parameter Sets: (All)
Aliases:

Required: False
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: False
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: None
Accept pipeline input: False
Accept wildcard characters: False

-ModuleAuthors

Who are the primary module authors. Can expand later with add-mfmoduleAuthors command

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

-ProjectUri

Source Code Repository to use, i.e. your repositories github/azure devops uri

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 7
Default value: None
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: 8
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-LicenseUri

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

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 9
Default value: None
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: 10
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: 11
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-DefaultCommandPrefix

If you are specifying a Default Command Prefix via your manifest, this will update that prefix

Type: String
Parameter Sets: (All)
Aliases:

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

-PrivateData

If you have any additional Private Data you want to add to your module manifest, add it here. Must be a hashtable - it is forwarded directly to New-ModuleManifest, which requires a hashtable

Type: Hashtable
Parameter Sets: (All)
Aliases:

Required: False
Position: 13
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: 14
Default value: $(get-location).path
Accept pipeline input: False
Accept wildcard characters: False

-ConfigFile

Module Config File

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 15
Default value: ModuleForgeConfig.xml
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