Windows PowerShell - Revision history

Psmay: /* PowerShell prebuild and postbuild scripts for Visual Studio projects */

2016-02-11T21:09:32Z

PowerShell prebuild and postbuild scripts for Visual Studio projects

Show changes

Psmay: /* Prepare the event command line */

2016-02-10T06:44:54Z

Prepare the event command line

Psmay: /* Prepare the event command line */

2016-02-10T06:43:01Z

Prepare the event command line

Psmay: /* Event command line */

2016-02-10T06:42:31Z

Event command line

Psmay at 22:43, 5 February 2016

2016-02-05T22:43:34Z

Psmay: /* PowerShell Community Extensions (pscx) */

2016-02-05T20:44:32Z

PowerShell Community Extensions (pscx)

New page

==PSModulePath==

PowerShell's search path for the Import-Module command is in the <code>PSModulePath</code> env var:

echo $env:PSModulePath

By default on one system it seems to be

* a user modules dir at <code>''My Documents''\WindowsPowerShell\Modules</code>
* a global modules dir at <code>''system32''\WindowsPowerShell\v1.0\Modules\</code>

==PowerShell Community Extensions (pscx)==

Get it from http://pscx.codeplex.com/. The directory structure in the ZIP file needs to be such that the path to <code>Pscx.psm1</code> is

''Modules''/Pscx/Pscx.psm1

where ''Modules'' is one of the directories in <code>$env:PSModulePath</code>.

==(end)==

@@ Line 41: / Line 41: @@
 Convert a copy of the macro name list into the event command line by making the following changes:
-* Replace each line <code><var>NAME</var></code> with <code>-<var>NAME</var> $(&#39;<var>NAME</var>&#39;)</code>.
+* Replace each line <code><var>NAME</var></code> with <code>-<var>NAME</var> &#39;$(<var>NAME</var>)&#39;</code>.
-** Using a spreadsheet: Create a blank spreadsheet. Paste the macro names in column A. In B1, enter the formula <code><nowiki>="-" & A1 & " $('" & A1 & "')"</nowiki></code>, then fill down to the rest of column B. Select the generated column B values, copy, and paste them into a plain text editor.
+** Using a spreadsheet: Create a blank spreadsheet. Paste the macro names in column A. In B1, enter the formula <code><nowiki>="-" & A1 & " '$(" & A1 & ")'"</nowiki></code>, then fill down to the rest of column B. Select the generated column B values, copy, and paste them into a plain text editor.
-** Using vim: Enter the command <code><nowiki>:%s/\v(.*)/-\1 $('\1')/g</nowiki></code>.
+** Using vim: Enter the command <code><nowiki>:%s/\v(.*)/-\1 '$(\1)'/g</nowiki></code>.
 * Enter the line <code>powershell -ExecutionPolicy ByPass "&'$(ProjectDir)pxxbuild.ps1'"</code> above the list.
 * Replace all newlines with a single space.

@@ Line 44: / Line 44: @@
 ** Using a spreadsheet: Create a blank spreadsheet. Paste the macro names in column A. In B1, enter the formula <code><nowiki>="-" & A1 & " $('" & A1 & "')"</nowiki></code>, then fill down to the rest of column B. Select the generated column B values, copy, and paste them into a plain text editor.
 ** Using vim: Enter the command <code><nowiki>:%s/\v(.*)/-\1 $('\1')/g</nowiki></code>.
-* Enter the line <code>powershell "&'$(ProjectDir)pxxbuild.ps1'"</code> above the list.
+* Enter the line <code>powershell -ExecutionPolicy ByPass "&'$(ProjectDir)pxxbuild.ps1'"</code> above the list.
 * Replace all newlines with a single space.
 ** Using a spreadsheet and Notepad: Create a blank spreadsheet. Paste the lines into column A (if the lines were copied from another spreadsheet, use Paste Values Only to avoid copying formulas). Re-copy the lines from A, then paste the transpose (usually under Paste Special) at B1. Select the cells that have been populated (B1, C1, etc.) and copy into Notepad. In the text that has just been pasted, select a tab character and copy it. Using the ''Replace…'' function, paste the tab character into ''Find what:'' and type a space in ''Replace with:''. Run ''Replace All''.

@@ Line 78: / Line 78: @@
 Substitute <code>pre</code> or <code>post</code> for <code>pxx</code>.
-   powershell "&'$(ProjectDir)pxxbuild.ps1'" -ConfigurationName '$(ConfigurationName)'  -DevEnvDir '$(DevEnvDir)'  -OutDir '$(OutDir)'  -PlatformName '$(PlatformName)'  -ProjectDir '$(ProjectDir)'  -ProjectExt '$(ProjectExt)'  -ProjectFileName '$(ProjectFileName)'  -ProjectName '$(ProjectName)'  -ProjectPath '$(ProjectPath)'  -SolutionDir '$(SolutionDir)'  -SolutionExt '$(SolutionExt)'  -SolutionFileName '$(SolutionFileName)'  -SolutionName '$(SolutionName)'  -SolutionPath '$(SolutionPath)'  -TargetDir '$(TargetDir)'  -TargetExt '$(TargetExt)'  -TargetFileName '$(TargetFileName)'  -TargetName '$(TargetName)'
+   powershell -ExecutionPolicy ByPass "&'$(ProjectDir)pxxbuild.ps1'" -ConfigurationName '$(ConfigurationName)'  -DevEnvDir '$(DevEnvDir)'  -OutDir '$(OutDir)'  -PlatformName '$(PlatformName)'  -ProjectDir '$(ProjectDir)'  -ProjectExt '$(ProjectExt)'  -ProjectFileName '$(ProjectFileName)'  -ProjectName '$(ProjectName)'  -ProjectPath '$(ProjectPath)'  -SolutionDir '$(SolutionDir)'  -SolutionExt '$(SolutionExt)'  -SolutionFileName '$(SolutionFileName)'  -SolutionName '$(SolutionName)'  -SolutionPath '$(SolutionPath)'  -TargetDir '$(TargetDir)'  -TargetExt '$(TargetExt)'  -TargetFileName '$(TargetFileName)'  -TargetName '$(TargetName)'
 ====ps1 Boilerplate====

← Older revision		Revision as of 22:43, 5 February 2016
Line 1:		Line 1:
		+	==PowerShell prebuild and postbuild scripts for Visual Studio projects==
		+
		+	Tested with VS2015.
		+
		+	===How===
		+
		+	* Prepare (the macro list and) the ps1 boilerplate and event command line as directed below.
		+	** Alternatively, try (at your own risk) the examples already prepared from my own configuration.
		+	* Create <code>prebuild.ps1</code> and <code>postbuild.ps1</code> in the top level of the project and paste the ps1 boilerplate into each.
		+	* Go to the ''Properties'' of the project and open the ''Build Events'' tab.
		+	** Click ''Edit Pre-build…'' and paste the pre-build event command line into the field. Replace <code>pxxbuild</code> with <code>prebuild</code>. Confirm.
		+	** Click ''Edit Post-build…'' and paste the post-build event command line into the field. Replace <code>pxxbuild</code> with <code>postbuild</code>. Confirm.
		+
		+	Finally, add scripting after the boilerplate in <code>prebuild.ps1</code> and <code>postbuild.ps1</code> as necessary. This saves some serious acrobatics later on when some actual processing has to happen in the event.
		+
		+	===Prepare the macro list===
		+
		+	* Go to the ''Properties'' of the project and open the ''Build Events'' tab.
		+	* Click ''Edit Pre-build…'' (which opens the pre-build event command line for editing).
		+	* In a text editor (or spreadsheet), create a list of all of the names seen in the ''Macro'' column of the macro list in the dialog.
		+
		+	There appears to be no way to directly copy this table. For your sanity, I've included the list from my setup below.
		+
		+	===Prepare the ps1 boilerplate===
		+
		+	The ps1 boilerplate is a <code>param</code> list that makes it possible to pass all macros to the script by name and enable the rest of the file to refer to the macro values as variables.
		+
		+	Convert a copy of the macro name list into a ps1 boilerplate script by making the following changes:
		+
		+	* Prefix each line with <code>[string]$</code> and suffix each line <em>except the last</em> with <code>,</code>.
		+	** Using a spreadsheet: Create a blank spreadsheet. Paste the macro names in column A. In B1, enter the formula <code><nowiki>="[string]$" & A1 & ","</nowiki></code>, then fill down to the rest of column B. Select the generated column B values, copy, and paste them into a plain text editor. Manually delete the comma at the end of the last line.
		+	** Using vim: Enter the command <code>:%s/\v(.*)/[string]$\1,/g</code>, then delete the comma at the end of the last line.
		+	* Enter the line <code>param (</code> above the list.
		+	* Enter the line <code>)</code> below the list.
		+	* Indent as desired.
		+
		+	===Prepare the event command line===
		+
		+	The event command line is the command called by Visual Studio for the pre- and post-build commands. This generated command line in particular passes the values of all of the macros as named parameters.
		+
		+	Convert a copy of the macro name list into the event command line by making the following changes:
		+
		+	* Replace each line <code><var>NAME</var></code> with <code>-<var>NAME</var> $('<var>NAME</var>')</code>.
		+	** Using a spreadsheet: Create a blank spreadsheet. Paste the macro names in column A. In B1, enter the formula <code><nowiki>="-" & A1 & " $('" & A1 & "')"</nowiki></code>, then fill down to the rest of column B. Select the generated column B values, copy, and paste them into a plain text editor.
		+	** Using vim: Enter the command <code><nowiki>:%s/\v(.*)/-\1 $('\1')/g</nowiki></code>.
		+	* Enter the line <code>powershell "&'$(ProjectDir)pxxbuild.ps1'"</code> above the list.
		+	* Replace all newlines with a single space.
		+	** Using a spreadsheet and Notepad: Create a blank spreadsheet. Paste the lines into column A (if the lines were copied from another spreadsheet, use Paste Values Only to avoid copying formulas). Re-copy the lines from A, then paste the transpose (usually under Paste Special) at B1. Select the cells that have been populated (B1, C1, etc.) and copy into Notepad. In the text that has just been pasted, select a tab character and copy it. Using the ''Replace…'' function, paste the tab character into ''Find what:'' and type a space in ''Replace with:''. Run ''Replace All''.
		+	** Using Windows-native gvim: Enter the command <code>:%s/\n/ /g</code>
		+	** Using Visual Studio text editor: Create a new text file in Visual Studio. (This is temporary and should not be associated with the project or solution.) Paste the lines. Open Quick Replace for the current document. Use <code>\r\n</code> for the search term and <code> </code> for the replacement term, and make sure ''Use Regular Expressions'' is selected. Replace all instances.
		+
		+	===For my configuration===
		+
		+	====Macro list====
		+
		+	<nowiki>
		+	ConfigurationName
		+	DevEnvDir
		+	OutDir
		+	PlatformName
		+	ProjectDir
		+	ProjectExt
		+	ProjectFileName
		+	ProjectName
		+	ProjectPath
		+	SolutionDir
		+	SolutionExt
		+	SolutionFileName
		+	SolutionName
		+	SolutionPath
		+	TargetDir
		+	TargetExt
		+	TargetFileName
		+	TargetName</nowiki>
		+
		+	====Event command line====
		+
		+	Substitute <code>pre</code> or <code>post</code> for <code>pxx</code>.
		+
		+	powershell "&'$(ProjectDir)pxxbuild.ps1'" -ConfigurationName '$(ConfigurationName)' -DevEnvDir '$(DevEnvDir)' -OutDir '$(OutDir)' -PlatformName '$(PlatformName)' -ProjectDir '$(ProjectDir)' -ProjectExt '$(ProjectExt)' -ProjectFileName '$(ProjectFileName)' -ProjectName '$(ProjectName)' -ProjectPath '$(ProjectPath)' -SolutionDir '$(SolutionDir)' -SolutionExt '$(SolutionExt)' -SolutionFileName '$(SolutionFileName)' -SolutionName '$(SolutionName)' -SolutionPath '$(SolutionPath)' -TargetDir '$(TargetDir)' -TargetExt '$(TargetExt)' -TargetFileName '$(TargetFileName)' -TargetName '$(TargetName)'
		+
		+	====ps1 Boilerplate====
		+
		+	<syntaxhighlight lang=powershell>
		+	param (
		+	[string]$ConfigurationName,
		+	[string]$DevEnvDir,
		+	[string]$OutDir,
		+	[string]$PlatformName,
		+	[string]$ProjectDir,
		+	[string]$ProjectExt,
		+	[string]$ProjectFileName,
		+	[string]$ProjectName,
		+	[string]$ProjectPath,
		+	[string]$SolutionDir,
		+	[string]$SolutionExt,
		+	[string]$SolutionFileName,
		+	[string]$SolutionName,
		+	[string]$SolutionPath,
		+	[string]$TargetDir,
		+	[string]$TargetExt,
		+	[string]$TargetFileName,
		+	[string]$TargetName
		+	)
		+	</syntaxhighlight>
		+
	==PSModulePath==		==PSModulePath==