How to include functions in script files into PowerShell module

Question

I'm using PowerShell 5.0 and trying to write a multi-files module.
The module's folder structure looks like this:

/FooModule
--- FooModule.psd1
--- FooModule.psm1
--- AnotherScriptFile.ps1

The manifest file FooModule.psd1 is customized like follows:

@{
    ModuleVersion = '0.0.1'
    GUID = ...
    Author = ...
    CompanyName = ..
    Copyright = ...
    Description = ...
    PowerShellVersion = '5.0'
    ClrVersion = '4.0'
    RootModule = "FooModule.psm1"
    FunctionsToExport = '*'
    CmdletsToExport = '*'
    VariablesToExport = '*'
    AliasesToExport = '*'
    # HelpInfoURI = ''
    # DefaultCommandPrefix = ''
}

I put these at the beginning of FooModule.psm1:

Push-Location $PSScriptRoot
.\AnotherScriptFile.ps1
Pop-Location

AnotherScriptFile.ps1 looks like this:

Write-Host "Imported!"
function Get-FooFunction($val)
{
    return "Foo Bar";
}

I think, when I import the module, it will read AnotherScriptFile.ps1's functions and variables into module's scope, and get exported. Sadly, after I imported the module with Import-Module .\FooModule.psm1 in the module's folder, calling Get-FooFunction gave me an error says Get-FooFunction does not exist, 'Write-Host "Imported!" was called though.

What's the correct way to make this work?

Martin Brandl · Accepted Answer · 2016-07-05 10:40:14Z

2

You can add the scripts in the ScriptsToProcess array within your module manifest:

# Script files (.ps1) that are run in the caller's environment prior to importing this module.
ScriptsToProcess = @('.\AnotherScriptFile.ps1')

answered Jul 5, 2016 at 10:40

Martin Brandl

59.4k16 gold badges151 silver badges190 bronze badges

Sign up to request clarification or add additional context in comments.

7 Comments

wontasia Over a year ago

Thanks for you quick reply. I tried, but it didn't work :(

Martin Brandl Over a year ago

Another way would be to dot source the file (with another dot) in your FooModule.psm1. Try this: . .\AnotherScriptFile.ps1

wontasia Over a year ago

I tried, but this time, an error occured, says ..\AnotherScriptFile.ps1 is not recognized as the name of a cmdlet, function,script file, or operable program.. Working directory was set to the root of the module though.

wontasia Over a year ago

Sorry, due to the new line, I didn't see the space between the dot operator . and the file path .\AnotherScriptFile.ps1. I changed the 2nd line of FooModule.psm1 to -> .[space].\AnotherScriptFile.ps1, everything worked! Thank you very much!

Blaisem Over a year ago

Any idea why ScriptsToProcess doesn't work? Is it not able to load function definitions into the environment?

|

Collectives™ on Stack Overflow

How to include functions in script files into PowerShell module

1 Answer 1

7 Comments

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

7 Comments

Related