{"id":1237,"date":"2014-06-07T00:01:00","date_gmt":"2014-06-07T00:01:00","guid":{"rendered":"https:\/\/blogs.technet.microsoft.com\/heyscriptingguy\/2014\/06\/07\/weekend-scripter-cool-powershell-profile-functions-from-bruce-payette\/"},"modified":"2014-06-07T00:01:00","modified_gmt":"2014-06-07T00:01:00","slug":"weekend-scripter-cool-powershell-profile-functions-from-bruce-payette","status":"publish","type":"post","link":"https:\/\/devblogs.microsoft.com\/scripting\/weekend-scripter-cool-powershell-profile-functions-from-bruce-payette\/","title":{"rendered":"Weekend Scripter: Cool PowerShell Profile Functions from Bruce Payette"},"content":{"rendered":"

Summary<\/b>: Windows PowerShell principal SDE, Bruce Payette, shares a couple of cool profile functions.<\/p>\n

Microsoft Scripting Guy, Ed Wilson, is here. The week of May 19, we had Profile Week. (To read about some great ideas that you can use for your Windows PowerShell profile, see these Hey, Scripting Guy! Blog posts<\/a>.) I saved one individual's profile for a special post. Today we will look inside Bruce Payette’s profile. For anyone who may not know, Bruce is a principal software development engineer (SDE) on the Windows PowerShell team. Now you know why this is a special post.<\/p>\n

Bruce supplied three way cool functions. The first function is a CD<\/strong> function that stores a list of directories that are typed. Then there is a DIRS<\/b> function that will list the directories that have been typed. Each directory is associated with a number. Lastly, there is a MY<\/b> function that creates directories relative to the users documents folder. I copied the functions below into my Windows PowerShell console profile. I typed ise $profile<\/b> to open my profile in the Windows PowerShell ISE. Here is my Windows PowerShell ISE:<\/p>\n

\"Image<\/a><\/p>\n

A new CD function<\/h2>\n

In a default installation of Windows PowerShell, the CD<\/b> alias is mapped to the Set-Location<\/b> cmdlet. It changes directories. So the first thing that Bruce does is remove the CD<\/b> alias, and then create a new function named CD<\/b>. The cool thing about the new CD<\/b> function is that it stores a list of directories that I visit. Each path is added once. With the new function, I can use CD<\/b>, and move backwards in the directory bag.<\/p>\n

With the DIRS<\/b> function, I get a list of the directories stored in the directory bag. I can list them by typing dirs<\/b>, or I can go to a specific folder by typing dirs 2<\/b>, or whatever directory I want to navigate to. This is shown in the following image:<\/p>\n

\"Image<\/a><\/p>\n

The MY<\/b> function maps directories in reference to my personal profile. It allows me to go directly to my personal module folder by typing my modules<\/b>, as shown here:<\/p>\n

\"Image<\/a><\/p>\n

Following is the complete script for the three way cool profile functions:<\/p>\n

# remove any existing cd alias…<\/p>\n

rm -force alias:\/cd 2> $null<\/p>\n

$global:DIRLIST = @{}<\/p>\n

# a cd function that maintains a list of directories visited. Each path is added only once (bag not stack)<\/p>\n

# it also implements the UNIX-like ‘cd –‘ to jump back to the previous directory<\/p>\n

# cd …            # go up 2 levels<\/p>\n

# cd ….           # go up three levels<\/p>\n

# cd –              # go back to the previous directory<\/p>\n

function cd<\/p>\n

{<\/p>\n

  param ($path='~', [switch] $parent, [string[]] $replace, [switch] $my, [switch] $one)<\/p>\n

 <\/p>\n

  if ($index = $path -as [int])<\/p>\n

  {<\/p>\n

    dirs $index<\/p>\n

    return<\/p>\n

  }<\/p>\n

 <\/p>\n

  if ($replace)<\/p>\n

  {<\/p>\n

    $path = $path -replace $replace<\/p>\n

  }<\/p>\n

 <\/p>\n

  if ($parent)<\/p>\n

  {<\/p>\n

    $path = Split-Path path<\/p>\n

  }<\/p>\n

 <\/p>\n

  if ($my)<\/p>\n

  {<\/p>\n

    if ($path -eq '~') { $path = '' }<\/p>\n

    $path = "~\/documents\/$path"<\/p>\n

  }<\/p>\n

  elseif ($one)<\/p>\n

  {<\/p>\n

    if ($path -eq '~') { $path = '' }<\/p>\n

    $path = "~\/skydrive\/documents\/$path"<\/p>\n

  }<\/p>\n

 <\/p>\n

  # .'ing shortcuts<\/p>\n

  switch ($path)<\/p>\n

  {<\/p>\n

    '…' { $path = '..\\..' }<\/p>\n

    '….' { $path = '..\\..\\..' }<\/p>\n

    '-' {<\/p>\n

      if (test-path variable:global:oldpath)<\/p>\n

      {<\/p>\n

        # pop back to your old path<\/p>\n

        Write-Host "cd'ing back to $global:OLDPATH"<\/p>\n

       <\/p>\n

        $temp = Get-Location<\/p>\n

        Set-Location $global:OLDPATH<\/p>\n

        $global:OLDPATH=$temp<\/p>\n

      }<\/p>\n

      else<\/p>\n

      {<\/p>\n

        Write-Warning 'OLDPATH not set'<\/p>\n

      }<\/p>\n

    }<\/p>\n

    default {<\/p>\n

      $temp = Get-Location<\/p>\n

      Set-Location $path<\/p>\n

      if ($?) {<\/p>\n

        $global:OLDPATH = $temp<\/p>\n

        $DIRLIST[(Get-Location).path] = $true<\/p>\n

      }<\/p>\n

      else<\/p>\n

      {<\/p>\n

        Write-Warning 'cd failed!'<\/p>\n

      }<\/p>\n

    }<\/p>\n

  }<\/p>\n

}<\/p>\n

 <\/p>\n

#<\/p>\n

# lists the directories accumulated by the cd function<\/p>\n

# dirs              # list the accumulated directories<\/p>\n

# dirs <number>     # cd to the directory entry corresponding to <number><\/p>\n

function dirs<\/p>\n

{<\/p>\n

  param ($id = -1)<\/p>\n

  $dl = $dirlist.keys | sort<\/p>\n

  if ($dl)<\/p>\n

  {<\/p>\n

    if ($id -ge 0)<\/p>\n

    {<\/p>\n

      cd $dl[$id]<\/p>\n

    }<\/p>\n

    else<\/p>\n

    {<\/p>\n

      $count=0;<\/p>\n

      foreach ($d in $dl)<\/p>\n

      {<\/p>\n

        '{0,3} {1}' -f $count++, $d<\/p>\n

      }<\/p>\n

    }<\/p>\n

  }<\/p>\n

}<\/p>\n

 <\/p>\n

# A function that cd's relative to ~\/documents, with special handling for 'my modules'<\/p>\n

# Works with the cd function<\/p>\n

# my           # go to ~\/documents<\/p>\n

# my modules   # cd to ~\/documents\/windowspowershell\/modules<\/p>\n

# my foobar    # cd to ~\/documents\/foobar<\/p>\n

function my ($path='', [switch] $resolve=$false)<\/p>\n

{<\/p>\n

  switch ($path)<\/p>\n

  {<\/p>\n

    modules {<\/p>\n

      $resolvedPath = (rvpa '~\/documents\/windowspowershell\/modules').Path<\/p>\n

      if ($resolve) { return $resolvePath }<\/p>\n

      cd $resolvedPath<\/p>\n

      return<\/p>\n

    }<\/p>\n

  }<\/p>\n

  $resolvedPath = $null<\/p>\n

  $resolvedPath =  (rvpa "~\/documents\/$path").Path<\/p>\n

  if (! $resolvedPath ) { return }<\/p>\n

  if ($resolve)<\/p>\n

  {<\/p>\n

    return $resolvedPath<\/p>\n

  }<\/p>\n

  else<\/p>\n

  {<\/p>\n

    if ((get-item $resolvedPath).PSIsContainer)<\/p>\n

    {<\/p>\n

      cd "~\/documents\/$path"<\/p>\n

    }<\/p>\n

    else<\/p>\n

    {<\/p>\n

      return $resolvedPath<\/p>\n

    }<\/p>\n

  }<\/p>\n

}<\/p>\n

I invite you to follow me on Twitter<\/a> and Facebook<\/a>. If you have any questions, send email to me at scripter@microsoft.com<\/a>, or post your questions on the Official Scripting Guys Forum<\/a>. See you tomorrow. Until then, peace.<\/p>\n

Ed Wilson, Microsoft Scripting Guy<\/b> <\/p>\n","protected":false},"excerpt":{"rendered":"

Summary: Windows PowerShell principal SDE, Bruce Payette, shares a couple of cool profile functions. Microsoft Scripting Guy, Ed Wilson, is here. The week of May 19, we had Profile Week. (To read about some great ideas that you can use for your Windows PowerShell profile, see these Hey, Scripting Guy! Blog posts.) I saved one […]<\/p>\n","protected":false},"author":596,"featured_media":87096,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"_acf_changed":false,"footnotes":""},"categories":[1],"tags":[144,3,4,61,45],"class_list":["post-1237","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-scripting","tag-profiles","tag-scripting-guy","tag-scripting-techniques","tag-weekend-scripter","tag-windows-powershell"],"acf":[],"blog_post_summary":"

Summary: Windows PowerShell principal SDE, Bruce Payette, shares a couple of cool profile functions. Microsoft Scripting Guy, Ed Wilson, is here. The week of May 19, we had Profile Week. (To read about some great ideas that you can use for your Windows PowerShell profile, see these Hey, Scripting Guy! Blog posts.) I saved one […]<\/p>\n","_links":{"self":[{"href":"https:\/\/devblogs.microsoft.com\/scripting\/wp-json\/wp\/v2\/posts\/1237","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/devblogs.microsoft.com\/scripting\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/devblogs.microsoft.com\/scripting\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/scripting\/wp-json\/wp\/v2\/users\/596"}],"replies":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/scripting\/wp-json\/wp\/v2\/comments?post=1237"}],"version-history":[{"count":0,"href":"https:\/\/devblogs.microsoft.com\/scripting\/wp-json\/wp\/v2\/posts\/1237\/revisions"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/scripting\/wp-json\/wp\/v2\/media\/87096"}],"wp:attachment":[{"href":"https:\/\/devblogs.microsoft.com\/scripting\/wp-json\/wp\/v2\/media?parent=1237"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/scripting\/wp-json\/wp\/v2\/categories?post=1237"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/scripting\/wp-json\/wp\/v2\/tags?post=1237"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}