en-us/PSProjectStatus-help.xml
<?xml version="1.0" encoding="utf-8"?>
<helpItems schema="maml" xmlns="http://msh"> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-PSProjectGitStatus</command:name> <command:verb>Get</command:verb> <command:noun>PSProjectGitStatus</command:noun> <maml:description> <maml:para>Get git project status.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Presumably you are using git to manage your project. If so, some git-related information is included in the PSProjectStatus output. Get-PSProjectGitStatus is intended to provide more git-specific details. You should run this command in the root of your project directory. If the project is not git initialized, nothing will be returned.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PSProjectGitStatus</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>PSProjectGit</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>This command has an alias of gitstat.</maml:para> <maml:para>Learn more about PowerShell: http://jdhitsolutions.com/blog/essential-powershell-resources/</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\Scripts\PSProjectStatus> Get-PSProjectGitStatus Name Branch LastCommit Remote ---- ------ ---------- ------ PSProjectStatus 0.6.0 3/29/2022 5:23:20 PM @{RemoteName=origin; LastPush=3/26/2022 10:36:00 AM}</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://bit.ly/3jSB1hH</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-PSProjectStatus</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-PSProjectReport</command:name> <command:verb>Get</command:verb> <command:noun>PSProjectReport</command:noun> <maml:description> <maml:para>Manage all your PSProject folders.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The PSProjectStatus module makes an assumption that the majority of your projects are organized under a parent folder like C:\Scripts. This command is designed to make it easier to identify and manage projects you are working on. The default behavior is to get PSProject information from the top-level folders in your root directory. But you can also filter on status, age, or tag.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PSProjectReport</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>Specify the top level folder</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>NewerThan</maml:name> <maml:description> <maml:para>Get projects where the age is newer than X number of days</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Status</maml:name> <maml:description> <maml:para>Filter projects by status</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Development</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Updating</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Stable</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">AlphaTesting</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">BetaTesting</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ReleaseCandidate</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Patching</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">UnitTesting</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">AcceptanceTesting</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Other</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Archive</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">PSProjectStatus</command:parameterValue> <dev:type> <maml:name>PSProjectStatus</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Tag</maml:name> <maml:description> <maml:para>Get projects with a specific tag. You can combine this with other filtering parameters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-PSProjectReport</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>Specify the top level folder</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OlderThan</maml:name> <maml:description> <maml:para>Get projects where the age is older than X number of days</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Status</maml:name> <maml:description> <maml:para>Filter projects by status</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Development</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Updating</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Stable</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">AlphaTesting</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">BetaTesting</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ReleaseCandidate</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Patching</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">UnitTesting</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">AcceptanceTesting</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Other</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Archive</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">PSProjectStatus</command:parameterValue> <dev:type> <maml:name>PSProjectStatus</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Tag</maml:name> <maml:description> <maml:para>Get projects with a specific tag. You can combine this with other filtering parameters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>NewerThan</maml:name> <maml:description> <maml:para>Get projects where the age is newer than X number of days</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OlderThan</maml:name> <maml:description> <maml:para>Get projects where the age is older than X number of days</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>Specify the top level folder</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Status</maml:name> <maml:description> <maml:para>Filter projects by status</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSProjectStatus</command:parameterValue> <dev:type> <maml:name>PSProjectStatus</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Tag</maml:name> <maml:description> <maml:para>Get projects with a specific tag. You can combine this with other filtering parameters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>PSProject</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-PSProjectReport c:\scripts -Status Other Name: PSMessaging [C:\Scripts\PSMessaging] LastUpdate Status Tasks GitBranch Age ---------- ------ ----- --------- --- 7/20/2022 11:58:54 AM Other {} master 192.02:11</dev:code> <dev:remarks> <maml:para>Get PSProject information based on a status.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Get-PSProjectReport c:\scripts -NewerThan 10 -Status Stable Name: PluralsightTools [C:\Scripts\PluralsightTools] LastUpdate Status Tasks GitBranch Age ---------- ------ ----- --------- --- 1/20/2023 2:20:39 PM Stable {convert modu... main 07.23:51</dev:code> <dev:remarks> <maml:para>Get PSProjects modified within the last 10 days.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>PS C>\> Get-PSProjectReport c:\scripts -NewerThan 60 | Select-Object Path,Name,Status,Tags,LastUpdate | Out-GridView -Title "Select a project" -OutputMode Single | Foreach-Object { set-location $_.path ; code $_.path }</dev:code> <dev:remarks> <maml:para>Get projects modified in the last 60 days and send to Out-GridView. The selected project folder will be opened in VSCode.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://bit.ly/3OSBu3L</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-PSProjectStatus</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-PSProjectStatus</command:name> <command:verb>Get</command:verb> <command:noun>PSProjectStatus</command:noun> <maml:description> <maml:para>Get project status.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This command will get the project status from the JSON file found in the module root directory. Get-PSProjectStatus will check the current directory by default, or you can specify the parent path of another directory.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PSProjectStatus</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="FullName"> <maml:name>Path</maml:name> <maml:description> <maml:para>Enter the parent path to the psproject.json file, e.g. c:\scripts\mymodule</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="FullName"> <maml:name>Path</maml:name> <maml:description> <maml:para>Enter the parent path to the psproject.json file, e.g. c:\scripts\mymodule</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>PSProject</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>This command has an alias of gpstat.</maml:para> <maml:para>Learn more about PowerShell: http://jdhitsolutions.com/blog/essential-powershell-resources/</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\Scripts\PSClock> Get-PSProjectStatus Name: PSClock [C:\Scripts\PSClock] LastUpdate Status Tasks GitBranch Age ---------- ------ ----- --------- --- 10/17/2024 1:00:56 PM Stable {Pester tests} main 80.20:40</dev:code> <dev:remarks> <maml:para>Get the status from the current directory.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>C:\Scripts\ dir -Directory | Get-PSProjectStatus -WarningAction SilentlyContinue Name: ADReportingTools [C:\Scripts\ADReportingTools] LastUpdate Status Tasks GitBranch Age ---------- ------ ----- --------- --- 6/21/2021 4:47:11 PM Updating {Publish new ... 1.4.0 266.17:59 Name: GitDevTest [C:\scripts\GitDevTest] LastUpdate Status Tasks GitBranch Age ---------- ------ ----- --------- --- 2/3/2022 4:50:37 PM Stable {update readm... master 39.17:55 Name: MyTasks [C:\Scripts\MyTasks] LastUpdate Status Tasks GitBranch Age ---------- ------ ----- --------- --- 10/14/2020 1:29:59 PM Stable master 516.21:16 ...</dev:code> <dev:remarks> <maml:para>Get status for multiple projects. You could also use the Get-PSProjectReport command.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>PS C:\Scripts\PSCalendar> Get-PSProjectStatus | Format-List Project: PSCalendar [C:\scripts\PSCalendar] Version : 2.9.0 Status : Stable Tasks : {Update Help, Issue 34} Tags : {} GitBranch : master LastUpdate : 3/1/2022 5:50:00 AM Age : 669.10:07:19</dev:code> <dev:remarks> <maml:para>Use the default List view. This makes it easier to view the tasks.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 4 --------------------------</maml:title> <dev:code>PS C:\Scripts\PSProjectStatus> Get-PSProjectStatus | Select-Object VersionInfo,Age Name : PSProjectStatus Status : Updating Version : 0.5.0 GitBranch : 0.5.0 LastUpdate : 3/23/2022 11:30:42 AM Age : 00:06:06.2337458</dev:code> <dev:remarks> <maml:para>Get status using the versionInfo property set and the Age script property.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://bit.ly/37oLez9</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-PSProjectStatus</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-PSProjectStatus</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-PSProjectReport</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-PSProjectTask</command:name> <command:verb>Get</command:verb> <command:noun>PSProjectTask</command:noun> <maml:description> <maml:para>List project tasks</maml:para> </maml:description> </command:details> <maml:description> <maml:para>List defined tasks in the PSProject file. You will get a warning if no tasks are defined.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PSProjectTask</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="FullName"> <maml:name>Path</maml:name> <maml:description> <maml:para>Enter the parent path to the psproject.json file, e.g. c:\scripts\mymodule.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="ID"> <maml:name>TaskID</maml:name> <maml:description> <maml:para>Get a task by its ID number</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="FullName"> <maml:name>Path</maml:name> <maml:description> <maml:para>Enter the parent path to the psproject.json file, e.g. c:\scripts\mymodule.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="ID"> <maml:name>TaskID</maml:name> <maml:description> <maml:para>Get a task by its ID number</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>psProjectTask</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\Scripts\PSWorkItem> Get-PSProjectTask Name: PSWorkItem [C:\Scripts\PSWorkItem] ● Pester tests [1] ● add message localization [2] ● fix PDF image location [3]</dev:code> <dev:remarks> <maml:para>Display tasks. If you run this in the console of VSCode, you should get ANSI formatted output. The number in brackets is the TaskID.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\PSWorkItem> Get-PSProjectTask -TaskID 2 Name: PSWorkItem [C:\Scripts\PSWorkItem] ● add message localization [2]</dev:code> <dev:remarks> <maml:para>Get a task by ID number.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://bit.ly/4833Pv8</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-PSProjectTask</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-PSProjectTask</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-PSProjectStatus</command:name> <command:verb>New</command:verb> <command:noun>PSProjectStatus</command:noun> <maml:description> <maml:para>Create a new PSProjectStatus.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Create a new PSProject file. Ideally, you will run this command in the module root directory. The module manifest, if found, will be used for the Project Version. If a git branch is detected, it will automatically be used.</maml:para> <maml:para>The command will not overwrite an existing PSProjectStatus file. If you want to overwrite an existing file, use the -Force parameter.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-PSProjectStatus</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>What is the project name? The default is the current folder name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>current folder name</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="date"> <maml:name>LastUpdate</maml:name> <maml:description> <maml:para>When was the project last worked on?</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>What is the project path?</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>.</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Status</maml:name> <maml:description> <maml:para>What is the project status? Accepted values are: Development Updating Stable AlphaTesting BetaTesting ReleaseCandidate Patching UnitTesting AcceptanceTesting Other</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Development</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Updating</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Stable</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">AlphaTesting</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">BetaTesting</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ReleaseCandidate</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Patching</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">UnitTesting</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">AcceptanceTesting</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Other</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">PSProjectStatus</command:parameterValue> <dev:type> <maml:name>PSProjectStatus</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Tasks</maml:name> <maml:description> <maml:para>What are the remaining tasks?</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="version"> <maml:name>ProjectVersion</maml:name> <maml:description> <maml:para>What is the project version? The default value will be detected from a module manifest if found.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Version</command:parameterValue> <dev:type> <maml:name>Version</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>module version</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Comment</maml:name> <maml:description> <maml:para>Enter an optional comment. This could be git tag, or an indication about the type of project.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Overwrite an existing PSProjectStatus file.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Tags</maml:name> <maml:description> <maml:para>What tags do you want to assign to this project?</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="date"> <maml:name>LastUpdate</maml:name> <maml:description> <maml:para>When was the project last worked on?</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>What is the project name? The default is the current folder name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>current folder name</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>What is the project path?</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>.</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Status</maml:name> <maml:description> <maml:para>What is the project status? Accepted values are: Development Updating Stable AlphaTesting BetaTesting ReleaseCandidate Patching UnitTesting AcceptanceTesting Other</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSProjectStatus</command:parameterValue> <dev:type> <maml:name>PSProjectStatus</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Tasks</maml:name> <maml:description> <maml:para>What are the remaining tasks?</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="version"> <maml:name>ProjectVersion</maml:name> <maml:description> <maml:para>What is the project version? The default value will be detected from a module manifest if found.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Version</command:parameterValue> <dev:type> <maml:name>Version</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>module version</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Comment</maml:name> <maml:description> <maml:para>Enter an optional comment. This could be git tag, or an indication about the type of project.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Overwrite an existing PSProjectStatus file.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Tags</maml:name> <maml:description> <maml:para>What tags do you want to assign to this project?</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>PSProject</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>This command has an alias of npstat.</maml:para> <maml:para>Learn more about PowerShell: http://jdhitsolutions.com/blog/essential-powershell-resources/</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\Projects\Contoso> New-PSProjectStatus Name: Contoso [C:\Projects\Contoso] LastUpdate Status Tasks GitBranch Age ---------- ------ ----- --------- --- 12/22/2024 8:35:55 AM Development {} main 00.00:00</dev:code> <dev:remarks> <maml:para>Create a new project status using default values.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\Scripts\PSScriptingInventory> New-PSProjectStatus -LastUpdate (Get-Item .\PSScriptingInventory.psd1).LastWriteTime -Status Stable -Comment "Script module" Name: PSScriptingInventory [C:\scripts\PSScriptingInventory] LastUpdate Status Tasks GitBranch Age ---------- ------ ----- --------- --- 6/19/2024 8:42:04 AM Stable {} main 234.01:13</dev:code> <dev:remarks> <maml:para>Create a new project status. PSDrive references will be converted to filesystem paths. The Age property is automatically calculated from the LastUpdate value.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://bit.ly/3MXO7Ho</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-PSProjectStatus</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-PSProjectStatus</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-PSProjectReport</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-PSProjectTask</command:name> <command:verb>New</command:verb> <command:noun>PSProjectTask</command:noun> <maml:description> <maml:para>Create a new task in the PSProject file.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>You can add tasks directly in the PSProject file, or you can use this function. Specify a task description and it will be added to the PSProject file. The task ID is assigned automatically.</maml:para> <maml:para>You can also use Set-PSProjectTask set tasks.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-PSProjectTask</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>TaskDescription</maml:name> <maml:description> <maml:para>Enter the task description.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Display the new task.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="FullName"> <maml:name>Path</maml:name> <maml:description> <maml:para>Enter the parent path to the psproject.json file, e.g. c:\scripts\mymodule.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Display the new task.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="FullName"> <maml:name>Path</maml:name> <maml:description> <maml:para>Enter the parent path to the psproject.json file, e.g. c:\scripts\mymodule.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>TaskDescription</maml:name> <maml:description> <maml:para>Enter the task description.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>psProjectTask</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\Scripts\PSProjectStatus> New-PSProjectTask -TaskDescription "Update README"</dev:code> <dev:remarks> <maml:para>Add a new task.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>C:\Scripts\PSProjectStatus> New-PSProjectTask -TaskDescription "Pester tests" -PassThru Name: PSProjectStatus [C:\Scripts\PSProjectStatus] Pester tests [7]</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://bit.ly/3tyR5xe</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-PSProjectTask</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-PSProjectTask</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Open-PSProjectStatusHelp</command:name> <command:verb>Open</command:verb> <command:noun>PSProjectStatusHelp</command:noun> <maml:description> <maml:para>Open the PSProjectStatus help document</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Use this command to open the PDF help document for the PSProjectStatus module with the associated application for PDF files. If you are running PowerShell 7, as an alternative you can view the documentation as a markdown document with the -AsMarkdown parameter. This is a dynamic parameter that does not exist in Windows PowerShell.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Open-PSProjectStatusHelp</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="md"> <maml:name>AsMarkdown</maml:name> <maml:description> <maml:para>If you are running PowerShell 7, as an alternative you can view the documentation as a markdown document with the -AsMarkdown parameter. This is a dynamic parameter that does not exist in Windows PowerShell.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="md"> <maml:name>AsMarkdown</maml:name> <maml:description> <maml:para>If you are running PowerShell 7, as an alternative you can view the documentation as a markdown document with the -AsMarkdown parameter. This is a dynamic parameter that does not exist in Windows PowerShell.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Open-PSProjectStatusHelp</dev:code> <dev:remarks> <maml:para>The file should open in the default application for PDF files.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Open-PSProjectStatusHelp -AsMarkdown | more</dev:code> <dev:remarks> <maml:para>View the help file a markdown document if running PowerShell 7.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>PSProjectStatus GitHub Repository:</maml:linkText> <maml:uri>https://github.com/jdhitsolutions/PSProjectStatus</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-PSProjectTask</command:name> <command:verb>Remove</command:verb> <command:noun>PSProjectTask</command:noun> <maml:description> <maml:para>Remove a task from the PSProject file.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>You can manually remove tasks from the PSProject file, or you can use this function. Specify a task ID and it will be removed from the PSProject file.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-PSProjectTask</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="ID"> <maml:name>TaskID</maml:name> <maml:description> <maml:para>Enter the task ID</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="FullName"> <maml:name>Path</maml:name> <maml:description> <maml:para>Enter the parent path to the psproject.json file, e.g. c:\scripts\mymodule.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="FullName"> <maml:name>Path</maml:name> <maml:description> <maml:para>Enter the parent path to the psproject.json file, e.g. c:\scripts\mymodule.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="ID"> <maml:name>TaskID</maml:name> <maml:description> <maml:para>Enter the task ID</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>[Int]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\scripts\PSProjectStatus> Remove-PSProjectTask -TaskID 4,2</dev:code> <dev:remarks> <maml:para>Remove tasks 4 and 2 from the PSProject file.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://bit.ly/48pXpWM</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-PSProjectTask</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-PSProjectTask</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-PSProjectStatus</command:name> <command:verb>Set</command:verb> <command:noun>PSProjectStatus</command:noun> <maml:description> <maml:para>Update a PSProject status.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Use this command to update a PSProject status. If a git branch is detected, it will automatically be used. Ideally, you will run Set-PSProjectStatus from the module root directory. You can always manually modify the psproject.json file in your editor. To manually update the LastUpdate value, convert a datetime value to JSON.</maml:para> <maml:para>Get-Date -format o | Set-Clipboard</maml:para> <maml:para>Manually copy the value into the JSON file.</maml:para> <maml:para>The Status value is an integer indicating a private enumeration value.</maml:para> <maml:para>- Development = 0</maml:para> <maml:para>- Updating = 1</maml:para> <maml:para>- Stable = 2</maml:para> <maml:para>- AlphaTesting = 3</maml:para> <maml:para>- BetaTesting = 4</maml:para> <maml:para>- ReleaseCandidate = 5</maml:para> <maml:para>- Patching = 6</maml:para> <maml:para>- UnitTesting = 7</maml:para> <maml:para>- AcceptanceTesting = 8</maml:para> <maml:para>- Other = 9</maml:para> <maml:para></maml:para> <maml:para>Enter one of these string values. If you edit the file in VSCode, it should detect the JSON schema and provide completion values.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-PSProjectStatus</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specify a PSProject object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSProject file in the current directory</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>What is the project name?</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="date"> <maml:name>LastUpdate</maml:name> <maml:description> <maml:para>When was the project last worked on or updated?</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>current date and time</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>Tasks</maml:name> <maml:description> <maml:para>What are the remaining tasks?</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>Status</maml:name> <maml:description> <maml:para>What is the project status? Accepted values are Development, Updating, Stable, AlphaTesting, BetaTesting, ReleaseCandidate, Patching, UnitTesting, AcceptanceTesting, and Other.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Development</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Updating</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Stable</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">AlphaTesting</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">BetaTesting</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ReleaseCandidate</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Patching</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">UnitTesting</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">AcceptanceTesting</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Other</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">PSProjectStatus</command:parameterValue> <dev:type> <maml:name>PSProjectStatus</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="add"> <maml:name>Concatenate</maml:name> <maml:description> <maml:para>Concatenate new tasks.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="version"> <maml:name>ProjectVersion</maml:name> <maml:description> <maml:para>What is the project version?</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Version</command:parameterValue> <dev:type> <maml:name>Version</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Comment</maml:name> <maml:description> <maml:para>Enter an optional comment. This could be git tag, or an indication about the type of project.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Tags</maml:name> <maml:description> <maml:para>What tags do you want to assign to this project? If you want to append tags you either have to re-define all tags, or add a tag manually to the psproject.json file.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="add"> <maml:name>Concatenate</maml:name> <maml:description> <maml:para>Concatenate new tasks.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specify a PSProject object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSProject file in the current directory</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="date"> <maml:name>LastUpdate</maml:name> <maml:description> <maml:para>When was the project last worked on or updated?</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>current date and time</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>What is the project name?</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>Status</maml:name> <maml:description> <maml:para>What is the project status? Accepted values are Development, Updating, Stable, AlphaTesting, BetaTesting, ReleaseCandidate, Patching, UnitTesting, AcceptanceTesting, and Other.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSProjectStatus</command:parameterValue> <dev:type> <maml:name>PSProjectStatus</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>Tasks</maml:name> <maml:description> <maml:para>What are the remaining tasks?</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="version"> <maml:name>ProjectVersion</maml:name> <maml:description> <maml:para>What is the project version?</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Version</command:parameterValue> <dev:type> <maml:name>Version</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Comment</maml:name> <maml:description> <maml:para>Enter an optional comment. This could be git tag, or an indication about the type of project.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Tags</maml:name> <maml:description> <maml:para>What tags do you want to assign to this project? If you want to append tags you either have to re-define all tags, or add a tag manually to the psproject.json file.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSProject</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>PSProject</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>This command has an alias of spstat.</maml:para> <maml:para>Learn more about PowerShell: http://jdhitsolutions.com/blog/essential-powershell-resources/</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\Scripts\PSProjectStatus> Set-PSProjectStatus -Status Development -comment (git tag -l | Select-Object -last 1) Name: PSProjectStatus [C:\scripts\PSProjectStatus] LastUpdate Status Tasks GitBranch Age ---------- ------ ----- --------- --- 3/15/2023 10:09:05 AM Develo.. {help docs, readm… 0.2.0 00.00:00</dev:code> <dev:remarks> <maml:para>Update the project status using the current date and time. Set the Status property to Development and use the last git tag as a comment.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\Scripts\PSProjectStatus> Set-PSProjectStatus -Status Development -Tasks "github" -Concatenate | Format-List Project: PSProjectStatus [C:\scripts\PSProjectStatus] Version : 0.5.0 Status : Updating Tasks : {help docs, readme, pester tests, resolve project path for json…} GitBranch : 0.5.0 LastUpdate : 3/23/2023 10:20:26 AM</dev:code> <dev:remarks> <maml:para>Update the project and add a task.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://bit.ly/3JlDkEM</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-PSProjectStatus</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-PSProjectStatus</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-PSProjectTask</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> </helpItems> |