psake / PowerShellBuild

Common build tasks for psake and Invoke-Build that build and test PowerShell modules

MIT License

133 stars 24 forks source link

Add PSM1 Module and Script Header / Footer #28

Closed pauby closed 5 years ago

pauby commented 5 years ago

Allows header and footers for the PSM1 file.

Description

Allows a header and footer to be added to:

The PSM1 script module itself
Before and after each added script to the compiled PSM1 file

Add's four new configuration variables to allow this:

$PSBPreference.Build.CompileHeader
$PSBPreference.Build.CompileFooter
$PSBPreference.Build.CompileScriptHeader
$PSBPreference.Build.CompileScriptFooter

Related Issue

15 and #25

Motivation and Context

Allows you to add more code to the PSM1 file than just the compield scripts.

How Has This Been Tested?

I've tested this in my own project by adding text to the configuration variables and watching the output.

Types of changes

[ ] Bug fix (non-breaking change which fixes an issue)
[X] New feature (non-breaking change which adds functionality)
[ ] Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

[X] My code follows the code style of this project.
[X] My change requires a change to the documentation.
[X] I have updated the documentation accordingly.
[X] I have read the CONTRIBUTING document.
[ ] I have added tests to cover my changes.
[X] All new and existing tests passed.