en-US/about_ISEPSProject.help.txt

TOPIC
    about_ISEPSProject
 
COPYRIGHT
    Copyright (c) 2016 Christopher J. Maahs
 
    Permission is hereby granted, free of charge, to any person obtaining a copy
    of this software and associated documentation files (the "Software"),
    to deal in the Software without restriction, including without limitation
    the rights to use, copy, modify, merge, publish, distribute, sublicense,
    and/or sell copies of the Software, and to permit persons to whom the
     Software is furnished to do so, subject to the following conditions:
  
    The above copyright notice and this permission notice shall be included in
    all copies or substantial portions of the Software.
  
    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
    THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
    FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
    DEALINGS IN THE SOFTWARE.
  
SHORT DESCRIPTION
    Set of utility functions to allow one to group and quickly open a set of related Powershell files within the ISE environment.
 
LONG DESCRIPTION
    Project files with the extension of .psproj are created and maintained using the related scripts.
 
    Commands use to create and modify these .psproj files are included.
 
    Each source file added to the .psproj file is locally referenced (no full paths)
    Source files are assigned a TAB name.
 
    When the .psproj file is opened a new PowerShellTab in ISE ($psISE.PowershellTabs.Add) is created and the .Description is set to the TAB name.
    Each source file associted with a particular TAB is then opened within the associated PowerShellTab.
    A Set-Location is called on the SHELL window to set the working directory to match the source of the files.
 
    Enhancements that might be nice:
        Full path support, potentially creating a new TAB for each directory.
 
 
EXAMPLES
 
    This is a sample workflow.
 
    Source files are created (New-Something.ps1, Remove-Something.ps1, Get-Something.ps1, Maintain-Something.ps1)
 
    Create-PowershellProject -ProjectFile MyProject
        -This creates: MyProject.psproj
 
    Add-SourceToPowershellProject -ProjectFile .\MyProject.psproj -SourceFile .\New-Something.ps1 -ProjectTab "MyProject"
    Add-SourceToPowershellProject -ProjectFile .\MyProject.psproj -SourceFile .\Remove-Something.ps1 -ProjectTab "MyProject"
    Add-SourceToPowershellProject -ProjectFile .\MyProject.psproj -SourceFile .\Get-Something.ps1 -ProjectTab "MyProject"
    Add-SourceToPowershellProject -ProjectFile .\MyProject.psproj -SourceFile .\Maintain-Something.ps1 -ProjectTab "MyProjectMaintenance"
 
    Open-PowershellProject -ProjectFile .\MyProject.psproj
        -This creates a new PowerShellTab named "MyProject" and opens the Add-Something.ps1,Remove-Something.ps1 and Get-Something.ps1 file.
        -It also creates a second new PowerShellTab named "MyProjectMaintenance" and opens the Maintain-Something.ps1 file there.
 
    Remove-SourceFromPowershellProject -ProjectFile .\MyProject.psproj -SourceFile .\Remove-Somethings.ps1
        -This will remove the source file from the project.
 
    Get-PowershellProject -ProjectFile .\MyProject.psproj
        -This will list the items in the file.
 
SEE ALSO
    Currently no online resources.