OpenSolution-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>Open-Solution</command:name>
      <command:verb>Open</command:verb>
      <command:noun>Solution</command:noun>
      <maml:description>
        <maml:para>Finds the first `.sln` file contained in the current directory at any level and opens it in the default editor.</maml:para>
      </maml:description>
    </command:details>
    <maml:description>
      <maml:para>Why much around with Windows Explorer, hunting and pecking for the `.sln` file you want to open? With this function, all you have to do is type three little letters `sln` from your PowerShell terminal and you're done.</maml:para>
    </maml:description>
    <command:syntax>
      <command:syntaxItem>
        <maml:name>Open-Solution</maml:name>
        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none">
          <maml:name>RootDirectory</maml:name>
          <maml:Description>
            <maml:para>The directory to recursively search for Visual Studio solution files. Defaults to the current directory.</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>$PWD</dev:defaultValue>
        </command:parameter>
      </command:syntaxItem>
    </command:syntax>
    <command:parameters>
      <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none">
        <maml:name>RootDirectory</maml:name>
        <maml:Description>
          <maml:para>The directory to recursively search for Visual Studio solution files. Defaults to the current directory.</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>$PWD</dev:defaultValue>
      </command:parameter>
    </command:parameters>
    <command:inputTypes />
    <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:\&gt; git clone https://github.com/refactorsaurusrex/whats-new.git
PS C:\&gt; cd .\whats-new; sln
 
# Boom! WhatsNew is opened in Visual Studio.</dev:code>
        <dev:remarks>
          <maml:para></maml:para>
        </dev:remarks>
      </command:example>
    </command:examples>
    <command:relatedLinks>
      <maml:navigationLink>
        <maml:linkText>Open-Solution</maml:linkText>
        <maml:uri>https://github.com/refactorsaurusrex/whats-new/wiki/Open-Solution</maml:uri>
      </maml:navigationLink>
    </command:relatedLinks>
  </command:command>
</helpItems>