Skip to content

Latest commit

 

History

History
60 lines (41 loc) · 1.05 KB

UseToExportFieldsInManifest.md

File metadata and controls

60 lines (41 loc) · 1.05 KB
description ms.custom ms.date ms.topic title
Use the *ToExport module manifest fields.
PSSA v1.22.1
06/28/2023
reference
UseToExportFieldsInManifest

UseToExportFieldsInManifest

Severity Level: Warning

Description

To improve the performance of module auto-discovery, module manifests should not use wildcards ('*') or null ($null) in the following entries:

  • AliasesToExport
  • CmdletsToExport
  • FunctionsToExport
  • VariablesToExport

Using wildcards or null has causes PowerShell to perform expensive work to analyze a module during module auto-discovery.

How

Use an explicit list in the entries.

Example 1

Suppose there are no functions in your module to export. Then,

Wrong

FunctionsToExport = $null

Correct

FunctionToExport = @()

Example 2

Suppose there are only two functions in your module, Get-Foo and Set-Foo that you want to export. Then,

Wrong

FunctionsToExport = '*'

Correct

FunctionToExport = @(Get-Foo, Set-Foo)